type DaiEncodingProfile (v202308)

Service
DaiEncodingProfileService
Dependencies
DaiEncodingProfilePage createDaiEncodingProfiles() updateDaiEncodingProfiles()
▼
DaiEncodingProfile

A DaiEncodingProfile contains data about a publisher's encoding profiles. Ad Manager Dynamic Ad Insertion (DAI) uses the profile information about the content to select an appropriate ad transcode to play for the particular video.

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

Field

id

xsd:long

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

name

xsd:string

The name of the DaiEncodingProfile. This value is required to create an encoding profile and may be at most 64 characters. The name field can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.

status

DaiEncodingProfileStatus

The status of this DaiEncodingProfile.

DAI encoding profiles are created in the DaiEncodingProfileStatus.ACTIVE state. The status can only be modified through the DaiEncodingProfileService.performDaiEncodingProfileAction method.

Only active profiles will be allowed to be associated with live streams.

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

variantType

VariantType

The variant playlist type that this DaiEncodingProfile represents.

Enumerations
MEDIA
Media variant playlist type. Media playlists may: contain audio only, video only, or audio and video.
IFRAME
iFrame variant playlist type. iFrame playlists may: contain video or contain audio and video (i.e. video must be present).
SUBTITLES
Subtitles variant playlist type.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

containerType

ContainerType

The digital container type of the underlying media. This is required for MEDIA and IFRAME variant types.

Enumerations
TS
Transport stream (TS) container.
FMP4
Fragmented MPEG-4 (fMP4) output container.
HLS_AUDIO
HTTP live streaming (HLS) packed audio container.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

videoSettings

VideoSettings

Information about the video media, if present. This field will only be set if the media contains video, or is an IFRAME variant type.

audioSettings

AudioSettings

Information about the audio media, if present. This field will only be set if the media contains audio. Only MEDIA and IFRAME variant types can set audio.

persistUnmatchedProfiles

xsd:boolean

Whether to allow the creation or modification of this DaiEncodingProfile if its settings do not match one of the encoding profiles that is supported by Google DAI.

Note that this field will not persist on the encoding profile itself, and will only affect the current request.