|
Ads API .NET library
|
|
Ads API .NET library
|
A More...
Properties | |
| long | id [get, set] |
| The unique ID of the More... | |
| bool | idSpecified [get, set] |
| string | name [get, set] |
| The name of the More... | |
| LiveStreamEventStatus | status [get, set] |
| The status of this More... | |
| bool | statusSpecified [get, set] |
| DateTime | creationDateTime [get, set] |
| The date and time this More... | |
| DateTime | lastModifiedDateTime [get, set] |
| The date and time this More... | |
| DateTime | startDateTime [get, set] |
| The start date and time of this More... | |
| StartDateTimeType | startDateTimeType [get, set] |
| Specifies whether to start the LiveStreamEvent right away, in an hour, etc. This attribute is optional and defaults to StartDateTimeType::USE_START_DATE_TIME. More... | |
| bool | startDateTimeTypeSpecified [get, set] |
| DateTime | endDateTime [get, set] |
| The scheduled end date and time of this More... | |
| bool | unlimitedEndDateTime [get, set] |
| Whether the LiveStreamEvent has an end time. This attribute is optional and defaults to false. If this field is true, More... | |
| bool | unlimitedEndDateTimeSpecified [get, set] |
| long | totalEstimatedConcurrentUsers [get, set] |
| The total number of concurrent users expected to watch this live stream across all regions. This attribute is optional and default value is 0. More... | |
| bool | totalEstimatedConcurrentUsersSpecified [get, set] |
| string[] | contentUrls [get, set] |
| The list of URLs pointing to the live stream content in Content Delivery Network. This attribute is required and can be modified when the live stream is in a LiveStreamEventStatus::PAUSED state. More... | |
| string[] | adTags [get, set] |
| The list of Ad Manager ad tag URLs generated by the Ad Manager trafficking workflow that are associated with this live stream event. Currently, the list includes only one element: the master ad tag. This attribute is required. More... | |
| string | assetKey [get, set] |
| This code is used in constructing a live stream event master playlist URL. This attribute is read-only and is assigned by Google. More... | |
| long | slateCreativeId [get, set] |
| ID corresponding to the slate for this live event. If not set, network default value will be used. More... | |
| bool | slateCreativeIdSpecified [get, set] |
| int | dvrWindowSeconds [get, set] |
| Length of the DVR window in seconds. This value is optional. If unset the default window as provided by the input encoder will be used. Modifying this value for an active live stream can impact traffic. More... | |
| bool | dvrWindowSecondsSpecified [get, set] |
| bool | enableDaiAuthenticationKeys [get, set] |
| Whether the live stream's requests to the IMA SDK API will be authenticated using the DAI authentication keys. More... | |
| bool | enableDaiAuthenticationKeysSpecified [get, set] |
| AdBreakFillType | adBreakFillType [get, set] |
| The type of content that should be used to fill an empty ad break. This value is optional and defaults to AdBreakFillType::SLATE. More... | |
| bool | adBreakFillTypeSpecified [get, set] |
| AdBreakFillType | underfillAdBreakFillType [get, set] |
| The type of content that should be used to fill the time remaining in the ad break when there are not enough ads to fill the entire break. This value is optional and defaults to AdBreakFillType::SLATE. To set this field a network needs to have the "Live stream ad break underfill type" feature enabled. More... | |
| bool | underfillAdBreakFillTypeSpecified [get, set] |
| long | adHolidayDuration [get, set] |
| The duration (in seconds), starting from the time the user enters the DAI stream, for which mid-roll decisioning will be skipped. This field is only applicable when an ad holiday is requested in the stream create request. This value is optional and defaults to 0. More... | |
| bool | adHolidayDurationSpecified [get, set] |
| bool | enableMaxFillerDuration [get, set] |
| Whether there will be max filler duration in this live stream. If true, More... | |
| bool | enableMaxFillerDurationSpecified [get, set] |
| long | maxFillerDuration [get, set] |
| The maximum number of seconds that can be used to fill this ad pod, either with a slate or underlying content, depending on your settings. If more time needs to be filled, the ad pod will instead be dropped and the underlying content will be served. More... | |
| bool | maxFillerDurationSpecified [get, set] |
| bool | enableDurationlessAdBreaks [get, set] |
| Whether there will be durationless ad breaks in this live stream. If true, More... | |
| bool | enableDurationlessAdBreaksSpecified [get, set] |
| long | defaultAdBreakDuration [get, set] |
| The default ad pod duration (in seconds) that will be requested when an ad break cue-out does not specify a duration. This field is optional and defaults to 0; More... | |
| bool | defaultAdBreakDurationSpecified [get, set] |
| long[] | streamCreateDaiAuthenticationKeyIds [get, set] |
| The list of 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. More... | |
| long[] | sourceContentConfigurationIds [get, set] |
| The list of 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. More... | |
| PrerollSettings | prerollSettings [get, set] |
| The settings specific to Preroll ad breaks. This field is optional. If null, this livestream does not have prerolls enabled. More... | |
| HlsSettings | hlsSettings [get, set] |
| 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. More... | |
| bool | enableAllowlistedIps [get, set] |
| Whether specific allowlisted IP addresses should be used to access this live stream. This field is optional and will default to false. To set this field a network needs to have the "Video live allowlisted IPS enabled" feature enabled. Modifying this field for an active live stream can impact traffic. More... | |
| bool | enableAllowlistedIpsSpecified [get, set] |
| DynamicAdInsertionType | dynamicAdInsertionType [get, set] |
| The method of dynamic ad insertion that is used to insert ads into this live stream. This attribute is optional and defaults to DynamicAdInsertionType.LINEAR. This field cannot be modified after live stream creation. More... | |
| bool | dynamicAdInsertionTypeSpecified [get, set] |
| bool | enableRelativePlaylistDelivery [get, set] |
| Whether the served playlists can include relative URLs. This field is optional and defaults to false. To set this field a network needs to have the "Video live
stream relative playlist URLs" feature enabled. This field can be modified when the live stream is in a LiveStreamEventStatus::PAUSED state. More... | |
| bool | enableRelativePlaylistDeliverySpecified [get, set] |
| StreamingFormat | streamingFormat [get, set] |
| The streaming format of the LiveStreamEvent media. This field cannot be modified after live stream creation. More... | |
| bool | streamingFormatSpecified [get, set] |
| bool | prefetchEnabled [get, set] |
| Indicates whether the option to prefetch ad requests is enabled. More... | |
| bool | prefetchEnabledSpecified [get, set] |
| PrefetchSettings | prefetchSettings [get, set] |
| The information needed to prefetch ad requests for an ad break. More... | |
| bool | enableForceCloseAdBreaks [get, set] |
| Whether live stream placement opportunities without #EXT-CUE-IN markers should be force closed. This field is optional and defaults to false. To set this field a network needs to have the "Video live stream forced cue in" feature enabled. More... | |
| bool | enableForceCloseAdBreaksSpecified [get, set] |
| bool | enableShortSegmentDropping [get, set] |
| Whether segments shorter than 1 second at the end of an ad pod should be dropped. This field is optional and defaults to false. To set this field a network needs to have the "Video live stream short segment dropping" feature enabled. More... | |
| bool | enableShortSegmentDroppingSpecified [get, set] |
| string | customAssetKey [get, set] |
| An additional code that can be used in constructing live stream event URLs. This field is immutable after creation and can only be set for pod serving live streams. The custom asset key may be at most 64 characters and can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character. More... | |
| long[] | daiEncodingProfileIds [get, set] |
| The list of More... | |
| long[] | segmentUrlAuthenticationKeyIds [get, set] |
| The list of 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. More... | |
| AdBreakMarkupType[] | adBreakMarkups [get, set] |
| The formats that will be recognized as ad break start/end markers. This field is ignored if More... | |
| bool | adBreakMarkupTypesEnabled [get, set] |
| Whether this LiveStreamEvent is specifying a subset of supported More... | |
| bool | adBreakMarkupTypesEnabledSpecified [get, set] |
| AdServingFormat | adServingFormat [get, set] |
| Whether ads on this LiveStreamEvent are served by Google Ad Manager DAI or Google Ad Serving. More... | |
| bool | adServingFormatSpecified [get, set] |
| LiveStreamConditioning | liveStreamConditioning [get, set] |
| The conditioning to apply to this LiveStreamEvent. More... | |
A
LiveStreamEvent encapsulates all the information necessary to enable DAI (Dynamic Ad Insertion) into a live video stream.
This includes information such as the start and expected end time of the live stream, the URL of the actual content for Ad Manager to pull and insert ads into, as well as the metadata necessary to generate ad requests during the live stream.
|
getset |
The type of content that should be used to fill an empty ad break. This value is optional and defaults to AdBreakFillType::SLATE.
|
getset |
true, if a value is specified for adBreakFillType, false otherwise.
|
getset |
The formats that will be recognized as ad break start/end markers. This field is ignored if
adBreakMarkupTypesEnabled is false
|
getset |
Whether this LiveStreamEvent is specifying a subset of supported
adBreakMarkups. If this field is false, all supported formats will be treated as ad break start/end markers.
|
getset |
true, if a value is specified for adBreakMarkupTypesEnabled, false otherwise.
|
getset |
The duration (in seconds), starting from the time the user enters the DAI stream, for which mid-roll decisioning will be skipped. This field is only applicable when an ad holiday is requested in the stream create request. This value is optional and defaults to 0.
|
getset |
true, if a value is specified for adHolidayDuration, false otherwise.
|
getset |
Whether ads on this LiveStreamEvent are served by Google Ad Manager DAI or Google Ad Serving.
|
getset |
true, if a value is specified for adServingFormat, false otherwise.
|
getset |
The list of Ad Manager ad tag URLs generated by the Ad Manager trafficking workflow that are associated with this live stream event. Currently, the list includes only one element: the master ad tag. This attribute is required.
|
getset |
This code is used in constructing a live stream event master playlist URL. This attribute is read-only and is assigned by Google.
liveStreamEventCode was renamed assetKey in v201911.
|
getset |
The list of URLs pointing to the live stream content in Content Delivery Network. This attribute is required and can be modified when the live stream is in a LiveStreamEventStatus::PAUSED state.
|
getset |
The date and time this
LiveStreamEvent was created. This attribute is read-only.
|
getset |
An additional code that can be used in constructing live stream event URLs. This field is immutable after creation and can only be set for pod serving live streams. The custom asset key may be at most 64 characters and can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.
|
getset |
The list of
DaiEncodingProfile IDs that will be used for this live stream event. This field only applies to pod serving events. New profile IDs can be added to running live streams. Profile IDs cannot be removed from running live streams. Modifying settings for an active live stream may break the stream for some users. Exercise caution.
|
getset |
The default ad pod duration (in seconds) that will be requested when an ad break cue-out does not specify a duration. This field is optional and defaults to 0;
|
getset |
true, if a value is specified for defaultAdBreakDuration, false otherwise.
|
getset |
Length of the DVR window in seconds. This value is optional. If unset the default window as provided by the input encoder will be used. Modifying this value for an active live stream can impact traffic.
|
getset |
true, if a value is specified for dvrWindowSeconds, false otherwise.
|
getset |
The method of dynamic ad insertion that is used to insert ads into this live stream. This attribute is optional and defaults to DynamicAdInsertionType.LINEAR. This field cannot be modified after live stream creation.
|
getset |
true, if a value is specified for dynamicAdInsertionType, false otherwise.
|
getset |
Whether specific allowlisted IP addresses should be used to access this live stream. This field is optional and will default to false. To set this field a network needs to have the "Video live allowlisted IPS enabled" feature enabled. Modifying this field for an active live stream can impact traffic.
|
getset |
true, if a value is specified for enableAllowlistedIps, false otherwise.
|
getset |
Whether the live stream's requests to the IMA SDK API will be authenticated using the DAI authentication keys.
|
getset |
true, if a value is specified for enableDaiAuthenticationKeys, false otherwise.
|
getset |
Whether there will be durationless ad breaks in this live stream. If true,
defaultAdBreakDuration should be specified. This field is optional and defaults to false;
|
getset |
true, if a value is specified for enableDurationlessAdBreaks, false otherwise.
|
getset |
Whether live stream placement opportunities without #EXT-CUE-IN markers should be force closed. This field is optional and defaults to false. To set this field a network needs to have the "Video live stream forced cue in" feature enabled.
|
getset |
true, if a value is specified for enableForceCloseAdBreaks, false otherwise.
|
getset |
Whether there will be max filler duration in this live stream. If true,
maxFillerDuration should be specified. This field is optional and defaults to false.
|
getset |
true, if a value is specified for enableMaxFillerDuration, false otherwise.
|
getset |
Whether the served playlists can include relative URLs. This field is optional and defaults to false. To set this field a network needs to have the "Video live stream relative playlist URLs" feature enabled. This field can be modified when the live stream is in a LiveStreamEventStatus::PAUSED state.
|
getset |
true, if a value is specified for enableRelativePlaylistDelivery, false otherwise.
|
getset |
Whether segments shorter than 1 second at the end of an ad pod should be dropped. This field is optional and defaults to false. To set this field a network needs to have the "Video live stream short segment dropping" feature enabled.
|
getset |
true, if a value is specified for enableShortSegmentDropping, false otherwise.
|
getset |
The scheduled end date and time of this
LiveStreamEvent. This attribute is required if unlimitedEndDateTime is false and ignored if unlimitedEndDateTime is true. Modifying this attribute for an active live stream can impact traffic.
|
getset |
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.
|
getset |
The unique ID of the
LiveStreamEvent. This value is read-only and is assigned by Google.
|
getset |
true, if a value is specified for id, false otherwise.
|
getset |
The date and time this
LiveStreamEvent was last modified. This attribute is read-only.
|
getset |
The conditioning to apply to this LiveStreamEvent.
|
getset |
The maximum number of seconds that can be used to fill this ad pod, either with a slate or underlying content, depending on your settings. If more time needs to be filled, the ad pod will instead be dropped and the underlying content will be served.
|
getset |
true, if a value is specified for maxFillerDuration, false otherwise.
|
getset |
The name of the
LiveStreamEvent. This value is required to create a live stream event and has a maximum length of 255 characters.
|
getset |
Indicates whether the option to prefetch ad requests is enabled.
|
getset |
true, if a value is specified for prefetchEnabled, false otherwise.
|
getset |
The information needed to prefetch ad requests for an ad break.
|
getset |
The settings specific to Preroll ad breaks. This field is optional. If null, this livestream does not have prerolls enabled.
|
getset |
The list of 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.
|
getset |
ID corresponding to the slate for this live event. If not set, network default value will be used.
|
getset |
true, if a value is specified for slateCreativeId, false otherwise.
|
getset |
The list of 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.
|
getset |
The start date and time of this
LiveStreamEvent. This attribute is required if the LiveStreamEvent::startDateTimeType is StartDateTimeType::USE_START_DATE_TIME and is ignored for all other values of StartDateTimeType. Modifying this attribute for an active live stream can impact traffic.
|
getset |
Specifies whether to start the LiveStreamEvent right away, in an hour, etc. This attribute is optional and defaults to StartDateTimeType::USE_START_DATE_TIME.
|
getset |
true, if a value is specified for startDateTimeType, false otherwise.
|
getset |
The status of this
LiveStreamEvent. This attribute is read-only and is assigned by Google. Live stream events are created in the LiveStreamEventStatus::PAUSED state.
|
getset |
true, if a value is specified for status, false otherwise.
|
getset |
The list of 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.
|
getset |
The streaming format of the LiveStreamEvent media. This field cannot be modified after live stream creation.
|
getset |
true, if a value is specified for streamingFormat, false otherwise.
|
getset |
The total number of concurrent users expected to watch this live stream across all regions. This attribute is optional and default value is 0.
|
getset |
true, if a value is specified for totalEstimatedConcurrentUsers, false otherwise.
|
getset |
The type of content that should be used to fill the time remaining in the ad break when there are not enough ads to fill the entire break. This value is optional and defaults to AdBreakFillType::SLATE. To set this field a network needs to have the "Live stream ad break underfill type" feature enabled.
|
getset |
true, if a value is specified for underfillAdBreakFillType, false otherwise.
|
getset |
Whether the LiveStreamEvent has an end time. This attribute is optional and defaults to false. If this field is true,
endDateTime is ignored.
|
getset |
true, if a value is specified for unlimitedEndDateTime, false otherwise.
1.8.5 
