Web Service: LiveStreamEventService
Port LiveStreamEventServiceInterfacePort Port typeSource code
- createLiveStreamEventsDetailSource code
- createSlatesDetailSource code
- getLiveStreamEventsByStatementDetailSource code
- getSlatesByStatementDetailSource code
- performLiveStreamEventActionDetailSource code
- performSlateActionDetailSource code
- updateLiveStreamEventsDetailSource code
- updateSlatesDetailSource code
Operations
- createLiveStreamEventsDescription:Creates new {@link LiveStreamEvent} objects.
The following fields are required:
- {@link LiveStreamEvent#name}
- {@link LiveStreamEvent#startDateTime}
- {@link LiveStreamEvent#endDateTime}
- {@link LiveStreamEvent#contentUrls}
- {@link LiveStreamEvent#adTags}
Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:createLiveStreamEventsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type createLiveStreamEventsCreates new {@link LiveStreamEvent} objects.The following fields are required:
- {@link LiveStreamEvent#name}
- {@link LiveStreamEvent#startDateTime}
- {@link LiveStreamEvent#endDateTime}
- {@link LiveStreamEvent#contentUrls}
- {@link LiveStreamEvent#adTags}
- liveStreamEvents - optional, unbounded; type LiveStreamEventA {@code 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.
- id - optional; type longThe unique ID of the {@code LiveStreamEvent}. This value is read-only and is assigned by Google. This attribute is read-only.
- name - optional; type stringThe name of the {@code LiveStreamEvent}. This value is required to create a live stream event and has a maximum length of 255 characters.
- status - optional; type LiveStreamEventStatus - type string with restriction - enum { 'ACTIVE', 'ARCHIVED', 'PAUSED', 'ADS_PAUSED', 'UNKNOWN' }The status of this {@code LiveStreamEvent}. This attribute is read-only and is assigned by Google. Live stream events are created in the {@link LiveStreamEventStatus#PAUSED} state. This attribute is read-only.
- creationDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time this {@code LiveStreamEvent} was created. This attribute is read-only. This attribute is read-only. - date - optional; type Date
- lastModifiedDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time this {@code LiveStreamEvent} was last modified. This attribute is read-only. This attribute is read-only. - date - optional; type Date
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date and time of this {@code LiveStreamEvent}. This attribute is required if the {@link LiveStreamEvent#startDateTimeType} is {@link StartDateTimeType#USE_START_DATE_TIME} and is ignored for all other values of {@link StartDateTimeType}. Modifying this attribute for an active live stream can impact traffic. - date - optional; type Date
- startDateTimeType - optional; type StartDateTimeType - type string with restriction - enum { 'USE_START_DATE_TIME', 'IMMEDIATELY', 'ONE_HOUR_FROM_NOW', 'UNKNOWN' }Specifies whether to start the {@link LiveStreamEvent} right away, in an hour, etc. This attribute is optional and defaults to {@link StartDateTimeType#USE_START_DATE_TIME}.
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The scheduled end date and time of this {@code LiveStreamEvent}. This attribute is required if {@code unlimitedEndDateTime} is false and ignored if {@code unlimitedEndDateTime} is true. Modifying this attribute for an active live stream can impact traffic. - date - optional; type Date
- unlimitedEndDateTime - optional; type booleanWhether the {@link LiveStreamEvent} has an end time. This attribute is optional and defaults to false. If this field is true, {@code endDateTime} is ignored.
- totalEstimatedConcurrentUsers - optional; type longThe total number of concurrent users expected to watch this live stream across all regions. This attribute is optional and default value is 0.
- contentUrls - optional, unbounded; type stringThe 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 {@link LiveStreamEventStatus#PAUSED} state.
- adTags - optional, unbounded; type stringThe 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 - optional; type stringThis code is used in constructing a live stream event master playlist URL. This attribute is read-only and is assigned by Google. {@code liveStreamEventCode} was renamed {@code assetKey} in v201911. This attribute is read-only.
- slateCreativeId - optional; type longID corresponding to the slate for this live event. If not set, network default value will be used.
- dvrWindowSeconds - optional; type intLength 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 - optional; type booleanWhether the live stream's requests to the IMA SDK API will be authenticated using the DAI authentication keys.
- adBreakFillType - optional; type AdBreakFillType - type string with restriction - enum { 'SLATE', 'UNDERLYING_CONTENT', 'MINIMIZE_SLATE', 'UNKNOWN' }The type of content that should be used to fill an empty ad break. This value is optional and defaults to {@link AdBreakFillType#SLATE}.
- underfillAdBreakFillType - optional; type AdBreakFillType - type string with restriction - enum { 'SLATE', 'UNDERLYING_CONTENT', 'MINIMIZE_SLATE', 'UNKNOWN' }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 {@link AdBreakFillType#SLATE}. To set this field a network needs to have the "Live stream ad break underfill type" feature enabled.
- adHolidayDuration - optional; type longThe 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 - optional; type booleanWhether there will be max filler duration in this live stream. If true, {@code maxFillerDuration} should be specified. This field is optional and defaults to false.
- maxFillerDuration - optional; type longThe 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 - optional; type longThe 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 - optional; type booleanWhether there will be durationless ad breaks in this live stream. If true, {@code defaultAdBreakDuration} should be specified. This field is optional and defaults to false;
- defaultAdBreakDuration - optional; type longThe 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 - optional, unbounded; type longThe list of {@link 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 - optional, unbounded; type longThe list of {@link 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 - optional; type PrerollSettingsThe settings specific to Preroll ad breaks. This field is optional. If null, this livestream does not have prerolls enabled.Settings for ad breaks on {@link LiveStreamEvent} that are specific to preroll.
- adTag - optional; type stringThe Ad Manager ad tag URL generated by the Ad Manager trafficking workflow that is associated with this live stream event. This attribute is required. This attribute is required.
- maxAdPodDurationSeconds - optional; type longThe maximum duration (in seconds) for an ad break. This attribute is required.
- adTag - optional; type string
- hlsSettings - optional; type HlsSettings{@link LiveStream} settings that are specific to the HTTP live streaming (HLS) protocol.
- playlistType - optional; type PlaylistType - type string with restriction - enum { 'EVENT', 'LIVE', 'UNKNOWN' }Indicates the type of the playlist associated with this live stream. The playlist type is analogous to the EXT-X-PLAYLIST-TYPE HLS tag. This field is optional and will default to {@link PlaylistType#LIVE}. This field cannot be modified after live stream creation.
- masterPlaylistSettings - optional; type MasterPlaylistSettingsThe settings for the master playlist. This field is optional and if it is not set will default to a {@link MasterPlaylistSettings} with a refresh type of {@link RefreshType#AUTOMATIC}.Settings for the HLS (HTTP Live Streaming) master playlist.
- refreshType - optional; type RefreshType - type string with restriction - enum { 'AUTOMATIC', 'MANUAL', 'UNKNOWN' }Indicates how the master playlist gets refreshed. This field is optional and defaults to {@link RefreshType#AUTOMATIC}. This field can only be modified when the live stream is in a {@link LiveStreamEventStatus#PAUSED} state.
- refreshType - optional; type RefreshType - type string with restriction - enum { 'AUTOMATIC', 'MANUAL', 'UNKNOWN' }
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. - playlistType - optional; type PlaylistType - type string with restriction - enum { 'EVENT', 'LIVE', 'UNKNOWN' }
- enableAllowlistedIps - optional; type booleanWhether 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 - optional; type DynamicAdInsertionType - type string with restriction - enum { 'LINEAR', 'POD_SERVING_REDIRECT', 'POD_SERVING_MANIFEST', 'UNKNOWN' }The method of dynamic ad insertion that is used to insert ads into this live stream. This attribute is optional and defaults to {@link DynamicAdInsertionType.LINEAR}. This field cannot be modified after live stream creation.
- enableRelativePlaylistDelivery - optional; type booleanWhether 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 {@link LiveStreamEventStatus#PAUSED} state.
- streamingFormat - optional; type StreamingFormat - type string with restriction - enum { 'HLS', 'DASH', 'UNKNOWN' }The streaming format of the {@link LiveStreamEvent} media. This field cannot be modified after live stream creation.
- prefetchEnabled - optional; type booleanIndicates whether the option to prefetch ad requests is enabled.
- prefetchSettings - optional; type PrefetchSettingsThe information needed to prefetch ad requests for an ad break.The information needed to prefetch ad requests for an ad break.
- initialAdRequestDurationSeconds - optional; type intThe duration of the part of the break to be prefetched.
- initialAdRequestDurationSeconds - optional; type int
- enableForceCloseAdBreaks - optional; type booleanWhether 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 - optional; type booleanWhether 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 - optional; type stringAn 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 - optional, unbounded; type longThe list of {@code 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 - optional, unbounded; type longThe list of {@link 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 - optional, unbounded; type AdBreakMarkupType - type string with restriction - enum { 'AD_BREAK_MARKUP_HLS_EXT_CUE', 'AD_BREAK_MARKUP_HLS_PRIMETIME_SPLICE', 'AD_BREAK_MARKUP_HLS_DATERANGE_SPLICE', 'AD_BREAK_MARKUP_SCTE35_XML_SPLICE_INSERT', 'AD_BREAK_MARKUP_SCTE35_BINARY_SPLICE_INSERT', 'AD_BREAK_MARKUP_SCTE35_BINARY_PROVIDER_AD_START_END', 'AD_BREAK_MARKUP_SCTE35_BINARY_PROVIDER_PLACEMENT_OP_START_END', 'AD_BREAK_MARKUP_SCTE35_BINARY_BREAK_START_END', 'UNKNOWN' }The formats that will be recognized as ad break start/end markers. This field is ignored if {@code adBreakMarkupTypesEnabled} is false
- adBreakMarkupTypesEnabled - optional; type booleanWhether this {@link LiveStreamEvent} is specifying a subset of supported {@code adBreakMarkups}. If this field is false, all supported formats will be treated as ad break start/end markers.
- adServingFormat - optional; type AdServingFormat - type string with restriction - enum { 'AD_MANAGER_DAI', 'DIRECT', 'UNKNOWN' }Whether ads on this {@link LiveStreamEvent} are served by Google Ad Manager DAI or Google Ad Serving.
- liveStreamConditioning - optional; type LiveStreamConditioningSettings to specify all types of conditioning to apply to the associated {@link LiveStreamEvent}.
- dashBridge - optional; type DashBridgeA {@code 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.
- enabled - optional; type booleanSpecifies whether to apply DASH Bridge single-period to multi-period MPD conditioning.
Specifies DASH Bridge single-period to multi-period MPD conditioning. - enabled - optional; type boolean
The conditioning to apply to this {@link LiveStreamEvent}. - dashBridge - optional; type DashBridge
- id - optional; type long
Output:createLiveStreamEventsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type createLiveStreamEventsResponse- rval - optional, unbounded; type LiveStreamEventA {@code 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.
- id - optional; type longThe unique ID of the {@code LiveStreamEvent}. This value is read-only and is assigned by Google. This attribute is read-only.
- name - optional; type stringThe name of the {@code LiveStreamEvent}. This value is required to create a live stream event and has a maximum length of 255 characters.
- status - optional; type LiveStreamEventStatus - type string with restriction - enum { 'ACTIVE', 'ARCHIVED', 'PAUSED', 'ADS_PAUSED', 'UNKNOWN' }The status of this {@code LiveStreamEvent}. This attribute is read-only and is assigned by Google. Live stream events are created in the {@link LiveStreamEventStatus#PAUSED} state. This attribute is read-only.
- creationDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time this {@code LiveStreamEvent} was created. This attribute is read-only. This attribute is read-only. - date - optional; type Date
- lastModifiedDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time this {@code LiveStreamEvent} was last modified. This attribute is read-only. This attribute is read-only. - date - optional; type Date
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date and time of this {@code LiveStreamEvent}. This attribute is required if the {@link LiveStreamEvent#startDateTimeType} is {@link StartDateTimeType#USE_START_DATE_TIME} and is ignored for all other values of {@link StartDateTimeType}. Modifying this attribute for an active live stream can impact traffic. - date - optional; type Date
- startDateTimeType - optional; type StartDateTimeType - type string with restriction - enum { 'USE_START_DATE_TIME', 'IMMEDIATELY', 'ONE_HOUR_FROM_NOW', 'UNKNOWN' }Specifies whether to start the {@link LiveStreamEvent} right away, in an hour, etc. This attribute is optional and defaults to {@link StartDateTimeType#USE_START_DATE_TIME}.
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The scheduled end date and time of this {@code LiveStreamEvent}. This attribute is required if {@code unlimitedEndDateTime} is false and ignored if {@code unlimitedEndDateTime} is true. Modifying this attribute for an active live stream can impact traffic. - date - optional; type Date
- unlimitedEndDateTime - optional; type booleanWhether the {@link LiveStreamEvent} has an end time. This attribute is optional and defaults to false. If this field is true, {@code endDateTime} is ignored.
- totalEstimatedConcurrentUsers - optional; type longThe total number of concurrent users expected to watch this live stream across all regions. This attribute is optional and default value is 0.
- contentUrls - optional, unbounded; type stringThe 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 {@link LiveStreamEventStatus#PAUSED} state.
- adTags - optional, unbounded; type stringThe 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 - optional; type stringThis code is used in constructing a live stream event master playlist URL. This attribute is read-only and is assigned by Google. {@code liveStreamEventCode} was renamed {@code assetKey} in v201911. This attribute is read-only.
- slateCreativeId - optional; type longID corresponding to the slate for this live event. If not set, network default value will be used.
- dvrWindowSeconds - optional; type intLength 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 - optional; type booleanWhether the live stream's requests to the IMA SDK API will be authenticated using the DAI authentication keys.
- adBreakFillType - optional; type AdBreakFillType - type string with restriction - enum { 'SLATE', 'UNDERLYING_CONTENT', 'MINIMIZE_SLATE', 'UNKNOWN' }The type of content that should be used to fill an empty ad break. This value is optional and defaults to {@link AdBreakFillType#SLATE}.
- underfillAdBreakFillType - optional; type AdBreakFillType - type string with restriction - enum { 'SLATE', 'UNDERLYING_CONTENT', 'MINIMIZE_SLATE', 'UNKNOWN' }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 {@link AdBreakFillType#SLATE}. To set this field a network needs to have the "Live stream ad break underfill type" feature enabled.
- adHolidayDuration - optional; type longThe 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 - optional; type booleanWhether there will be max filler duration in this live stream. If true, {@code maxFillerDuration} should be specified. This field is optional and defaults to false.
- maxFillerDuration - optional; type longThe 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 - optional; type longThe 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 - optional; type booleanWhether there will be durationless ad breaks in this live stream. If true, {@code defaultAdBreakDuration} should be specified. This field is optional and defaults to false;
- defaultAdBreakDuration - optional; type longThe 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 - optional, unbounded; type longThe list of {@link 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 - optional, unbounded; type longThe list of {@link 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 - optional; type PrerollSettingsThe settings specific to Preroll ad breaks. This field is optional. If null, this livestream does not have prerolls enabled.Settings for ad breaks on {@link LiveStreamEvent} that are specific to preroll.
- adTag - optional; type stringThe Ad Manager ad tag URL generated by the Ad Manager trafficking workflow that is associated with this live stream event. This attribute is required. This attribute is required.
- maxAdPodDurationSeconds - optional; type longThe maximum duration (in seconds) for an ad break. This attribute is required.
- adTag - optional; type string
- hlsSettings - optional; type HlsSettings{@link LiveStream} settings that are specific to the HTTP live streaming (HLS) protocol.
- playlistType - optional; type PlaylistType - type string with restriction - enum { 'EVENT', 'LIVE', 'UNKNOWN' }Indicates the type of the playlist associated with this live stream. The playlist type is analogous to the EXT-X-PLAYLIST-TYPE HLS tag. This field is optional and will default to {@link PlaylistType#LIVE}. This field cannot be modified after live stream creation.
- masterPlaylistSettings - optional; type MasterPlaylistSettingsThe settings for the master playlist. This field is optional and if it is not set will default to a {@link MasterPlaylistSettings} with a refresh type of {@link RefreshType#AUTOMATIC}.Settings for the HLS (HTTP Live Streaming) master playlist.
- refreshType - optional; type RefreshType - type string with restriction - enum { 'AUTOMATIC', 'MANUAL', 'UNKNOWN' }Indicates how the master playlist gets refreshed. This field is optional and defaults to {@link RefreshType#AUTOMATIC}. This field can only be modified when the live stream is in a {@link LiveStreamEventStatus#PAUSED} state.
- refreshType - optional; type RefreshType - type string with restriction - enum { 'AUTOMATIC', 'MANUAL', 'UNKNOWN' }
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. - playlistType - optional; type PlaylistType - type string with restriction - enum { 'EVENT', 'LIVE', 'UNKNOWN' }
- enableAllowlistedIps - optional; type booleanWhether 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 - optional; type DynamicAdInsertionType - type string with restriction - enum { 'LINEAR', 'POD_SERVING_REDIRECT', 'POD_SERVING_MANIFEST', 'UNKNOWN' }The method of dynamic ad insertion that is used to insert ads into this live stream. This attribute is optional and defaults to {@link DynamicAdInsertionType.LINEAR}. This field cannot be modified after live stream creation.
- enableRelativePlaylistDelivery - optional; type booleanWhether 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 {@link LiveStreamEventStatus#PAUSED} state.
- streamingFormat - optional; type StreamingFormat - type string with restriction - enum { 'HLS', 'DASH', 'UNKNOWN' }The streaming format of the {@link LiveStreamEvent} media. This field cannot be modified after live stream creation.
- prefetchEnabled - optional; type booleanIndicates whether the option to prefetch ad requests is enabled.
- prefetchSettings - optional; type PrefetchSettingsThe information needed to prefetch ad requests for an ad break.The information needed to prefetch ad requests for an ad break.
- initialAdRequestDurationSeconds - optional; type intThe duration of the part of the break to be prefetched.
- initialAdRequestDurationSeconds - optional; type int
- enableForceCloseAdBreaks - optional; type booleanWhether 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 - optional; type booleanWhether 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 - optional; type stringAn 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 - optional, unbounded; type longThe list of {@code 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 - optional, unbounded; type longThe list of {@link 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 - optional, unbounded; type AdBreakMarkupType - type string with restriction - enum { 'AD_BREAK_MARKUP_HLS_EXT_CUE', 'AD_BREAK_MARKUP_HLS_PRIMETIME_SPLICE', 'AD_BREAK_MARKUP_HLS_DATERANGE_SPLICE', 'AD_BREAK_MARKUP_SCTE35_XML_SPLICE_INSERT', 'AD_BREAK_MARKUP_SCTE35_BINARY_SPLICE_INSERT', 'AD_BREAK_MARKUP_SCTE35_BINARY_PROVIDER_AD_START_END', 'AD_BREAK_MARKUP_SCTE35_BINARY_PROVIDER_PLACEMENT_OP_START_END', 'AD_BREAK_MARKUP_SCTE35_BINARY_BREAK_START_END', 'UNKNOWN' }The formats that will be recognized as ad break start/end markers. This field is ignored if {@code adBreakMarkupTypesEnabled} is false
- adBreakMarkupTypesEnabled - optional; type booleanWhether this {@link LiveStreamEvent} is specifying a subset of supported {@code adBreakMarkups}. If this field is false, all supported formats will be treated as ad break start/end markers.
- adServingFormat - optional; type AdServingFormat - type string with restriction - enum { 'AD_MANAGER_DAI', 'DIRECT', 'UNKNOWN' }Whether ads on this {@link LiveStreamEvent} are served by Google Ad Manager DAI or Google Ad Serving.
- liveStreamConditioning - optional; type LiveStreamConditioningSettings to specify all types of conditioning to apply to the associated {@link LiveStreamEvent}.
- dashBridge - optional; type DashBridgeA {@code 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.
- enabled - optional; type booleanSpecifies whether to apply DASH Bridge single-period to multi-period MPD conditioning.
Specifies DASH Bridge single-period to multi-period MPD conditioning. - enabled - optional; type boolean
The conditioning to apply to this {@link LiveStreamEvent}. - dashBridge - optional; type DashBridge
- id - optional; type long
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - createSlatesDescription:Create new slates.
A slate creative is served as backup content in a live stream event when no other creatives are eligible to be served.
Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:createSlatesRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type createSlatesCreate new slates.A slate creative is served as backup content in a live stream event when no other creatives are eligible to be served.
- slates - optional, unbounded; type SlateA {@code Slate} encapsulates all the information necessary to represent a Slate entity, the video creative used by Dynamic Ad Insertion to fill vacant ad slots.
- id - optional; type longThe unique ID of the {@code Slate}. This value is read-only and is assigned by Google.
- name - optional; type stringThe name of the {@code Slate}. This value is required to create a slate and has a maximum length of 255 characters.
- status - optional; type SlateStatus - type string with restriction - enum { 'ACTIVE', 'ARCHIVED', 'UNKNOWN' }The status of this {@code Slate}. This attribute is read-only and is assigned by Google. Slates are created in the {@link SlateStatus#ACTIVE} state.
- transcodeStatus - optional; type TranscodeStatus - type string with restriction - enum { 'UNKNOWN', 'NOT_READY', 'COMPLETED', 'FAILED', 'NEEDS_TRANSCODE', 'IN_PROGRESS' }Server side transcoding status of the current slate.
- videoSourceUrl - optional; type stringThe location of the original asset if publisher provided and slate is externally hosted.
- lastModifiedDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time this slate was last modified. - date - optional; type Date
- id - optional; type long
Output:createSlatesResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type createSlatesResponse- rval - optional, unbounded; type SlateA {@code Slate} encapsulates all the information necessary to represent a Slate entity, the video creative used by Dynamic Ad Insertion to fill vacant ad slots.
- id - optional; type longThe unique ID of the {@code Slate}. This value is read-only and is assigned by Google.
- name - optional; type stringThe name of the {@code Slate}. This value is required to create a slate and has a maximum length of 255 characters.
- status - optional; type SlateStatus - type string with restriction - enum { 'ACTIVE', 'ARCHIVED', 'UNKNOWN' }The status of this {@code Slate}. This attribute is read-only and is assigned by Google. Slates are created in the {@link SlateStatus#ACTIVE} state.
- transcodeStatus - optional; type TranscodeStatus - type string with restriction - enum { 'UNKNOWN', 'NOT_READY', 'COMPLETED', 'FAILED', 'NEEDS_TRANSCODE', 'IN_PROGRESS' }Server side transcoding status of the current slate.
- videoSourceUrl - optional; type stringThe location of the original asset if publisher provided and slate is externally hosted.
- lastModifiedDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time this slate was last modified. - date - optional; type Date
- id - optional; type long
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - slates - optional, unbounded; type Slate
- getLiveStreamEventsByStatementDescription:Gets a {@link LiveStreamEventPage} of {@link LiveStreamEvent} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:
PQL Property Object Property {@code id} {@link LiveStreamEvent#id} {@code slateCreativeId} {@link LiveStreamEvent#slateCreativeId} {@code assetKey} {@link LiveStreamEvent#assetKey} {@code streamCreateDaiAuthenticationKeyIds} {@link LiveStreamEvent#streamCreateDaiAuthenticationKeyIds} {@code dynamicAdInsertionType} {@link LiveStreamEvent#dynamicAdInsertionType} {@code streamingFormat} {@link LiveStreamEvent#streamingFormat} {@code customAssetKey} {@link LiveStreamEvent#customAssetKey} {@code daiEncodingProfileIds} {@link LiveStreamEvent#daiEncodingProfileIds} {@code segmentUrlAuthenticationKeyIds} {@link LiveStreamEvent#segmentUrlAuthenticationKeyIds} Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:getLiveStreamEventsByStatementRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type getLiveStreamEventsByStatementGets a {@link LiveStreamEventPage} of {@link LiveStreamEvent} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:PQL Property Object Property {@code id} {@link LiveStreamEvent#id} {@code slateCreativeId} {@link LiveStreamEvent#slateCreativeId} {@code assetKey} {@link LiveStreamEvent#assetKey} {@code streamCreateDaiAuthenticationKeyIds} {@link LiveStreamEvent#streamCreateDaiAuthenticationKeyIds} {@code dynamicAdInsertionType} {@link LiveStreamEvent#dynamicAdInsertionType} {@code streamingFormat} {@link LiveStreamEvent#streamingFormat} {@code customAssetKey} {@link LiveStreamEvent#customAssetKey} {@code daiEncodingProfileIds} {@link LiveStreamEvent#daiEncodingProfileIds} {@code segmentUrlAuthenticationKeyIds} {@link LiveStreamEvent#segmentUrlAuthenticationKeyIds} - filterStatement - optional; type StatementCaptures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.
An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.
Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.
An example of such a query might be {@code "WHERE id = :idValue"}.
Statements also support use of the LIKE keyword. This provides wildcard string matching.
An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.
The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.- query - optional; type stringHolds the query in PQL syntax. The syntax is:
[WHERE{[AND | OR] ...}]
[ORDER BY[ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
:={< | <= | > | >= | = | != }
:={< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
- values - optional, unbounded; type String_ValueMapEntryHolds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.
In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.
This represents an entry in a map with a key of type String and value of type Value.- key - optional; type string
- value - optional; type Value{@code Value} represents a value.
- query - optional; type string
Output:getLiveStreamEventsByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type getLiveStreamEventsByStatementResponse- rval - optional; type LiveStreamEventPageCaptures a page of {@link LiveStreamEvent} objects.
- totalResultSetSize - optional; type intThe size of the total result set to which this page belongs.
- startIndex - optional; type intThe absolute index in the total result set on which this page begins.
- results - optional, unbounded; type LiveStreamEventA {@code 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.
- id - optional; type longThe unique ID of the {@code LiveStreamEvent}. This value is read-only and is assigned by Google. This attribute is read-only.
- name - optional; type stringThe name of the {@code LiveStreamEvent}. This value is required to create a live stream event and has a maximum length of 255 characters.
- status - optional; type LiveStreamEventStatus - type string with restriction - enum { 'ACTIVE', 'ARCHIVED', 'PAUSED', 'ADS_PAUSED', 'UNKNOWN' }The status of this {@code LiveStreamEvent}. This attribute is read-only and is assigned by Google. Live stream events are created in the {@link LiveStreamEventStatus#PAUSED} state. This attribute is read-only.
- creationDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time this {@code LiveStreamEvent} was created. This attribute is read-only. This attribute is read-only. - date - optional; type Date
- lastModifiedDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time this {@code LiveStreamEvent} was last modified. This attribute is read-only. This attribute is read-only. - date - optional; type Date
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date and time of this {@code LiveStreamEvent}. This attribute is required if the {@link LiveStreamEvent#startDateTimeType} is {@link StartDateTimeType#USE_START_DATE_TIME} and is ignored for all other values of {@link StartDateTimeType}. Modifying this attribute for an active live stream can impact traffic. - date - optional; type Date
- startDateTimeType - optional; type StartDateTimeType - type string with restriction - enum { 'USE_START_DATE_TIME', 'IMMEDIATELY', 'ONE_HOUR_FROM_NOW', 'UNKNOWN' }Specifies whether to start the {@link LiveStreamEvent} right away, in an hour, etc. This attribute is optional and defaults to {@link StartDateTimeType#USE_START_DATE_TIME}.
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The scheduled end date and time of this {@code LiveStreamEvent}. This attribute is required if {@code unlimitedEndDateTime} is false and ignored if {@code unlimitedEndDateTime} is true. Modifying this attribute for an active live stream can impact traffic. - date - optional; type Date
- unlimitedEndDateTime - optional; type booleanWhether the {@link LiveStreamEvent} has an end time. This attribute is optional and defaults to false. If this field is true, {@code endDateTime} is ignored.
- totalEstimatedConcurrentUsers - optional; type longThe total number of concurrent users expected to watch this live stream across all regions. This attribute is optional and default value is 0.
- contentUrls - optional, unbounded; type stringThe 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 {@link LiveStreamEventStatus#PAUSED} state.
- adTags - optional, unbounded; type stringThe 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 - optional; type stringThis code is used in constructing a live stream event master playlist URL. This attribute is read-only and is assigned by Google. {@code liveStreamEventCode} was renamed {@code assetKey} in v201911. This attribute is read-only.
- slateCreativeId - optional; type longID corresponding to the slate for this live event. If not set, network default value will be used.
- dvrWindowSeconds - optional; type intLength 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 - optional; type booleanWhether the live stream's requests to the IMA SDK API will be authenticated using the DAI authentication keys.
- adBreakFillType - optional; type AdBreakFillType - type string with restriction - enum { 'SLATE', 'UNDERLYING_CONTENT', 'MINIMIZE_SLATE', 'UNKNOWN' }The type of content that should be used to fill an empty ad break. This value is optional and defaults to {@link AdBreakFillType#SLATE}.
- underfillAdBreakFillType - optional; type AdBreakFillType - type string with restriction - enum { 'SLATE', 'UNDERLYING_CONTENT', 'MINIMIZE_SLATE', 'UNKNOWN' }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 {@link AdBreakFillType#SLATE}. To set this field a network needs to have the "Live stream ad break underfill type" feature enabled.
- adHolidayDuration - optional; type longThe 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 - optional; type booleanWhether there will be max filler duration in this live stream. If true, {@code maxFillerDuration} should be specified. This field is optional and defaults to false.
- maxFillerDuration - optional; type longThe 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 - optional; type longThe 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 - optional; type booleanWhether there will be durationless ad breaks in this live stream. If true, {@code defaultAdBreakDuration} should be specified. This field is optional and defaults to false;
- defaultAdBreakDuration - optional; type longThe 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 - optional, unbounded; type longThe list of {@link 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 - optional, unbounded; type longThe list of {@link 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 - optional; type PrerollSettingsThe settings specific to Preroll ad breaks. This field is optional. If null, this livestream does not have prerolls enabled.Settings for ad breaks on {@link LiveStreamEvent} that are specific to preroll.
- adTag - optional; type stringThe Ad Manager ad tag URL generated by the Ad Manager trafficking workflow that is associated with this live stream event. This attribute is required. This attribute is required.
- maxAdPodDurationSeconds - optional; type longThe maximum duration (in seconds) for an ad break. This attribute is required.
- adTag - optional; type string
- hlsSettings - optional; type HlsSettings{@link LiveStream} settings that are specific to the HTTP live streaming (HLS) protocol.
- playlistType - optional; type PlaylistType - type string with restriction - enum { 'EVENT', 'LIVE', 'UNKNOWN' }Indicates the type of the playlist associated with this live stream. The playlist type is analogous to the EXT-X-PLAYLIST-TYPE HLS tag. This field is optional and will default to {@link PlaylistType#LIVE}. This field cannot be modified after live stream creation.
- masterPlaylistSettings - optional; type MasterPlaylistSettingsThe settings for the master playlist. This field is optional and if it is not set will default to a {@link MasterPlaylistSettings} with a refresh type of {@link RefreshType#AUTOMATIC}.Settings for the HLS (HTTP Live Streaming) master playlist.
- refreshType - optional; type RefreshType - type string with restriction - enum { 'AUTOMATIC', 'MANUAL', 'UNKNOWN' }Indicates how the master playlist gets refreshed. This field is optional and defaults to {@link RefreshType#AUTOMATIC}. This field can only be modified when the live stream is in a {@link LiveStreamEventStatus#PAUSED} state.
- refreshType - optional; type RefreshType - type string with restriction - enum { 'AUTOMATIC', 'MANUAL', 'UNKNOWN' }
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. - playlistType - optional; type PlaylistType - type string with restriction - enum { 'EVENT', 'LIVE', 'UNKNOWN' }
- enableAllowlistedIps - optional; type booleanWhether 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 - optional; type DynamicAdInsertionType - type string with restriction - enum { 'LINEAR', 'POD_SERVING_REDIRECT', 'POD_SERVING_MANIFEST', 'UNKNOWN' }The method of dynamic ad insertion that is used to insert ads into this live stream. This attribute is optional and defaults to {@link DynamicAdInsertionType.LINEAR}. This field cannot be modified after live stream creation.
- enableRelativePlaylistDelivery - optional; type booleanWhether 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 {@link LiveStreamEventStatus#PAUSED} state.
- streamingFormat - optional; type StreamingFormat - type string with restriction - enum { 'HLS', 'DASH', 'UNKNOWN' }The streaming format of the {@link LiveStreamEvent} media. This field cannot be modified after live stream creation.
- prefetchEnabled - optional; type booleanIndicates whether the option to prefetch ad requests is enabled.
- prefetchSettings - optional; type PrefetchSettingsThe information needed to prefetch ad requests for an ad break.The information needed to prefetch ad requests for an ad break.
- initialAdRequestDurationSeconds - optional; type intThe duration of the part of the break to be prefetched.
- initialAdRequestDurationSeconds - optional; type int
- enableForceCloseAdBreaks - optional; type booleanWhether 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 - optional; type booleanWhether 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 - optional; type stringAn 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 - optional, unbounded; type longThe list of {@code 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 - optional, unbounded; type longThe list of {@link 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 - optional, unbounded; type AdBreakMarkupType - type string with restriction - enum { 'AD_BREAK_MARKUP_HLS_EXT_CUE', 'AD_BREAK_MARKUP_HLS_PRIMETIME_SPLICE', 'AD_BREAK_MARKUP_HLS_DATERANGE_SPLICE', 'AD_BREAK_MARKUP_SCTE35_XML_SPLICE_INSERT', 'AD_BREAK_MARKUP_SCTE35_BINARY_SPLICE_INSERT', 'AD_BREAK_MARKUP_SCTE35_BINARY_PROVIDER_AD_START_END', 'AD_BREAK_MARKUP_SCTE35_BINARY_PROVIDER_PLACEMENT_OP_START_END', 'AD_BREAK_MARKUP_SCTE35_BINARY_BREAK_START_END', 'UNKNOWN' }The formats that will be recognized as ad break start/end markers. This field is ignored if {@code adBreakMarkupTypesEnabled} is false
- adBreakMarkupTypesEnabled - optional; type booleanWhether this {@link LiveStreamEvent} is specifying a subset of supported {@code adBreakMarkups}. If this field is false, all supported formats will be treated as ad break start/end markers.
- adServingFormat - optional; type AdServingFormat - type string with restriction - enum { 'AD_MANAGER_DAI', 'DIRECT', 'UNKNOWN' }Whether ads on this {@link LiveStreamEvent} are served by Google Ad Manager DAI or Google Ad Serving.
- liveStreamConditioning - optional; type LiveStreamConditioningSettings to specify all types of conditioning to apply to the associated {@link LiveStreamEvent}.
- dashBridge - optional; type DashBridgeA {@code 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.
- enabled - optional; type booleanSpecifies whether to apply DASH Bridge single-period to multi-period MPD conditioning.
Specifies DASH Bridge single-period to multi-period MPD conditioning. - enabled - optional; type boolean
The conditioning to apply to this {@link LiveStreamEvent}. - dashBridge - optional; type DashBridge
The collection of live stream events contained within this page. - id - optional; type long
- totalResultSetSize - optional; type int
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - filterStatement - optional; type Statement
- getSlatesByStatementDescription:Gets a {@link SlatePage} of {@link Slate} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:
PQL Property Object Property {@code id} {@link Slate#id} {@code name} {@link Slate#name} {@code lastModifiedDateTime} {@link Slate#lastModifiedDateTime} Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:getSlatesByStatementRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type getSlatesByStatementGets a {@link SlatePage} of {@link Slate} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:PQL Property Object Property {@code id} {@link Slate#id} {@code name} {@link Slate#name} {@code lastModifiedDateTime} {@link Slate#lastModifiedDateTime} - statement - optional; type StatementCaptures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.
An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.
Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.
An example of such a query might be {@code "WHERE id = :idValue"}.
Statements also support use of the LIKE keyword. This provides wildcard string matching.
An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.
The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.- query - optional; type stringHolds the query in PQL syntax. The syntax is:
[WHERE{[AND | OR] ...}]
[ORDER BY[ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
:={< | <= | > | >= | = | != }
:={< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
- values - optional, unbounded; type String_ValueMapEntryHolds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.
In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.
This represents an entry in a map with a key of type String and value of type Value.- key - optional; type string
- value - optional; type Value{@code Value} represents a value.
- query - optional; type string
Output:getSlatesByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type getSlatesByStatementResponse- rval - optional; type SlatePageCaptures a page of {@link Slate} objects.
- totalResultSetSize - optional; type intThe size of the total result set to which this page belongs.
- startIndex - optional; type intThe absolute index in the total result set on which this page begins.
- results - optional, unbounded; type SlateA {@code Slate} encapsulates all the information necessary to represent a Slate entity, the video creative used by Dynamic Ad Insertion to fill vacant ad slots.
- id - optional; type longThe unique ID of the {@code Slate}. This value is read-only and is assigned by Google.
- name - optional; type stringThe name of the {@code Slate}. This value is required to create a slate and has a maximum length of 255 characters.
- status - optional; type SlateStatus - type string with restriction - enum { 'ACTIVE', 'ARCHIVED', 'UNKNOWN' }The status of this {@code Slate}. This attribute is read-only and is assigned by Google. Slates are created in the {@link SlateStatus#ACTIVE} state.
- transcodeStatus - optional; type TranscodeStatus - type string with restriction - enum { 'UNKNOWN', 'NOT_READY', 'COMPLETED', 'FAILED', 'NEEDS_TRANSCODE', 'IN_PROGRESS' }Server side transcoding status of the current slate.
- videoSourceUrl - optional; type stringThe location of the original asset if publisher provided and slate is externally hosted.
- lastModifiedDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time this slate was last modified. - date - optional; type Date
The collection of live stream events contained within this page. - id - optional; type long
- totalResultSetSize - optional; type int
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - statement - optional; type Statement
- performLiveStreamEventActionDescription:Performs actions on {@link LiveStreamEvent} objects that match the given {@link Statement#query}.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:performLiveStreamEventActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type performLiveStreamEventActionPerforms actions on {@link LiveStreamEvent} objects that match the given {@link Statement#query}.
- liveStreamEventAction - optional; type LiveStreamEventActionRepresents the actions that can be performed on {@link LiveStreamEvent} objects.
- filterStatement - optional; type StatementCaptures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.
An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.
Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.
An example of such a query might be {@code "WHERE id = :idValue"}.
Statements also support use of the LIKE keyword. This provides wildcard string matching.
An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.
The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.- query - optional; type stringHolds the query in PQL syntax. The syntax is:
[WHERE{[AND | OR] ...}]
[ORDER BY[ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
:={< | <= | > | >= | = | != }
:={< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
- values - optional, unbounded; type String_ValueMapEntryHolds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.
In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.
This represents an entry in a map with a key of type String and value of type Value.- key - optional; type string
- value - optional; type Value{@code Value} represents a value.
- query - optional; type string
Output:performLiveStreamEventActionResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type performLiveStreamEventActionResponse- rval - optional; type UpdateResultRepresents the result of performing an action on objects.
- numChanges - optional; type intThe number of objects that were changed as a result of performing the action.
- numChanges - optional; type int
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - liveStreamEventAction - optional; type LiveStreamEventAction
- performSlateActionDescription:Performs actions on slates that match the given {@link Statement}.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:performSlateActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type performSlateActionPerforms actions on slates that match the given {@link Statement}.
- slateAction - optional; type SlateActionRepresents the actions that can be performed on slates.
- filterStatement - optional; type StatementCaptures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.
An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.
Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.
An example of such a query might be {@code "WHERE id = :idValue"}.
Statements also support use of the LIKE keyword. This provides wildcard string matching.
An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.
The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.- query - optional; type stringHolds the query in PQL syntax. The syntax is:
[WHERE{[AND | OR] ...}]
[ORDER BY[ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
:={< | <= | > | >= | = | != }
:={< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
- values - optional, unbounded; type String_ValueMapEntryHolds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.
In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.
This represents an entry in a map with a key of type String and value of type Value.- key - optional; type string
- value - optional; type Value{@code Value} represents a value.
- query - optional; type string
Output:performSlateActionResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type performSlateActionResponse- rval - optional; type UpdateResultRepresents the result of performing an action on objects.
- numChanges - optional; type intThe number of objects that were changed as a result of performing the action.
- numChanges - optional; type int
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - slateAction - optional; type SlateAction
- updateLiveStreamEventsDescription:Updates the specified {@link LiveStreamEvent} objects.Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:updateLiveStreamEventsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type updateLiveStreamEventsUpdates the specified {@link LiveStreamEvent} objects.
- liveStreamEvents - optional, unbounded; type LiveStreamEventA {@code 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.
- id - optional; type longThe unique ID of the {@code LiveStreamEvent}. This value is read-only and is assigned by Google. This attribute is read-only.
- name - optional; type stringThe name of the {@code LiveStreamEvent}. This value is required to create a live stream event and has a maximum length of 255 characters.
- status - optional; type LiveStreamEventStatus - type string with restriction - enum { 'ACTIVE', 'ARCHIVED', 'PAUSED', 'ADS_PAUSED', 'UNKNOWN' }The status of this {@code LiveStreamEvent}. This attribute is read-only and is assigned by Google. Live stream events are created in the {@link LiveStreamEventStatus#PAUSED} state. This attribute is read-only.
- creationDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time this {@code LiveStreamEvent} was created. This attribute is read-only. This attribute is read-only. - date - optional; type Date
- lastModifiedDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time this {@code LiveStreamEvent} was last modified. This attribute is read-only. This attribute is read-only. - date - optional; type Date
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date and time of this {@code LiveStreamEvent}. This attribute is required if the {@link LiveStreamEvent#startDateTimeType} is {@link StartDateTimeType#USE_START_DATE_TIME} and is ignored for all other values of {@link StartDateTimeType}. Modifying this attribute for an active live stream can impact traffic. - date - optional; type Date
- startDateTimeType - optional; type StartDateTimeType - type string with restriction - enum { 'USE_START_DATE_TIME', 'IMMEDIATELY', 'ONE_HOUR_FROM_NOW', 'UNKNOWN' }Specifies whether to start the {@link LiveStreamEvent} right away, in an hour, etc. This attribute is optional and defaults to {@link StartDateTimeType#USE_START_DATE_TIME}.
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The scheduled end date and time of this {@code LiveStreamEvent}. This attribute is required if {@code unlimitedEndDateTime} is false and ignored if {@code unlimitedEndDateTime} is true. Modifying this attribute for an active live stream can impact traffic. - date - optional; type Date
- unlimitedEndDateTime - optional; type booleanWhether the {@link LiveStreamEvent} has an end time. This attribute is optional and defaults to false. If this field is true, {@code endDateTime} is ignored.
- totalEstimatedConcurrentUsers - optional; type longThe total number of concurrent users expected to watch this live stream across all regions. This attribute is optional and default value is 0.
- contentUrls - optional, unbounded; type stringThe 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 {@link LiveStreamEventStatus#PAUSED} state.
- adTags - optional, unbounded; type stringThe 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 - optional; type stringThis code is used in constructing a live stream event master playlist URL. This attribute is read-only and is assigned by Google. {@code liveStreamEventCode} was renamed {@code assetKey} in v201911. This attribute is read-only.
- slateCreativeId - optional; type longID corresponding to the slate for this live event. If not set, network default value will be used.
- dvrWindowSeconds - optional; type intLength 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 - optional; type booleanWhether the live stream's requests to the IMA SDK API will be authenticated using the DAI authentication keys.
- adBreakFillType - optional; type AdBreakFillType - type string with restriction - enum { 'SLATE', 'UNDERLYING_CONTENT', 'MINIMIZE_SLATE', 'UNKNOWN' }The type of content that should be used to fill an empty ad break. This value is optional and defaults to {@link AdBreakFillType#SLATE}.
- underfillAdBreakFillType - optional; type AdBreakFillType - type string with restriction - enum { 'SLATE', 'UNDERLYING_CONTENT', 'MINIMIZE_SLATE', 'UNKNOWN' }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 {@link AdBreakFillType#SLATE}. To set this field a network needs to have the "Live stream ad break underfill type" feature enabled.
- adHolidayDuration - optional; type longThe 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 - optional; type booleanWhether there will be max filler duration in this live stream. If true, {@code maxFillerDuration} should be specified. This field is optional and defaults to false.
- maxFillerDuration - optional; type longThe 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 - optional; type longThe 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 - optional; type booleanWhether there will be durationless ad breaks in this live stream. If true, {@code defaultAdBreakDuration} should be specified. This field is optional and defaults to false;
- defaultAdBreakDuration - optional; type longThe 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 - optional, unbounded; type longThe list of {@link 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 - optional, unbounded; type longThe list of {@link 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 - optional; type PrerollSettingsThe settings specific to Preroll ad breaks. This field is optional. If null, this livestream does not have prerolls enabled.Settings for ad breaks on {@link LiveStreamEvent} that are specific to preroll.
- adTag - optional; type stringThe Ad Manager ad tag URL generated by the Ad Manager trafficking workflow that is associated with this live stream event. This attribute is required. This attribute is required.
- maxAdPodDurationSeconds - optional; type longThe maximum duration (in seconds) for an ad break. This attribute is required.
- adTag - optional; type string
- hlsSettings - optional; type HlsSettings{@link LiveStream} settings that are specific to the HTTP live streaming (HLS) protocol.
- playlistType - optional; type PlaylistType - type string with restriction - enum { 'EVENT', 'LIVE', 'UNKNOWN' }Indicates the type of the playlist associated with this live stream. The playlist type is analogous to the EXT-X-PLAYLIST-TYPE HLS tag. This field is optional and will default to {@link PlaylistType#LIVE}. This field cannot be modified after live stream creation.
- masterPlaylistSettings - optional; type MasterPlaylistSettingsThe settings for the master playlist. This field is optional and if it is not set will default to a {@link MasterPlaylistSettings} with a refresh type of {@link RefreshType#AUTOMATIC}.Settings for the HLS (HTTP Live Streaming) master playlist.
- refreshType - optional; type RefreshType - type string with restriction - enum { 'AUTOMATIC', 'MANUAL', 'UNKNOWN' }Indicates how the master playlist gets refreshed. This field is optional and defaults to {@link RefreshType#AUTOMATIC}. This field can only be modified when the live stream is in a {@link LiveStreamEventStatus#PAUSED} state.
- refreshType - optional; type RefreshType - type string with restriction - enum { 'AUTOMATIC', 'MANUAL', 'UNKNOWN' }
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. - playlistType - optional; type PlaylistType - type string with restriction - enum { 'EVENT', 'LIVE', 'UNKNOWN' }
- enableAllowlistedIps - optional; type booleanWhether 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 - optional; type DynamicAdInsertionType - type string with restriction - enum { 'LINEAR', 'POD_SERVING_REDIRECT', 'POD_SERVING_MANIFEST', 'UNKNOWN' }The method of dynamic ad insertion that is used to insert ads into this live stream. This attribute is optional and defaults to {@link DynamicAdInsertionType.LINEAR}. This field cannot be modified after live stream creation.
- enableRelativePlaylistDelivery - optional; type booleanWhether 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 {@link LiveStreamEventStatus#PAUSED} state.
- streamingFormat - optional; type StreamingFormat - type string with restriction - enum { 'HLS', 'DASH', 'UNKNOWN' }The streaming format of the {@link LiveStreamEvent} media. This field cannot be modified after live stream creation.
- prefetchEnabled - optional; type booleanIndicates whether the option to prefetch ad requests is enabled.
- prefetchSettings - optional; type PrefetchSettingsThe information needed to prefetch ad requests for an ad break.The information needed to prefetch ad requests for an ad break.
- initialAdRequestDurationSeconds - optional; type intThe duration of the part of the break to be prefetched.
- initialAdRequestDurationSeconds - optional; type int
- enableForceCloseAdBreaks - optional; type booleanWhether 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 - optional; type booleanWhether 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 - optional; type stringAn 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 - optional, unbounded; type longThe list of {@code 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 - optional, unbounded; type longThe list of {@link 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 - optional, unbounded; type AdBreakMarkupType - type string with restriction - enum { 'AD_BREAK_MARKUP_HLS_EXT_CUE', 'AD_BREAK_MARKUP_HLS_PRIMETIME_SPLICE', 'AD_BREAK_MARKUP_HLS_DATERANGE_SPLICE', 'AD_BREAK_MARKUP_SCTE35_XML_SPLICE_INSERT', 'AD_BREAK_MARKUP_SCTE35_BINARY_SPLICE_INSERT', 'AD_BREAK_MARKUP_SCTE35_BINARY_PROVIDER_AD_START_END', 'AD_BREAK_MARKUP_SCTE35_BINARY_PROVIDER_PLACEMENT_OP_START_END', 'AD_BREAK_MARKUP_SCTE35_BINARY_BREAK_START_END', 'UNKNOWN' }The formats that will be recognized as ad break start/end markers. This field is ignored if {@code adBreakMarkupTypesEnabled} is false
- adBreakMarkupTypesEnabled - optional; type booleanWhether this {@link LiveStreamEvent} is specifying a subset of supported {@code adBreakMarkups}. If this field is false, all supported formats will be treated as ad break start/end markers.
- adServingFormat - optional; type AdServingFormat - type string with restriction - enum { 'AD_MANAGER_DAI', 'DIRECT', 'UNKNOWN' }Whether ads on this {@link LiveStreamEvent} are served by Google Ad Manager DAI or Google Ad Serving.
- liveStreamConditioning - optional; type LiveStreamConditioningSettings to specify all types of conditioning to apply to the associated {@link LiveStreamEvent}.
- dashBridge - optional; type DashBridgeA {@code 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.
- enabled - optional; type booleanSpecifies whether to apply DASH Bridge single-period to multi-period MPD conditioning.
Specifies DASH Bridge single-period to multi-period MPD conditioning. - enabled - optional; type boolean
The conditioning to apply to this {@link LiveStreamEvent}. - dashBridge - optional; type DashBridge
- id - optional; type long
Output:updateLiveStreamEventsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type updateLiveStreamEventsResponse- rval - optional, unbounded; type LiveStreamEventA {@code 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.
- id - optional; type longThe unique ID of the {@code LiveStreamEvent}. This value is read-only and is assigned by Google. This attribute is read-only.
- name - optional; type stringThe name of the {@code LiveStreamEvent}. This value is required to create a live stream event and has a maximum length of 255 characters.
- status - optional; type LiveStreamEventStatus - type string with restriction - enum { 'ACTIVE', 'ARCHIVED', 'PAUSED', 'ADS_PAUSED', 'UNKNOWN' }The status of this {@code LiveStreamEvent}. This attribute is read-only and is assigned by Google. Live stream events are created in the {@link LiveStreamEventStatus#PAUSED} state. This attribute is read-only.
- creationDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time this {@code LiveStreamEvent} was created. This attribute is read-only. This attribute is read-only. - date - optional; type Date
- lastModifiedDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time this {@code LiveStreamEvent} was last modified. This attribute is read-only. This attribute is read-only. - date - optional; type Date
- startDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The start date and time of this {@code LiveStreamEvent}. This attribute is required if the {@link LiveStreamEvent#startDateTimeType} is {@link StartDateTimeType#USE_START_DATE_TIME} and is ignored for all other values of {@link StartDateTimeType}. Modifying this attribute for an active live stream can impact traffic. - date - optional; type Date
- startDateTimeType - optional; type StartDateTimeType - type string with restriction - enum { 'USE_START_DATE_TIME', 'IMMEDIATELY', 'ONE_HOUR_FROM_NOW', 'UNKNOWN' }Specifies whether to start the {@link LiveStreamEvent} right away, in an hour, etc. This attribute is optional and defaults to {@link StartDateTimeType#USE_START_DATE_TIME}.
- endDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The scheduled end date and time of this {@code LiveStreamEvent}. This attribute is required if {@code unlimitedEndDateTime} is false and ignored if {@code unlimitedEndDateTime} is true. Modifying this attribute for an active live stream can impact traffic. - date - optional; type Date
- unlimitedEndDateTime - optional; type booleanWhether the {@link LiveStreamEvent} has an end time. This attribute is optional and defaults to false. If this field is true, {@code endDateTime} is ignored.
- totalEstimatedConcurrentUsers - optional; type longThe total number of concurrent users expected to watch this live stream across all regions. This attribute is optional and default value is 0.
- contentUrls - optional, unbounded; type stringThe 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 {@link LiveStreamEventStatus#PAUSED} state.
- adTags - optional, unbounded; type stringThe 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 - optional; type stringThis code is used in constructing a live stream event master playlist URL. This attribute is read-only and is assigned by Google. {@code liveStreamEventCode} was renamed {@code assetKey} in v201911. This attribute is read-only.
- slateCreativeId - optional; type longID corresponding to the slate for this live event. If not set, network default value will be used.
- dvrWindowSeconds - optional; type intLength 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 - optional; type booleanWhether the live stream's requests to the IMA SDK API will be authenticated using the DAI authentication keys.
- adBreakFillType - optional; type AdBreakFillType - type string with restriction - enum { 'SLATE', 'UNDERLYING_CONTENT', 'MINIMIZE_SLATE', 'UNKNOWN' }The type of content that should be used to fill an empty ad break. This value is optional and defaults to {@link AdBreakFillType#SLATE}.
- underfillAdBreakFillType - optional; type AdBreakFillType - type string with restriction - enum { 'SLATE', 'UNDERLYING_CONTENT', 'MINIMIZE_SLATE', 'UNKNOWN' }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 {@link AdBreakFillType#SLATE}. To set this field a network needs to have the "Live stream ad break underfill type" feature enabled.
- adHolidayDuration - optional; type longThe 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 - optional; type booleanWhether there will be max filler duration in this live stream. If true, {@code maxFillerDuration} should be specified. This field is optional and defaults to false.
- maxFillerDuration - optional; type longThe 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 - optional; type longThe 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 - optional; type booleanWhether there will be durationless ad breaks in this live stream. If true, {@code defaultAdBreakDuration} should be specified. This field is optional and defaults to false;
- defaultAdBreakDuration - optional; type longThe 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 - optional, unbounded; type longThe list of {@link 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 - optional, unbounded; type longThe list of {@link 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 - optional; type PrerollSettingsThe settings specific to Preroll ad breaks. This field is optional. If null, this livestream does not have prerolls enabled.Settings for ad breaks on {@link LiveStreamEvent} that are specific to preroll.
- adTag - optional; type stringThe Ad Manager ad tag URL generated by the Ad Manager trafficking workflow that is associated with this live stream event. This attribute is required. This attribute is required.
- maxAdPodDurationSeconds - optional; type longThe maximum duration (in seconds) for an ad break. This attribute is required.
- adTag - optional; type string
- hlsSettings - optional; type HlsSettings{@link LiveStream} settings that are specific to the HTTP live streaming (HLS) protocol.
- playlistType - optional; type PlaylistType - type string with restriction - enum { 'EVENT', 'LIVE', 'UNKNOWN' }Indicates the type of the playlist associated with this live stream. The playlist type is analogous to the EXT-X-PLAYLIST-TYPE HLS tag. This field is optional and will default to {@link PlaylistType#LIVE}. This field cannot be modified after live stream creation.
- masterPlaylistSettings - optional; type MasterPlaylistSettingsThe settings for the master playlist. This field is optional and if it is not set will default to a {@link MasterPlaylistSettings} with a refresh type of {@link RefreshType#AUTOMATIC}.Settings for the HLS (HTTP Live Streaming) master playlist.
- refreshType - optional; type RefreshType - type string with restriction - enum { 'AUTOMATIC', 'MANUAL', 'UNKNOWN' }Indicates how the master playlist gets refreshed. This field is optional and defaults to {@link RefreshType#AUTOMATIC}. This field can only be modified when the live stream is in a {@link LiveStreamEventStatus#PAUSED} state.
- refreshType - optional; type RefreshType - type string with restriction - enum { 'AUTOMATIC', 'MANUAL', 'UNKNOWN' }
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. - playlistType - optional; type PlaylistType - type string with restriction - enum { 'EVENT', 'LIVE', 'UNKNOWN' }
- enableAllowlistedIps - optional; type booleanWhether 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 - optional; type DynamicAdInsertionType - type string with restriction - enum { 'LINEAR', 'POD_SERVING_REDIRECT', 'POD_SERVING_MANIFEST', 'UNKNOWN' }The method of dynamic ad insertion that is used to insert ads into this live stream. This attribute is optional and defaults to {@link DynamicAdInsertionType.LINEAR}. This field cannot be modified after live stream creation.
- enableRelativePlaylistDelivery - optional; type booleanWhether 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 {@link LiveStreamEventStatus#PAUSED} state.
- streamingFormat - optional; type StreamingFormat - type string with restriction - enum { 'HLS', 'DASH', 'UNKNOWN' }The streaming format of the {@link LiveStreamEvent} media. This field cannot be modified after live stream creation.
- prefetchEnabled - optional; type booleanIndicates whether the option to prefetch ad requests is enabled.
- prefetchSettings - optional; type PrefetchSettingsThe information needed to prefetch ad requests for an ad break.The information needed to prefetch ad requests for an ad break.
- initialAdRequestDurationSeconds - optional; type intThe duration of the part of the break to be prefetched.
- initialAdRequestDurationSeconds - optional; type int
- enableForceCloseAdBreaks - optional; type booleanWhether 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 - optional; type booleanWhether 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 - optional; type stringAn 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 - optional, unbounded; type longThe list of {@code 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 - optional, unbounded; type longThe list of {@link 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 - optional, unbounded; type AdBreakMarkupType - type string with restriction - enum { 'AD_BREAK_MARKUP_HLS_EXT_CUE', 'AD_BREAK_MARKUP_HLS_PRIMETIME_SPLICE', 'AD_BREAK_MARKUP_HLS_DATERANGE_SPLICE', 'AD_BREAK_MARKUP_SCTE35_XML_SPLICE_INSERT', 'AD_BREAK_MARKUP_SCTE35_BINARY_SPLICE_INSERT', 'AD_BREAK_MARKUP_SCTE35_BINARY_PROVIDER_AD_START_END', 'AD_BREAK_MARKUP_SCTE35_BINARY_PROVIDER_PLACEMENT_OP_START_END', 'AD_BREAK_MARKUP_SCTE35_BINARY_BREAK_START_END', 'UNKNOWN' }The formats that will be recognized as ad break start/end markers. This field is ignored if {@code adBreakMarkupTypesEnabled} is false
- adBreakMarkupTypesEnabled - optional; type booleanWhether this {@link LiveStreamEvent} is specifying a subset of supported {@code adBreakMarkups}. If this field is false, all supported formats will be treated as ad break start/end markers.
- adServingFormat - optional; type AdServingFormat - type string with restriction - enum { 'AD_MANAGER_DAI', 'DIRECT', 'UNKNOWN' }Whether ads on this {@link LiveStreamEvent} are served by Google Ad Manager DAI or Google Ad Serving.
- liveStreamConditioning - optional; type LiveStreamConditioningSettings to specify all types of conditioning to apply to the associated {@link LiveStreamEvent}.
- dashBridge - optional; type DashBridgeA {@code 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.
- enabled - optional; type booleanSpecifies whether to apply DASH Bridge single-period to multi-period MPD conditioning.
Specifies DASH Bridge single-period to multi-period MPD conditioning. - enabled - optional; type boolean
The conditioning to apply to this {@link LiveStreamEvent}. - dashBridge - optional; type DashBridge
- id - optional; type long
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - liveStreamEvents - optional, unbounded; type LiveStreamEvent
- updateSlatesDescription:Update existing slates.
Only the slateName is editable.
Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:updateSlatesRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type updateSlatesUpdate existing slates.Only the slateName is editable.
- slates - optional, unbounded; type SlateA {@code Slate} encapsulates all the information necessary to represent a Slate entity, the video creative used by Dynamic Ad Insertion to fill vacant ad slots.
- id - optional; type longThe unique ID of the {@code Slate}. This value is read-only and is assigned by Google.
- name - optional; type stringThe name of the {@code Slate}. This value is required to create a slate and has a maximum length of 255 characters.
- status - optional; type SlateStatus - type string with restriction - enum { 'ACTIVE', 'ARCHIVED', 'UNKNOWN' }The status of this {@code Slate}. This attribute is read-only and is assigned by Google. Slates are created in the {@link SlateStatus#ACTIVE} state.
- transcodeStatus - optional; type TranscodeStatus - type string with restriction - enum { 'UNKNOWN', 'NOT_READY', 'COMPLETED', 'FAILED', 'NEEDS_TRANSCODE', 'IN_PROGRESS' }Server side transcoding status of the current slate.
- videoSourceUrl - optional; type stringThe location of the original asset if publisher provided and slate is externally hosted.
- lastModifiedDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time this slate was last modified. - date - optional; type Date
- id - optional; type long
Output:updateSlatesResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type updateSlatesResponse- rval - optional, unbounded; type SlateA {@code Slate} encapsulates all the information necessary to represent a Slate entity, the video creative used by Dynamic Ad Insertion to fill vacant ad slots.
- id - optional; type longThe unique ID of the {@code Slate}. This value is read-only and is assigned by Google.
- name - optional; type stringThe name of the {@code Slate}. This value is required to create a slate and has a maximum length of 255 characters.
- status - optional; type SlateStatus - type string with restriction - enum { 'ACTIVE', 'ARCHIVED', 'UNKNOWN' }The status of this {@code Slate}. This attribute is read-only and is assigned by Google. Slates are created in the {@link SlateStatus#ACTIVE} state.
- transcodeStatus - optional; type TranscodeStatus - type string with restriction - enum { 'UNKNOWN', 'NOT_READY', 'COMPLETED', 'FAILED', 'NEEDS_TRANSCODE', 'IN_PROGRESS' }Server side transcoding status of the current slate.
- videoSourceUrl - optional; type stringThe location of the original asset if publisher provided and slate is externally hosted.
- lastModifiedDateTime - optional; type DateTimeRepresents a date combined with the time of day.
- date - optional; type DateRepresents a date.
- year - optional; type intYear (e.g., 2009)
- month - optional; type intMonth (1..12)
- day - optional; type intDay (1..31)
- year - optional; type int
- hour - optional; type int
- minute - optional; type int
- second - optional; type int
- timeZoneId - optional; type string
The date and time this slate was last modified. - date - optional; type Date
- id - optional; type long
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe API error base class that provides details about an error that occurred while processing a service request.
The OGNL field path is provided for parsers to identify the request data element that may have caused the error.
- fieldPath - optional; type stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.A segment of a field path. Each dot in a field path defines a new segment.
- field - optional; type stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - slates - optional, unbounded; type Slate
Port type LiveStreamEventServiceInterfaceSource code
WSDL source code
About wsdl-viewer.xsl
Author: tomi vanek
Download athttp://tomi.vanek.sk/xml/wsdl-viewer.xsl.
The transformation was inspired by the article
Uche Ogbuji: WSDL processing with XSLT