type LiveStreamEvent (v201808)

A LiveStreamEvent encapsulates all the information necessary to enable DAI (Dynamic Ad Insertion) into a live video stream.

This includes information such as the start and expected end time of the event, the URL of the actual content for Ad Manager to pull and insert ads into, as well as the metadata necessary to generate ad requests during the event.


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

Field

id

xsd:long

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

name

xsd:string

The name of the LiveStreamEvent. This value is required to create a live stream event and has a maximum length of 255 characters.

description

xsd:string

Additional notes to annotate the event with. This attribute is optional and has a maximum length of 65,535 characters.

status

LiveStreamEventStatus

The status of this LiveStreamEvent. This attribute is read-only and is assigned by Google. Live stream events are created in the LiveStreamEventStatus.PAUSED state.


Enumerations
ACTIVE
Indicates the LiveStreamEvent has been created and is eligible for streaming.
ARCHIVED
Indicates the LiveStreamEvent has been archived.
PAUSED
Indicates the LiveStreamEvent has been paused. This can be made ACTIVE at later time.
ADS_PAUSED
Indicates that the stream is still being served, but ad insertion should be paused temporarily.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

creationDateTime

DateTime

The date and time this LiveStreamEvent was created. This attribute is read-only.

lastModifiedDateTime

DateTime

The date and time this LiveStreamEvent was last modified. This attribute is read-only.

startDateTime

DateTime

The start date and time of this LiveStreamEvent. This attribute is required if the LiveStreamEvent.startDateTimeType is StartDateTimeType.USE_START_DATE_TIME and is ignored for all other values of StartDateTimeType.

startDateTimeType

StartDateTimeType

Specifies whether to start the LiveStreamEvent right away, in an hour, etc. This attribute is optional and defaults to StartDateTimeType.USE_START_DATE_TIME.


Enumerations
USE_START_DATE_TIME
Use the value in startDateTime.
IMMEDIATELY
The entity will start serving immediately. startDateTime in the request is ignored and will be set to the current time. Additionally, startDateTimeType will be set to StartDateTimeType.USE_START_DATE_TIME.
ONE_HOUR_FROM_NOW
The entity will start serving one hour from now. startDateTime in the request is ignored and will be set to one hour from the current time. Additionally, startDateTimeType will be set to StartDateTimeType.USE_START_DATE_TIME.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

endDateTime

DateTime

The scheduled end date and time of this LiveStreamEvent. This attribute is required if unlimitedEndDateTime is false and ignored if unlimitedEndDateTime is true.

unlimitedEndDateTime

xsd:boolean

Whether the LiveStreamEvent has an end time. This attribute is optional and defaults to false. If this field is true, endDateTime is ignored.

totalEstimatedConcurrentUsers

xsd:long

The total number of concurrent users expected to watch this event across all regions. This attribute is optional and default value is 0.

contentUrls

xsd:string[]

The list of URLs pointing to the live stream content in Content Delivery Network. This attribute is required.

adTags

xsd:string[]

The list of Ad Manager ad tag URLs generated by the Ad Manager trafficking workflow that are associated with this live stream event. This attribute is required.

liveStreamEventCode

xsd:string

This code is used in constructing a live stream event master playlist URL. This attribute is read-only and is assigned by Google.

dvrWindowSeconds

xsd:int

Length of the DVR window in seconds. This value is optional. If unset the default window as provided by the input encoder will be used.

enableDaiAuthenticationKeys

xsd:boolean

Whether the event's stream requests to the IMA SDK API will be authenticated using the DAI authentication keys.

adBreakFillType

AdBreakFillType

The type of content that should be used to fill an empty ad break. This value is optional and defaults to AdBreakFillType.SLATE.


Enumerations
SLATE
Ad break should be filled with slate.
UNDERLYING_CONTENT
Ad break should be filled with underlying content.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

adHolidayDuration

xsd:long

The duration (in seconds), starting from the time the user enters the DAI stream, for which mid-roll decisioning will be skipped. This field is only applicable when an ad holiday is requested in the stream create request. This value is optional and defaults to 0.

enableDurationlessAdBreaks

xsd:boolean

Whether there will be durationless ad breaks in this live stream. If true, defaultAdBreakDuration should be specified. This field is optional and defaults to false;

defaultAdBreakDuration

xsd:long

The default ad pod duration (in seconds) that will be requested when an ad break cue-out does not specify a duration. This field is optional and defaults to 0;

daiAuthenticationKeyIds

xsd:long[]

The list of DaiAuthenticationKey IDs used to authenticate requests for this live stream.

sourceContentConfigurationIds

xsd:long[]

The list of CdnConfiguration IDs that provide settings for ingesting and delivering the videos associated with this source.

hlsSettings

HlsSettings

The settings that are specific to HTTPS live streaming (HLS) protocol. This field is optional and if it is not set will use the default HLS settings.

Send feedback about...

Ad Manager API
Ad Manager API
Need help? Visit our support page.