Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdManager.v202508.AdBreak Class Reference

Contains debugging information for a single ad break in a stream. More...

Properties

AdResponse[] rootAdResponses [get, set]
 The root ad responses to the More...
 
AdDecisionCreative[] adDecisionCreatives [get, set]
 Contains information about the creatives that were served in the ad break, such as the ad system that served them and whether they were transcoded by Truman already. More...
 
int podNum [get, set]
 1-based index of this pod within the whole stream. More...
 
bool podNumSpecified [get, set]
 
int linearAbsolutePodNum [get, set]
 Pod number of the ad break, for "ad break specific" records like AdRequest, AdResponse, AdDecision, etc. This field is only used for Linear streams. More...
 
bool linearAbsolutePodNumSpecified [get, set]
 
long adBreakDurationMillis [get, set]
 The duration in milliseconds of the entire ad break, from when content stops playing until it resumes. More...
 
bool adBreakDurationMillisSpecified [get, set]
 
long filledDurationMillis [get, set]
 The sum of the durations in milliseconds of the ads within this ad break. More...
 
bool filledDurationMillisSpecified [get, set]
 
long servedDurationMillis [get, set]
 The amount of ad time in milliseconds a user actually sees. More...
 
bool servedDurationMillisSpecified [get, set]
 
DateTime startDateTime [get, set]
 The date and time this ad break started (the time the ad request was made). More...
 
long startTimeOffsetMillis [get, set]
 The offset of the ad break within the content in milliseconds. Used for VOD sessions only. More...
 
bool startTimeOffsetMillisSpecified [get, set]
 
SamError samError [get, set]
 Any error that occurred while attempting to stitch the ad break into the stream. More...
 
int midrollIndex [get, set]
 For break type MIDROLL, the 1-based index of the mid-roll position. Only applies to VOD VMAP ad breaks. More...
 
bool midrollIndexSpecified [get, set]
 
bool decisionedAds [get, set]
 Whether ads were decisioned for this ad break. More...
 
bool decisionedAdsSpecified [get, set]
 
TrackingEventPing[][] trackingEvents [get, set]
 The list of tracking events associated with this ad break. More...
 

Detailed Description

Contains debugging information for a single ad break in a stream.

Property Documentation

long Google.Api.Ads.AdManager.v202508.AdBreak.adBreakDurationMillis
getset

The duration in milliseconds of the entire ad break, from when content stops playing until it resumes.

bool Google.Api.Ads.AdManager.v202508.AdBreak.adBreakDurationMillisSpecified
getset

true, if a value is specified for adBreakDurationMillis, false otherwise.

AdDecisionCreative [] Google.Api.Ads.AdManager.v202508.AdBreak.adDecisionCreatives
getset

Contains information about the creatives that were served in the ad break, such as the ad system that served them and whether they were transcoded by Truman already.

bool Google.Api.Ads.AdManager.v202508.AdBreak.decisionedAds
getset

Whether ads were decisioned for this ad break.

bool Google.Api.Ads.AdManager.v202508.AdBreak.decisionedAdsSpecified
getset

true, if a value is specified for decisionedAds, false otherwise.

long Google.Api.Ads.AdManager.v202508.AdBreak.filledDurationMillis
getset

The sum of the durations in milliseconds of the ads within this ad break.

If the ad break is 60 seconds and two 25 second ads are returned in an ad response the filled time would be 50000 milliseconds.

bool Google.Api.Ads.AdManager.v202508.AdBreak.filledDurationMillisSpecified
getset

true, if a value is specified for filledDurationMillis, false otherwise.

int Google.Api.Ads.AdManager.v202508.AdBreak.linearAbsolutePodNum
getset

Pod number of the ad break, for "ad break specific" records like AdRequest, AdResponse, AdDecision, etc. This field is only used for Linear streams.

bool Google.Api.Ads.AdManager.v202508.AdBreak.linearAbsolutePodNumSpecified
getset

true, if a value is specified for linearAbsolutePodNum, false otherwise.

int Google.Api.Ads.AdManager.v202508.AdBreak.midrollIndex
getset

For break type MIDROLL, the 1-based index of the mid-roll position. Only applies to VOD VMAP ad breaks.

bool Google.Api.Ads.AdManager.v202508.AdBreak.midrollIndexSpecified
getset

true, if a value is specified for midrollIndex, false otherwise.

int Google.Api.Ads.AdManager.v202508.AdBreak.podNum
getset

1-based index of this pod within the whole stream.

bool Google.Api.Ads.AdManager.v202508.AdBreak.podNumSpecified
getset

true, if a value is specified for podNum, false otherwise.

AdResponse [] Google.Api.Ads.AdManager.v202508.AdBreak.rootAdResponses
getset

The root ad responses to the

adRequest. If this is a staged request, there may be two root ad responses - one for the prefetch stage and another if there is a follow up request at the ad break.

A VAST redirect response triggers another ad request (that is not recorded), and thus a response for that request, which is why there can be multiple ad responses nested within an ad response.

For more information, see https://support.google.com/admanager/answer/7009058

SamError Google.Api.Ads.AdManager.v202508.AdBreak.samError
getset

Any error that occurred while attempting to stitch the ad break into the stream.

long Google.Api.Ads.AdManager.v202508.AdBreak.servedDurationMillis
getset

The amount of ad time in milliseconds a user actually sees.

If the ad break is 60 seconds and two 25 second ads are returned but one of these ads wasn't transcoded so a slate was used, the served time would be 25 seconds.

bool Google.Api.Ads.AdManager.v202508.AdBreak.servedDurationMillisSpecified
getset

true, if a value is specified for servedDurationMillis, false otherwise.

DateTime Google.Api.Ads.AdManager.v202508.AdBreak.startDateTime
getset

The date and time this ad break started (the time the ad request was made).

long Google.Api.Ads.AdManager.v202508.AdBreak.startTimeOffsetMillis
getset

The offset of the ad break within the content in milliseconds. Used for VOD sessions only.

bool Google.Api.Ads.AdManager.v202508.AdBreak.startTimeOffsetMillisSpecified
getset

true, if a value is specified for startTimeOffsetMillis, false otherwise.

TrackingEventPing [][] Google.Api.Ads.AdManager.v202508.AdBreak.trackingEvents
getset

The list of tracking events associated with this ad break.


The documentation for this class was generated from the following file: