REST Resource: networks.liveStreams

Resource: LiveStream

A LiveStream 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 live stream, 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 live stream.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "startTime": string,
  "endTime": string,
  "contentUrls": [
    string
  ],
  "adTags": [
    string
  ],
  "sourceContentConfigurations": [
    string
  ],
  "prerollSettings": {
    object (PrerollSettings)
  },
  "hlsSettings": {
    object (HlsSettings)
  },
  "prefetchSettings": {
    object (PrefetchSettings)
  },
  "adBreakMarkups": [
    enum (AdBreakMarkupType)
  ],
  "liveStreamConditioning": {
    object (LiveStreamConditioning)
  },
  "adPodTrimTolerance": string,
  "auxiliaryAdSettings": {
    object (AuxiliaryAdSettings)
  },
  "displayName": string,
  "status": enum (LiveStreamEventStatus),
  "endTimeUnlimited": boolean,
  "assetKey": string,
  "enableDaiAuthenticationKeys": boolean,
  "adBreakFillType": enum (AdBreakFillType),
  "underfillAdBreakFillType": enum (AdBreakFillType),
  "adHolidayDuration": string,
  "enableMaxFillerDuration": boolean,
  "maxFillerDuration": string,
  "podServingSegmentDuration": string,
  "enableDurationlessAdBreaks": boolean,
  "defaultAdBreakDuration": string,
  "adMediaDeliveryConfig": string,
  "allowlistedIpsEnabled": boolean,
  "dynamicAdInsertionType": enum (DynamicAdInsertionType),
  "relativePlaylistDeliveryEnabled": boolean,
  "streamingFormat": enum (LiveStreamEventStreamingFormat),
  "prefetchEnabled": boolean,
  "forcedCueInEnabled": boolean,
  "shortSegmentDroppingEnabled": boolean,
  "customAssetKey": string,
  "adBreakMarkupTypesEnabled": boolean,
  "earlyBreakNotificationMultiBreakSchedulingEnabled": boolean,
  "effectiveAssetKey": string
}
Fields
name

string

Identifier. The resource name of the LiveStream. Format: networks/{networkCode}/liveStreams/{live_stream_id}
createTime

string (Timestamp format)

Output only. The date and time this LiveStream was created.

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".
updateTime

string (Timestamp format)

Output only. The date and time this LiveStream 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".
startTime

string (Timestamp format)

Optional. The start date and time of this LiveStream. Modifying this attribute for an active live stream can impact traffic.

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".
endTime

string (Timestamp format)

Optional. The scheduled end date and time of this LiveStream. This attribute is required if unlimitedEndDateTime is false and ignored if unlimitedEndDateTime is true. Modifying this attribute for an active live stream can impact traffic.

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".
contentUrls[]

string

Required. The list of URLs pointing to the live stream content in Content Delivery Network. Can be modified when the live stream is in a PAUSED state.
adTags[]

string

Required. The list of Ad Manager ad tag URLs generated by the Ad Manager trafficking workflow that are associated with this live stream. Currently, the list includes only one element: the master ad tag.
sourceContentConfigurations[]

string

Optional. The list of CdnConfigurations that provide settings for ingesting and delivering the videos associated with this source. Modifying settings for an active live stream may break the stream for some users. Exercise caution. Format: "networks/{networkCode}/cdnConfigs/{cdn_config_id}"
prerollSettings

object (PrerollSettings)

Optional. The settings specific to Preroll ad breaks. If null, this livestream does not have prerolls enabled.
hlsSettings

object (HlsSettings)

Optional. The settings that are specific to HTTPS live streaming (HLS) protocol. If it is not set will use the default HLS settings.
prefetchSettings

object (PrefetchSettings)

Optional. The information needed to prefetch ad requests for an ad break.
adBreakMarkups[]

enum (AdBreakMarkupType)

Optional. The formats that will be recognized as ad break start/end markers. This field is ignored if adBreakMarkupTypesEnabled is false.
liveStreamConditioning

object (LiveStreamConditioning)

Optional. The conditioning to apply to this LiveStream.
adPodTrimTolerance

string (Duration format)

Optional. The maximum amount of time by which a stitched ad pod is allowed to be trimmed before whole ads are dropped instead.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
auxiliaryAdSettings

object (AuxiliaryAdSettings)

Optional. The auxiliary ad tag settings for this live stream.
displayName

string

Required. The name of the LiveStream. This value has a maximum length of 255 characters.
status

enum (LiveStreamEventStatus)

Output only. The status of this LiveStream. Live stream events are created in the PAUSED state.
endTimeUnlimited

boolean

Optional. Whether the LiveStream has an end time. Defaults to false. If this field is true, endDateTime is ignored.
assetKey

string

Output only. The code used in constructing a live stream master playlist URL.
enableDaiAuthenticationKeys

boolean

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

enum (AdBreakFillType)

Optional. The type of content that should be used to fill an empty ad break. Defaults to SLATE.
underfillAdBreakFillType

enum (AdBreakFillType)

Optional. The type of content that should be used to fill the time remaining in the ad break when there are not enough ads to fill the entire break. Defaults to SLATE. To set this field a network needs to have the "Live stream ad break underfill type" feature enabled.
adHolidayDuration

string (Duration format)

Optional. The duration, 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. Defaults to 0.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
enableMaxFillerDuration

boolean

Optional. Whether there will be max filler duration in this live stream. If true, maxFillerDuration should be specified. Defaults to false.
maxFillerDuration

string (Duration format)

Optional. The maximum duration that can be used to fill this ad pod, either with a slate or underlying content, depending on your settings. If more time needs to be filled, the ad pod will instead be dropped and the underlying content will be served.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
podServingSegmentDuration

string (Duration format)

Optional. The duration that can be used when stitching ads for each livestream event. This attribute is only available for Pod Serving HLS Segment Redirect and Pod Serving Dash Segment Redirect.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
enableDurationlessAdBreaks

boolean

Optional. Whether there will be durationless ad breaks in this live stream. If true, defaultAdBreakDuration should be specified. Defaults to false.
defaultAdBreakDuration

string (Duration format)

Optional. The default ad pod duration that will be requested when an ad break cue-out does not specify a duration. Defaults to 0.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
adMediaDeliveryConfig

string

Optional. The CdnConfiguration that provide settings for delivering ad media associated with this source. Format: "networks/{networkCode}/cdnConfigs/{cdn_config_id}"
allowlistedIpsEnabled

boolean

Optional. Whether specific allowlisted IP addresses should be used to access this live stream. Will default to false. To set this field a network needs to have the "Video live allowlisted IPS enabled" feature enabled. Modifying this field for an active live stream can impact traffic.
dynamicAdInsertionType

enum (DynamicAdInsertionType)

Immutable. The method of dynamic ad insertion that is used to insert ads into this live stream. Defaults to DynamicAdInsertionType.LINEAR.
relativePlaylistDeliveryEnabled

boolean

Optional. Whether the served playlists can include relative URLs. Defaults to false. To set this field a network needs to have the "Video live stream relative playlist URLs" feature enabled. This field can be modified when the live stream is in a LiveStreamEventStatus#PAUSED state.
streamingFormat

enum (LiveStreamEventStreamingFormat)

Immutable. The streaming format of the LiveStream media.
prefetchEnabled

boolean

Optional. Indicates whether the option to prefetch ad requests is enabled.
forcedCueInEnabled

boolean

Optional. Whether live stream placement opportunities without #EXT-CUE-IN markers should be force closed. Defaults to false. To set this field a network needs to have the "Video live stream forced cue in" feature enabled.
shortSegmentDroppingEnabled

boolean

Optional. Whether segments shorter than 1 second at the end of an ad pod should be dropped. Defaults to false. To set this field a network needs to have the "Video live stream short segment dropping" feature enabled.
customAssetKey

string

Immutable. An additional code that can be used in constructing live stream event URLs. Can only be set for pod serving live streams. The custom asset key may be at most 64 characters and can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.
adBreakMarkupTypesEnabled

boolean

Optional. Whether this LiveStream is specifying a subset of supported adBreakMarkups. If this field is false, all supported formats will be treated as ad break start/end markers.
earlyBreakNotificationMultiBreakSchedulingEnabled

boolean

Optional. Indicates whether multi-break scheduling via Early Break Notification (EBN) is enabled for this LiveStream.
effectiveAssetKey

string

Output only. The effective asset key of the live stream. This is the user-defined customAssetKey if specified; otherwise, it falls back to the autogenerated assetKey.

LiveStreamEventStatus

Describes the status of a LiveStreamEvent object.

Enums
LIVE_STREAM_EVENT_STATUS_UNSPECIFIED Default value. This value is unused.
ACTIVE Indicates the LiveStreamEvent has been created and is eligible for streaming.
ADS_PAUSED Indicates that the stream is still being served, but ad insertion should be paused temporarily.
ARCHIVED Indicates the LiveStreamEvent has been archived.
PAUSED Indicates the LiveStreamEvent has been paused. This can be made #ACTIVE at later time.

AdBreakFillType

Describes what should be used to fill an empty or underfilled ad break during a live stream.

Enums
AD_BREAK_FILL_TYPE_UNSPECIFIED Default value. This value is unused.
MINIMIZE_SLATE Ad break should be filled with mostly underlying content. When ad content can't be aligned with underlying content during transition, the gap will be bridged with slate to maintain the timeline.
SLATE Ad break should be filled with slate.
UNDERLYING_CONTENT Ad break should be filled with underlying content.

PrerollSettings

Settings for ad breaks on a livestream that are specific to preroll.

JSON representation 
{
  "adTag": string,
  "maxAdPodDuration": string
}
Fields
adTag

string

Required. The Ad Manager ad tag URL generated by the Ad Manager trafficking workflow that is associated with this live stream.
maxAdPodDuration

string (Duration format)

Required. The maximum duration for an ad break.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

HlsSettings

LiveStream settings that are specific to the HTTP live streaming (HLS) protocol.

JSON representation 
{
  "masterPlaylistSettings": {
    object (MasterPlaylistSettings)
  },
  "playlistType": enum (HlsSettingsPlaylistType)
}
Fields
masterPlaylistSettings

object (MasterPlaylistSettings)

Optional. The settings for the master playlist. If it is not set will default to a MasterPlaylistSettings with a refresh type of AUTOMATIC.
playlistType

enum (HlsSettingsPlaylistType)

Immutable. Indicates the type of the playlist associated with this live stream. The playlist type is analogous to the EXT-X-PLAYLIST-TYPE HLS tag. Will default to LIVE.

HlsSettingsPlaylistType

Describes the type of the playlist associated with this live stream. This is analogous to the EXT-X-PLAYLIST-TYPE HLS tag. Use HlsSettingsPlaylistType.EVENT for streams with the value "#EXT-X-PLAYLIST-TYPE:EVENT" and use HlsSettingsPlaylistType.LIVE for streams without the tag.

Enums
HLS_SETTINGS_PLAYLIST_TYPE_UNSPECIFIED Default value. This value is unused.
EVENT The playlist is an event, which means that media segments can only be added to the end of the playlist. This allows viewers to scrub back to the beginning of the playlist.
LIVE The playlist is a live stream and there are no restrictions on whether media segments can be removed from the beginning of the playlist.

MasterPlaylistSettings

Settings for the HLS (HTTP Live Streaming) master playlist.

JSON representation 
{
  "refreshType": enum (HlsMasterPlaylistRefreshType)
}
Fields
refreshType

enum (HlsMasterPlaylistRefreshType)

Optional. Indicates how the master playlist gets refreshed. Defaults to AUTOMATIC. This field can only be modified when the live stream is in a PAUSED state.

HlsMasterPlaylistRefreshType

Enumerates the different ways an HLS master playlist on a live stream will can be refreshed.

Enums
HLS_MASTER_PLAYLIST_REFRESH_TYPE_UNSPECIFIED Default value. This value is unused.
AUTOMATIC The master playlist will automatically be refreshed.
MANUAL The master playlist will only be refreshed when requested.

DynamicAdInsertionType

Describes how the live stream will have ads dynamically inserted into playlists.

Enums
DYNAMIC_AD_INSERTION_TYPE_UNSPECIFIED Default value. This value is unused.
LINEAR Content manifest is served by Google DAI. Content and ads are stitched together into a unique video manifest per user.
POD_SERVING_MANIFEST Ads manifest is served by Google DAI, containing unique ad pod segments for the video player to switch to from the content stream, or for the partner to stitch directly into the user content manifest.
POD_SERVING_REDIRECT Content manifest is served by the partner, embedding Google DAI ad segment URLs which redirect to unique Google DAI ad segments per user.

LiveStreamEventStreamingFormat

The LiveStreamEvent streaming format.

Enums
LIVE_STREAM_EVENT_STREAMING_FORMAT_UNSPECIFIED Default value. This value is unused.
DASH The format of the live stream media is MPEG-DASH.
HLS The format of the live stream media is HTTP Live Streaming.

PrefetchSettings

The information needed to prefetch ad requests for an ad break.

JSON representation 
{
  "stageOneAdRequestDuration": string
}
Fields
stageOneAdRequestDuration

string (Duration format)

Optional. The duration of the part of the break to be prefetched.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

AdBreakMarkupType

Describes the SCTE ad break markups for a LiveStreamEvent.

Enums
AD_BREAK_MARKUP_TYPE_UNSPECIFIED Default value. This value is unused.
HLS_DATERANGE_SPLICE The DATERANGE ad break marker type. This mark up type is only applicable for HLS live streams.
HLS_EXT_CUE The CUE-OUT/CUE-IN ad break marker type. This mark up type is only applicable for HLS live streams.
HLS_PRIMETIME_SPLICE The CUE (Adobe/Azure Prime Time) ad break marker type. This mark up type is only applicable for HLS live streams.
SCTE35_BINARY_BREAK_START_END The SCTE35 Binary Time Signal: Break Start/End ad break marker type. This mark up type is only applicable for HLS and DASH live streams.
SCTE35_BINARY_PROVIDER_AD_START_END The SCTE35 Binary Time Signal: Provider Ad Start/End ad break marker type. This mark up type is only applicable for HLS and DASH live streams.
SCTE35_BINARY_PROVIDER_PLACEMENT_OP_START_END The SCTE35 Binary Time Signal: Provider Placement Opportunity Start/End ad break marker type. This mark up type is only applicable for HLS and DASH live streams.
SCTE35_BINARY_SPLICE_INSERT The SCTE35 Binary Splice Insert ad break marker type. This mark up type is only applicable for HLS and DASH live streams.
SCTE35_XML_SPLICE_INSERT The SCTE35 XML Splice In/Out ad break marker type. This markup type is only applicable for DASH live streams.

LiveStreamConditioning

Settings to specify all types of conditioning to apply to the associated LiveStream.

JSON representation 
{
  "dashBridge": {
    object (DashBridge)
  }
}
Fields
dashBridge

object (DashBridge)

Optional. Specifies DASH Bridge single-period to multi-period MPD conditioning.

DashBridge

A DashBridge is used to decide when to apply DASH Bridge single-period to multi-period MPD conditioning. This should always be enabled when the DASH manifest type is single-period.

JSON representation 
{
  "enabled": boolean
}
Fields
enabled

boolean

Optional. Specifies whether to apply DASH Bridge single-period to multi-period MPD conditioning.

AuxiliaryAdSettings

Settings for auxiliary ads (e.g. pause ads) on a live stream.

JSON representation 
{
  "adTagUrl": string
}
Fields
adTagUrl

string

Required. The ad tag URL used to request auxiliary ads (such as pause ads). This can be a Google Ad Manager ad tag or a third-party ad tag. Publishers are responsible for ensuring the correctness of the URL.

Methods

batchActivate

 Batch activates LiveStream objects.

batchArchive

 Batch archives LiveStream objects.

batchCreate

 Batch creates LiveStream objects.

batchPause

 Batch pauses LiveStream objects.

batchPauseAds

 Batch pauses ads on LiveStream objects.

batchRefreshMasterPlaylists

 Batch refreshes master playlists on LiveStream objects.

batchUpdate

 Batch updates LiveStream objects.

create

 Creates a LiveStream object.

get

 Retrieves a LiveStream object.

list

 Lists LiveStream objects.

patch

 Updates a LiveStream object.