Google Ads Ad Manager V1 Client - Class ProgrammaticBuyer (0.3.0)

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

Represents a programmatic buyer.

Generated from protobuf message google.ads.admanager.v1.ProgrammaticBuyer

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. The resource name of the ProgrammaticBuyer. Format: networks/{network_code}/programmaticBuyers/{buyer_account_id}

↳ buyer_account_id int|string

Output only. The buyer account ID of the buyer.

↳ display_name string

Output only. The display name of the buyer.

↳ parent_account_id int|string

Output only. The ID of the programmatic buyer's sponsor. If the buyer has no sponsor, this field will be -1.

↳ partner_client_id string

Output only. ID of the Display & Video 360 client buyer partner ID (if Display & Video 360) or Authorized Buyers client buyer account ID.

↳ agency bool

Output only. Whether the buyer is an advertising agency.

↳ preferred_deals_enabled bool

Output only. Whether the buyer is enabled for preferred deals.

↳ programmatic_guaranteed_enabled bool

Output only. Whether the buyer is enabled for programmatic guaranteed deals.

getName

Identifier. The resource name of the ProgrammaticBuyer.

Format: networks/{network_code}/programmaticBuyers/{buyer_account_id}

Returns
Type Description
string

setName

Identifier. The resource name of the ProgrammaticBuyer.

Format: networks/{network_code}/programmaticBuyers/{buyer_account_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getBuyerAccountId

Output only. The buyer account ID of the buyer.

Returns
Type Description
int|string

hasBuyerAccountId

clearBuyerAccountId

setBuyerAccountId

Output only. The buyer account ID of the buyer.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getDisplayName

Output only. The display name of the buyer.

Returns
Type Description
string

hasDisplayName

clearDisplayName

setDisplayName

Output only. The display name of the buyer.

Parameter
Name Description
var string
Returns
Type Description
$this

getParentAccountId

Output only. The ID of the programmatic buyer's sponsor. If the buyer has no sponsor, this field will be -1.

Returns
Type Description
int|string

hasParentAccountId

clearParentAccountId

setParentAccountId

Output only. The ID of the programmatic buyer's sponsor. If the buyer has no sponsor, this field will be -1.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getPartnerClientId

Output only. ID of the Display & Video 360 client buyer partner ID (if Display & Video 360) or Authorized Buyers client buyer account ID.

Returns
Type Description
string

hasPartnerClientId

clearPartnerClientId

setPartnerClientId

Output only. ID of the Display & Video 360 client buyer partner ID (if Display & Video 360) or Authorized Buyers client buyer account ID.

Parameter
Name Description
var string
Returns
Type Description
$this

getAgency

Output only. Whether the buyer is an advertising agency.

Returns
Type Description
bool

hasAgency

clearAgency

setAgency

Output only. Whether the buyer is an advertising agency.

Parameter
Name Description
var bool
Returns
Type Description
$this

getPreferredDealsEnabled

Output only. Whether the buyer is enabled for preferred deals.

Returns
Type Description
bool

hasPreferredDealsEnabled

clearPreferredDealsEnabled

setPreferredDealsEnabled

Output only. Whether the buyer is enabled for preferred deals.

Parameter
Name Description
var bool
Returns
Type Description
$this

getProgrammaticGuaranteedEnabled

Output only. Whether the buyer is enabled for programmatic guaranteed deals.

Returns
Type Description
bool

hasProgrammaticGuaranteedEnabled

clearProgrammaticGuaranteedEnabled

setProgrammaticGuaranteedEnabled

Output only. Whether the buyer is enabled for programmatic guaranteed deals.

Parameter
Name Description
var bool
Returns
Type Description
$this