Google Ads Ad Manager V1 Client - Class ThirdPartyAudienceSegment (0.14.1)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class ThirdPartyAudienceSegment.

An AudienceSegment owned by a data provider and licensed to the Ad Manager publisher network.

Generated from protobuf message google.ads.admanager.v1.AudienceSegment.ThirdPartyAudienceSegment

Namespace

Google \ Ads \ AdManager \ V1 \ AudienceSegment

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ approval_status int

Output only. Whether the publisher has approved or rejected the segment.

↳ cost Google\Type\Money

Output only. The CPM cost for the given segment. This is assigned by the data provider. The CPM cost comes from the active pricing if it exists, otherwise it comes from the latest pricing.

↳ license_type int

Output only. The license type of the external segment.

↳ start_time Google\Protobuf\Timestamp

Output only. Time which this segment becomes available for use. It is assigned by the data provider.

↳ end_time Google\Protobuf\Timestamp

Output only. Time which this segment ceases to be available. It is assigned by the data provider.

getApprovalStatus

Output only. Whether the publisher has approved or rejected the segment.

Returns
Type Description
int

hasApprovalStatus

clearApprovalStatus

setApprovalStatus

Output only. Whether the publisher has approved or rejected the segment.

Parameter
Name Description
var int
Returns
Type Description
$this

getCost

Output only. The CPM cost for the given segment. This is assigned by the data provider. The CPM cost comes from the active pricing if it exists, otherwise it comes from the latest pricing.

Returns
Type Description
Google\Type\Money|null

hasCost

clearCost

setCost

Output only. The CPM cost for the given segment. This is assigned by the data provider. The CPM cost comes from the active pricing if it exists, otherwise it comes from the latest pricing.

Parameter
Name Description
var Google\Type\Money
Returns
Type Description
$this

getLicenseType

Output only. The license type of the external segment.

Returns
Type Description
int

hasLicenseType

clearLicenseType

setLicenseType

Output only. The license type of the external segment.

Parameter
Name Description
var int
Returns
Type Description
$this

getStartTime

Output only. Time which this segment becomes available for use. It is assigned by the data provider.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Output only. Time which this segment becomes available for use. It is assigned by the data provider.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getEndTime

Output only. Time which this segment ceases to be available. It is assigned by the data provider.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

Output only. Time which this segment ceases to be available. It is assigned by the data provider.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this