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

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

The PrivateAuctionDeal resource.

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

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 `PrivateAuctionDeal`. Format: `networks/{network_code}/privateAuctionDeals/{private_auction_deal_id}`
`↳ private_auction_deal_id`	`int\|string` Output only. Deprecated: `PrivateAuctionDeal` ID.
`↳ private_auction_id`	`int\|string` Immutable. The ID of the PrivateAuction.
`↳ private_auction_display_name`	`string` Output only. The display name of the PrivateAuction.
`↳ buyer_account_id`	`int\|string` Immutable. The account ID of the buyer of the `PrivateAuctionDeal`.
`↳ external_deal_id`	`int\|string` Output only. The external ID of the `PrivateAuctionDeal`.
`↳ targeting`	`Targeting` Optional. The targeting of the `PrivateAuctionDeal`.
`↳ start_time`	`Google\Protobuf\Timestamp` Optional. Non-empty default. The start time of the `PrivateAuctionDeal`. If unset, the `startTime` will default as follows: On create: To the deal's `create_time`. On update: To the deal's existing `start_time`, which can be null.
`↳ end_time`	`Google\Protobuf\Timestamp` Optional. The end time of the `PrivateAuctionDeal`.
`↳ floor_price`	`Google\Type\Money` Required. The floor price of the `PrivateAuctionDeal`.
`↳ creative_sizes`	`array<Size>` Optional. The expected creative sizes of the `PrivateAuctionDeal`.
`↳ status`	`int` Output only. The status of the `PrivateAuctionDeal`.
`↳ auction_priority_enabled`	`bool` Optional. Whether the deal is enabled with priority over open auction.
`↳ block_override_enabled`	`bool` Optional. Whether the deal has block override enabled.
`↳ publisher_floor_exempt`	`bool` Optional. Whether the deal is exempt from publisher floor price.
`↳ buyer_permission_type`	`int` Optional. The buyer permission model defining how the deal would transact among all buyers under the same bidder.
`↳ buyer_data`	`PrivateAuctionDeal\BuyerData` Optional. The buyer data required by the Marketplace API.
`↳ deal_priority`	`NonGuaranteedDealPriority` Optional. The priority of the deal across all non-guaranteed deals.
`↳ archived`	`bool` Output only. Whether the deal is archived.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. The instant at which the `PrivateAuctionDeal` was created.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. The instant at which the `PrivateAuctionDeal` was last updated.

getName

Identifier. The resource name of the PrivateAuctionDeal.

Format: networks/{network_code}/privateAuctionDeals/{private_auction_deal_id}

Returns
Type	Description
`string`

setName

Identifier. The resource name of the PrivateAuctionDeal.

Format: networks/{network_code}/privateAuctionDeals/{private_auction_deal_id}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPrivateAuctionDealId

Output only. Deprecated: PrivateAuctionDeal ID.

Returns
Type	Description
`int\|string`

hasPrivateAuctionDealId

clearPrivateAuctionDealId

setPrivateAuctionDealId

Output only. Deprecated: PrivateAuctionDeal ID.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getPrivateAuctionId

Immutable. The ID of the PrivateAuction.

Returns
Type	Description
`int\|string`

hasPrivateAuctionId

clearPrivateAuctionId

setPrivateAuctionId

Immutable. The ID of the PrivateAuction.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getPrivateAuctionDisplayName

Output only. The display name of the PrivateAuction.

Returns
Type	Description
`string`

hasPrivateAuctionDisplayName

clearPrivateAuctionDisplayName

setPrivateAuctionDisplayName

Output only. The display name of the PrivateAuction.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getBuyerAccountId

Immutable. The account ID of the buyer of the PrivateAuctionDeal.

Returns
Type	Description
`int\|string`

hasBuyerAccountId

clearBuyerAccountId

setBuyerAccountId

Immutable. The account ID of the buyer of the PrivateAuctionDeal.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getExternalDealId

Output only. The external ID of the PrivateAuctionDeal.

Returns
Type	Description
`int\|string`

hasExternalDealId

clearExternalDealId

setExternalDealId

Output only. The external ID of the PrivateAuctionDeal.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getTargeting

Optional. The targeting of the PrivateAuctionDeal.

Returns
Type	Description
`Targeting\|null`

hasTargeting

clearTargeting

setTargeting

Optional. The targeting of the PrivateAuctionDeal.

Parameter
Name	Description
`var`	`Targeting`

Returns
Type	Description
`$this`

getStartTime

Optional. Non-empty default. The start time of the PrivateAuctionDeal.

If unset, the startTime will default as follows: On create: To the deal's create_time. On update: To the deal's existing start_time, which can be null.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasStartTime

clearStartTime

setStartTime

Optional. Non-empty default. The start time of the PrivateAuctionDeal.

If unset, the startTime will default as follows: On create: To the deal's create_time. On update: To the deal's existing start_time, which can be null.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getEndTime

Optional. The end time of the PrivateAuctionDeal.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasEndTime

clearEndTime

setEndTime

Optional. The end time of the PrivateAuctionDeal.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getFloorPrice

Required. The floor price of the PrivateAuctionDeal.

Returns
Type	Description
`Google\Type\Money\|null`

hasFloorPrice

clearFloorPrice

setFloorPrice

Required. The floor price of the PrivateAuctionDeal.

Parameter
Name	Description
`var`	`Google\Type\Money`

Returns
Type	Description
`$this`

getCreativeSizes

Optional. The expected creative sizes of the PrivateAuctionDeal.

Returns
Type	Description
`Google\Protobuf\RepeatedField<Size>`

setCreativeSizes

Optional. The expected creative sizes of the PrivateAuctionDeal.

Parameter
Name	Description
`var`	`array<Size>`

Returns
Type	Description
`$this`

getStatus

Output only. The status of the PrivateAuctionDeal.

Returns
Type	Description
`int`

hasStatus

clearStatus

setStatus

Output only. The status of the PrivateAuctionDeal.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getAuctionPriorityEnabled

Optional. Whether the deal is enabled with priority over open auction.

Returns
Type	Description
`bool`

hasAuctionPriorityEnabled

clearAuctionPriorityEnabled

setAuctionPriorityEnabled

Optional. Whether the deal is enabled with priority over open auction.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getBlockOverrideEnabled

Optional. Whether the deal has block override enabled.

Returns
Type	Description
`bool`

hasBlockOverrideEnabled

clearBlockOverrideEnabled

setBlockOverrideEnabled