Reminder: v201708 will be sunset on August 31, 2018.

type LiveStreamEvent (v201702)

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 DFP 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/v201702

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.

endDateTime

DateTime

The scheduled end date and time of this LiveStreamEvent. This attribute is required.

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 DFP ad tag URLs generated by DFP 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.

authenticationService

AuthenticationService

This field is deprecated and should not be set or read. Please update the API version to v201711 or later and use the LiveStreamEvent.sourceContentConfigurations field to specify security policies for LiveStreamEvent.contentUrls. The value for this field will be out-of-date once LiveStreamEvent.sourceContentConfigurations is used.


Enumerations
NONE
There is no authentication for the live stream event.
AKAMAI
Akamai is used for authentication.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

authenticationKey

xsd:string

This field is deprecated and should not be set or read. Please update the API version to v201711 or later and use the LiveStreamEvent.sourceContentConfigurations field to specify security policies for LiveStreamEvent.contentUrls. The value for this field will be out-of-date once LiveStreamEvent.sourceContentConfigurations is used.

tokenAuthenticationUnsigned

xsd:boolean

This field is deprecated and should not be set or read. Please update the API version to v201711 or later and use the LiveStreamEvent.sourceContentConfigurations field to specify security policies for LiveStreamEvent.contentUrls. The value for this field will be out-of-date once LiveStreamEvent.sourceContentConfigurations is used.

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.

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.

Send feedback about...

DoubleClick for Publishers API
DoubleClick for Publishers API
Need help? Visit our support page.