Google Ads Ad Manager V1 Client - Class PrivateAuction (0.4.1)

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

The PrivateAuction resource.

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

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 `PrivateAuction`. Format: `networks/{network_code}/privateAuctions/{private_auction_id}`
`↳ private_auction_id`	`int\|string` Output only. `PrivateAuction` ID.
`↳ display_name`	`string` Required. Display name of the `PrivateAuction`. This attribute has a maximum length of 255 bytes.
`↳ description`	`string` Optional. Description of the `PrivateAuction`. This attribute has a maximum length of 4096 bytes.
`↳ seller_contact_users`	`array` Optional. The resource names of the seller contact users associated with this `PrivateAuction`. Format: `networks/{network_code}/users/{user_id}`
`↳ archived`	`bool` Output only. Whether the `PrivateAuction` is archived.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. The instant at which the PrivateAuction was created.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. The instant at which the PrivateAuction was last updated.

getName

Identifier. The resource name of the PrivateAuction.

Format: networks/{network_code}/privateAuctions/{private_auction_id}

Returns
Type	Description
`string`

setName

Identifier. The resource name of the PrivateAuction.

Format: networks/{network_code}/privateAuctions/{private_auction_id}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPrivateAuctionId

Output only. PrivateAuction ID.

Returns
Type	Description
`int\|string`

hasPrivateAuctionId

clearPrivateAuctionId

setPrivateAuctionId

Output only. PrivateAuction ID.

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

Returns
Type	Description
`$this`

getDisplayName

Required. Display name of the PrivateAuction. This attribute has a maximum length of 255 bytes.

Returns
Type	Description
`string`

hasDisplayName

clearDisplayName

setDisplayName

Required. Display name of the PrivateAuction. This attribute has a maximum length of 255 bytes.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

Optional. Description of the PrivateAuction. This attribute has a maximum length of 4096 bytes.

Returns
Type	Description
`string`

hasDescription

clearDescription

setDescription

Optional. Description of the PrivateAuction. This attribute has a maximum length of 4096 bytes.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSellerContactUsers

Optional. The resource names of the seller contact users associated with this PrivateAuction. Format: networks/{network_code}/users/{user_id}

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setSellerContactUsers

Optional. The resource names of the seller contact users associated with this PrivateAuction. Format: networks/{network_code}/users/{user_id}

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getArchived

Output only. Whether the PrivateAuction is archived.

Returns
Type	Description
`bool`

hasArchived

clearArchived

setArchived

Output only. Whether the PrivateAuction is archived.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getCreateTime

Output only. The instant at which the PrivateAuction was created.

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

hasCreateTime

clearCreateTime

setCreateTime

Output only. The instant at which the PrivateAuction was created.

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

Returns
Type	Description
`$this`

getUpdateTime

Output only. The instant at which the PrivateAuction was last updated.

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

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The instant at which the PrivateAuction was last updated.

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

Returns
Type	Description
`$this`