type Slate (v202411)

  • A Slate represents a video creative used by Dynamic Ad Insertion to fill vacant ad slots.

  • Slates have a unique read-only ID assigned by Google and a required name with a maximum length of 255 characters.

  • Slates have a status (ACTIVE, ARCHIVED, UNKNOWN) and a transcode status (UNKNOWN, NOT_READY, COMPLETED, FAILED, NEEDS_TRANSCODE, IN_PROGRESS).

  • The videoSourceUrl indicates the location of the original asset for externally hosted slates, and lastModifiedDateTime shows the last modification time.
Service
LiveStreamEventService
Dependencies
SlatePage createSlates() updateSlates()
▼
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.

Namespace
https://www.google.com/apis/ads/publisher/v202411

Field

id

xsd:long

The unique ID of the Slate. This value is read-only and is assigned by Google.

name

xsd:string

The name of the Slate. This value is required to create a slate and has a maximum length of 255 characters.

status

SlateStatus

The status of this Slate. This attribute is read-only and is assigned by Google. Slates are created in the SlateStatus.ACTIVE state.

Enumerations
ACTIVE
Indicates the Slate has been created and is eligible for streaming.
ARCHIVED
Indicates the Slate has been archived.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

transcodeStatus

TranscodeStatus

Server side transcoding status of the current slate.

Enumerations
UNKNOWN
NOT_READY
COMPLETED
FAILED
NEEDS_TRANSCODE
IN_PROGRESS

videoSourceUrl

xsd:string

The location of the original asset if publisher provided and slate is externally hosted.

lastModifiedDateTime

DateTime

The date and time this slate was last modified.