# type LiveStreamEvent (v202505)

**Service** **LiveStreamEventService** **Dependencies** [LiveStreamEventPage](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.LiveStreamEventPage) [createLiveStreamEvents()](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService#createLiveStreamEvents) [updateLiveStreamEvents()](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService#updateLiveStreamEvents) ▼ **LiveStreamEvent**


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

*** ** * ** ***

Namespace
:
    `https://www.google.com/apis/ads/publisher/v202505`

| ## Field ||
|---|---|
| ### `id` | ` xsd:long` The unique ID of the `LiveStreamEvent`. This value is read-only and is assigned by Google. This attribute is read-only. |
| ### `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. |
| ### `status` | ` https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.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](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.LiveStreamEventStatus#PAUSED) state. This attribute is read-only. *** ** * ** *** **Enumerations** `ACTIVE` :   Indicates the [LiveStreamEvent](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.LiveStreamEvent) has been created and is eligible for streaming. `ARCHIVED` :   Indicates the [LiveStreamEvent](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.LiveStreamEvent) has been archived. `PAUSED` :   Indicates the [LiveStreamEvent](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.LiveStreamEvent) has been paused. This can be made [ACTIVE](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.LiveStreamEvent#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. <br /> |
| ### `creationDateTime` | ` https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.DateTime ` The date and time this `LiveStreamEvent` was created. This attribute is read-only. This attribute is read-only. |
| ### `lastModifiedDateTime` | ` https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.DateTime ` The date and time this `LiveStreamEvent` was last modified. This attribute is read-only. This attribute is read-only. |
| ### `startDateTime` | ` https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.DateTime ` The start date and time of this `LiveStreamEvent`. This attribute is required if the [LiveStreamEvent.startDateTimeType](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.LiveStreamEvent#startDateTimeType) is [StartDateTimeType.USE_START_DATE_TIME](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.StartDateTimeType#USE_START_DATE_TIME) and is ignored for all other values of [StartDateTimeType](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.StartDateTimeType). Modifying this attribute for an active live stream can impact traffic. |
| ### `startDateTimeType` | ` https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.StartDateTimeType ` Specifies whether to start the [LiveStreamEvent](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.LiveStreamEvent) right away, in an hour, etc. This attribute is optional and defaults to [StartDateTimeType.USE_START_DATE_TIME](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.StartDateTimeType#USE_START_DATE_TIME). *** ** * ** *** **Enumerations** `USE_START_DATE_TIME` :   Use the value in [startDateTime](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.LiveStreamEvent#startDateTime). `IMMEDIATELY` :   The entity will start serving immediately. [startDateTime](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.LiveStreamEvent#startDateTime) in the request is ignored and will be set to the current time. Additionally, [startDateTimeType](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.LiveStreamEvent#startDateTimeType) will be set to [StartDateTimeType.USE_START_DATE_TIME](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.StartDateTimeType#USE_START_DATE_TIME). `ONE_HOUR_FROM_NOW` :   The entity will start serving one hour from now. [startDateTime](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.LiveStreamEvent#startDateTime) in the request is ignored and will be set to one hour from the current time. Additionally, [startDateTimeType](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.LiveStreamEvent#startDateTimeType) will be set to [StartDateTimeType.USE_START_DATE_TIME](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.StartDateTimeType#USE_START_DATE_TIME). `UNKNOWN` :   The value returned if the actual value is not exposed by the requested API version. <br /> |
| ### `endDateTime` | ` https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.DateTime ` The scheduled end date and time of this `LiveStreamEvent`. 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. |
| ### `unlimitedEndDateTime` | ` xsd:boolean` Whether the [LiveStreamEvent](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.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 live stream 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 and can be modified when the live stream is in a [LiveStreamEventStatus.PAUSED](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.LiveStreamEventStatus#PAUSED) state. |
| ### `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. Currently, the list includes only one element: the master ad tag. This attribute is required. |
| ### `assetKey` | ` 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. `liveStreamEventCode` was renamed `assetKey` in v201911. This attribute is read-only. |
| ### `slateCreativeId` | ` xsd:long` ID corresponding to the slate for this live event. If not set, network default value will be 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. Modifying this value for an active live stream can impact traffic. |
| ### `enableDaiAuthenticationKeys` | ` xsd:boolean` Whether the live stream's requests to the IMA SDK API will be authenticated using the DAI authentication keys. |
| ### `adBreakFillType` | ` https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.AdBreakFillType ` The type of content that should be used to fill an empty ad break. This value is optional and defaults to [AdBreakFillType.SLATE](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.AdBreakFillType#SLATE). *** ** * ** *** **Enumerations** `SLATE` :   Ad break should be filled with slate. `UNDERLYING_CONTENT` :   Ad break should be filled with underlying content. `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. `UNKNOWN` :   The value returned if the actual value is not exposed by the requested API version. <br /> |
| ### `underfillAdBreakFillType` | ` https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.AdBreakFillType ` 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. This value is optional and defaults to [AdBreakFillType.SLATE](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.AdBreakFillType#SLATE). To set this field a network needs to have the "Live stream ad break underfill type" feature enabled. *** ** * ** *** **Enumerations** `SLATE` :   Ad break should be filled with slate. `UNDERLYING_CONTENT` :   Ad break should be filled with underlying content. `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. `UNKNOWN` :   The value returned if the actual value is not exposed by the requested API version. <br /> |
| ### `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. |
| ### `enableMaxFillerDuration` | ` xsd:boolean` Whether there will be max filler duration in this live stream. If true, `maxFillerDuration` should be specified. This field is optional and defaults to false. |
| ### `maxFillerDuration` | ` xsd:long` The maximum number of seconds 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. |
| ### `podServingSegmentDuration` | ` xsd:long` The duration (in seconds) 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. |
| ### `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; |
| ### `streamCreateDaiAuthenticationKeyIds` | ` xsd:long[]` The list of [DaiAuthenticationKey](https://developers.google.com/ad-manager/api/reference/v202505/DaiAuthenticationKeyService.DaiAuthenticationKey) IDs used to authenticate stream create requests for this live stream. Modifying keys for an active live stream may break the stream for some users. Exercise caution. |
| ### `sourceContentConfigurationIds` | ` xsd:long[]` The list of [CdnConfiguration](https://developers.google.com/ad-manager/api/reference/v202505/CdnConfigurationService.CdnConfiguration) IDs 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. |
| ### `prerollSettings` | ` https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.PrerollSettings ` The settings specific to Preroll ad breaks. This field is optional. If null, this livestream does not have prerolls enabled. |
| ### `hlsSettings` | ` https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.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. |
| ### `enableAllowlistedIps` | ` xsd:boolean` Whether specific allowlisted IP addresses should be used to access this live stream. This field is optional and 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` | ` https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.DynamicAdInsertionType ` The method of dynamic ad insertion that is used to insert ads into this live stream. This attribute is optional and defaults to `DynamicAdInsertionType.LINEAR`. This field cannot be modified after live stream creation. *** ** * ** *** **Enumerations** `LINEAR` :   Content manifest is served by Google DAI. Content and ads are stitched together into a unique video manifest per user. `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. `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. `UNKNOWN` :   The value returned if the actual value is not exposed by the requested API version. <br /> |
| ### `enableRelativePlaylistDelivery` | ` xsd:boolean` Whether the served playlists can include relative URLs. This field is optional and 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](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.LiveStreamEventStatus#PAUSED) state. |
| ### `streamingFormat` | ` https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.StreamingFormat ` The streaming format of the [LiveStreamEvent](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.LiveStreamEvent) media. This field cannot be modified after live stream creation. *** ** * ** *** **Enumerations** `HLS` :   The format of the live stream media is HTTP Live Streaming. `DASH` :   The format of the live stream media is MPEG-DASH. `UNKNOWN` :   The value returned if the actual value is not exposed by the requested API version. <br /> |
| ### `prefetchEnabled` | ` xsd:boolean` Indicates whether the option to prefetch ad requests is enabled. |
| ### `prefetchSettings` | ` https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.PrefetchSettings ` The information needed to prefetch ad requests for an ad break. |
| ### `enableForceCloseAdBreaks` | ` xsd:boolean` Whether live stream placement opportunities without #EXT-CUE-IN markers should be force closed. This field is optional and defaults to false. To set this field a network needs to have the "Video live stream forced cue in" feature enabled. |
| ### `enableShortSegmentDropping` | ` xsd:boolean` Whether segments shorter than 1 second at the end of an ad pod should be dropped. This field is optional and defaults to false. To set this field a network needs to have the "Video live stream short segment dropping" feature enabled. |
| ### `customAssetKey` | ` xsd:string` An additional code that can be used in constructing live stream event URLs. This field is immutable after creation and 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. |
| ### `daiEncodingProfileIds` | ` xsd:long[]` The list of `DaiEncodingProfile` IDs that will be used for this live stream event. This field only applies to pod serving events. New profile IDs can be added to running live streams. Profile IDs cannot be removed from running live streams. Modifying settings for an active live stream may break the stream for some users. Exercise caution. |
| ### `segmentUrlAuthenticationKeyIds` | ` xsd:long[]` The list of [DaiAuthenticationKey](https://developers.google.com/ad-manager/api/reference/v202505/DaiAuthenticationKeyService.DaiAuthenticationKey) IDs used to authenticate ad segment url requests for this live stream. This field only applies to pod serving events. Modifying settings for an active live stream may break the stream for some users. Exercise caution. |
| ### `adBreakMarkups` | ` https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.AdBreakMarkupType[]` The formats that will be recognized as ad break start/end markers. This field is ignored if `adBreakMarkupTypesEnabled` is false *** ** * ** *** **Enumerations** `AD_BREAK_MARKUP_HLS_EXT_CUE` :   The CUE-OUT/CUE-IN ad break marker type. This mark up type is only applicable for HLS live streams. `AD_BREAK_MARKUP_HLS_PRIMETIME_SPLICE` :   The CUE (Adobe/Azure Prime Time) ad break marker type. This mark up type is only applicable for HLS live streams. `AD_BREAK_MARKUP_HLS_DATERANGE_SPLICE` :   The DATERANGE (Anvato) ad break marker type. This mark up type is only applicable for HLS live streams. `AD_BREAK_MARKUP_SCTE35_XML_SPLICE_INSERT` :   The SCTE35 XML Splice In/Out ad break marker type. This markup type is only applicable for DASH live streams. `AD_BREAK_MARKUP_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. `AD_BREAK_MARKUP_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. `AD_BREAK_MARKUP_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. `AD_BREAK_MARKUP_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. `UNKNOWN` :   The value returned if the actual value is not exposed by the requested API version. <br /> |
| ### `adBreakMarkupTypesEnabled` | ` xsd:boolean` Whether this [LiveStreamEvent](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.LiveStreamEvent) is specifying a subset of supported `adBreakMarkups`. If this field is false, all supported formats will be treated as ad break start/end markers. |
| ### `adServingFormat` | ` https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.AdServingFormat ` Whether ads on this [LiveStreamEvent](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.LiveStreamEvent) are served by Google Ad Manager DAI or Google Ad Serving. *** ** * ** *** **Enumerations** `AD_MANAGER_DAI` :   The ads are served through Google Ad Manager DAI. `DIRECT` :   The ads are served through Google Ad Manager Ad Serving. `UNKNOWN` :   The value returned if the actual value is not exposed by the requested API version. <br /> |
| ### `liveStreamConditioning` | ` https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.LiveStreamConditioning ` The conditioning to apply to this [LiveStreamEvent](https://developers.google.com/ad-manager/api/reference/v202505/LiveStreamEventService.LiveStreamEvent). |