REST Resource: networks.slates

Resource: 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.

JSON representation 
{
  "name": string,
  "updateTime": string,
  "displayName": string,
  "status": enum (SlateStatus),
  "transcodeStatus": enum (VideoTranscodeStatus),
  "videoSourceUrl": string
}
Fields
name

string

Identifier. The resource name of the Slate. Format: networks/{networkCode}/slates/{slate_id}
updateTime

string (Timestamp format)

Output only. The date and time this slate was last modified.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
displayName

string

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

enum (SlateStatus)

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

enum (VideoTranscodeStatus)

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

string

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

SlateStatus

Describes the status of a Slate object.

Enums
SLATE_STATUS_UNSPECIFIED Default value. This value is unused.
ACTIVE Indicates the Slate has been created and is eligible for streaming.
ARCHIVED Indicates the Slate has been archived.

VideoTranscodeStatus

Possible server side transcoding states.

Enums
VIDEO_TRANSCODE_STATUS_UNSPECIFIED Default value. This value is unused.
COMPLETED The video transcoding is complete.
FAILED The video transcoding failed.
IN_PROGRESS The video transcode is in progress.
NEEDS_TRANSCODE The video needs to be transcoded.
NOT_READY The video is not ready.

Methods

batchArchive

 Batch archives Slate objects.

batchCreate

 Batch creates Slate objects.

batchUnarchive

 Batch unarchives Slate objects.

batchUpdate

 Batch updates Slate objects.

create

 Creates a Slate object.

get

 Retrieves a Slate object.

list

 Lists Slate objects.

patch

 Updates a Slate object.