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

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

A Slate encapsulates all the information necessary to represent a Slate entity, the video creative used by Dynamic Ad Insertion to fill vacant ad slots.

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

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 `Slate`. Format: `networks/{network_code}/slates/{slate_id}`
`↳ display_name`	`string` Required. The display name of the Slate. It has a maximum length of 255 characters.
`↳ status`	`int` Output only. The status of this Slate. Slates are created in the SlateStatus.ACTIVE state.
`↳ transcode_status`	`int` Output only. Server side transcoding status of the current slate.
`↳ video_source_url`	`string` Optional. The location of the original asset if publisher provided and slate is externally hosted.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. The date and time this slate was last modified.

getName

Identifier. The resource name of the Slate.

Format: networks/{network_code}/slates/{slate_id}

Returns
Type	Description
`string`

setName

Identifier. The resource name of the Slate.

Format: networks/{network_code}/slates/{slate_id}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

Required. The display name of the Slate. It has a maximum length of 255 characters.

Returns
Type	Description
`string`

hasDisplayName

clearDisplayName

setDisplayName

Required. The display name of the Slate. It has a maximum length of 255 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStatus

Output only. The status of this Slate. Slates are created in the SlateStatus.ACTIVE state.

Returns
Type	Description
`int`

hasStatus

clearStatus

setStatus

Output only. The status of this Slate. Slates are created in the SlateStatus.ACTIVE state.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getTranscodeStatus

Output only. Server side transcoding status of the current slate.

Returns
Type	Description
`int`

hasTranscodeStatus

clearTranscodeStatus

setTranscodeStatus