AdBreak (Ad Manager Axis classes 5.14.0 API)

java.lang.Object
- com.google.api.ads.admanager.axis.v202511.AdBreak

All Implemented Interfaces:

Serializable
```
public class AdBreak
extends Object
implements Serializable
```
Contains debugging information for a single ad break in a stream.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`AdBreak()`
`AdBreak(AdResponse[] rootAdResponses, AdDecisionCreative[] adDecisionCreatives, Integer podNum, Integer linearAbsolutePodNum, Long adBreakDurationMillis, Long filledDurationMillis, Long servedDurationMillis, DateTime startDateTime, Long startTimeOffsetMillis, SamError samError, Integer midrollIndex, Boolean decisionedAds, TrackingEvent[] trackingEvents)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Long`	`getAdBreakDurationMillis()` Gets the adBreakDurationMillis value for this AdBreak.
`AdDecisionCreative[]`	`getAdDecisionCreatives()` Gets the adDecisionCreatives value for this AdBreak.
`AdDecisionCreative`	`getAdDecisionCreatives(int i)`
`Boolean`	`getDecisionedAds()` Gets the decisionedAds value for this AdBreak.
`static org.apache.axis.encoding.Deserializer`	`getDeserializer(String mechType, Class _javaType, QName _xmlType)` Get Custom Deserializer
`Long`	`getFilledDurationMillis()` Gets the filledDurationMillis value for this AdBreak.
`Integer`	`getLinearAbsolutePodNum()` Gets the linearAbsolutePodNum value for this AdBreak.
`Integer`	`getMidrollIndex()` Gets the midrollIndex value for this AdBreak.
`Integer`	`getPodNum()` Gets the podNum value for this AdBreak.
`AdResponse[]`	`getRootAdResponses()` Gets the rootAdResponses value for this AdBreak.
`AdResponse`	`getRootAdResponses(int i)`
`SamError`	`getSamError()` Gets the samError value for this AdBreak.
`static org.apache.axis.encoding.Serializer`	`getSerializer(String mechType, Class _javaType, QName _xmlType)` Get Custom Serializer
`Long`	`getServedDurationMillis()` Gets the servedDurationMillis value for this AdBreak.
`DateTime`	`getStartDateTime()` Gets the startDateTime value for this AdBreak.
`Long`	`getStartTimeOffsetMillis()` Gets the startTimeOffsetMillis value for this AdBreak.
`TrackingEvent[]`	`getTrackingEvents()` Gets the trackingEvents value for this AdBreak.
`TrackingEvent`	`getTrackingEvents(int i)`
`static org.apache.axis.description.TypeDesc`	`getTypeDesc()` Return type metadata object
`int`	`hashCode()`
`void`	`setAdBreakDurationMillis(Long adBreakDurationMillis)` Sets the adBreakDurationMillis value for this AdBreak.
`void`	`setAdDecisionCreatives(AdDecisionCreative[] adDecisionCreatives)` Sets the adDecisionCreatives value for this AdBreak.
`void`	`setAdDecisionCreatives(int i, AdDecisionCreative _value)`
`void`	`setDecisionedAds(Boolean decisionedAds)` Sets the decisionedAds value for this AdBreak.
`void`	`setFilledDurationMillis(Long filledDurationMillis)` Sets the filledDurationMillis value for this AdBreak.
`void`	`setLinearAbsolutePodNum(Integer linearAbsolutePodNum)` Sets the linearAbsolutePodNum value for this AdBreak.
`void`	`setMidrollIndex(Integer midrollIndex)` Sets the midrollIndex value for this AdBreak.
`void`	`setPodNum(Integer podNum)` Sets the podNum value for this AdBreak.
`void`	`setRootAdResponses(AdResponse[] rootAdResponses)` Sets the rootAdResponses value for this AdBreak.
`void`	`setRootAdResponses(int i, AdResponse _value)`
`void`	`setSamError(SamError samError)` Sets the samError value for this AdBreak.
`void`	`setServedDurationMillis(Long servedDurationMillis)` Sets the servedDurationMillis value for this AdBreak.
`void`	`setStartDateTime(DateTime startDateTime)` Sets the startDateTime value for this AdBreak.
`void`	`setStartTimeOffsetMillis(Long startTimeOffsetMillis)` Sets the startTimeOffsetMillis value for this AdBreak.
`void`	`setTrackingEvents(int i, TrackingEvent _value)`
`void`	`setTrackingEvents(TrackingEvent[] trackingEvents)` Sets the trackingEvents value for this AdBreak.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AdBreak
```
public AdBreak()
```
  - AdBreak
```
public AdBreak(AdResponse[] rootAdResponses,
               AdDecisionCreative[] adDecisionCreatives,
               Integer podNum,
               Integer linearAbsolutePodNum,
               Long adBreakDurationMillis,
               Long filledDurationMillis,
               Long servedDurationMillis,
               DateTime startDateTime,
               Long startTimeOffsetMillis,
               SamError samError,
               Integer midrollIndex,
               Boolean decisionedAds,
               TrackingEvent[] trackingEvents)
```
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getRootAdResponses
```
public AdResponse[] getRootAdResponses()
```
    Gets the rootAdResponses value for this AdBreak.
    
    Returns:
    
    rootAdResponses * 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
  - setRootAdResponses
```
public void setRootAdResponses(AdResponse[] rootAdResponses)
```
    Sets the rootAdResponses value for this AdBreak.
    
    Parameters:
    
    rootAdResponses - * 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
  - getRootAdResponses
```
public AdResponse getRootAdResponses(int i)
```
  - setRootAdResponses
```
public void setRootAdResponses(int i,
                               AdResponse _value)
```
  - getAdDecisionCreatives
```
public AdDecisionCreative[] getAdDecisionCreatives()
```
    Gets the adDecisionCreatives value for this AdBreak.
    
    Returns:
    
    adDecisionCreatives * 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.
  - setAdDecisionCreatives
```
public void setAdDecisionCreatives(AdDecisionCreative[] adDecisionCreatives)
```
    Sets the adDecisionCreatives value for this AdBreak.
    
    Parameters:
    
    adDecisionCreatives - * 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.
  - getAdDecisionCreatives
```
public AdDecisionCreative getAdDecisionCreatives(int i)
```
  - setAdDecisionCreatives
```
public void setAdDecisionCreatives(int i,
                                   AdDecisionCreative _value)
```
  - getPodNum
```
public Integer getPodNum()
```
    Gets the podNum value for this AdBreak.
    
    Returns:
    
    podNum * 1-based index of this pod within the whole stream.
  - setPodNum
```
public void setPodNum(Integer podNum)
```
    Sets the podNum value for this AdBreak.
    
    Parameters:
    
    podNum - * 1-based index of this pod within the whole stream.
  - getLinearAbsolutePodNum
```
public Integer getLinearAbsolutePodNum()
```
    Gets the linearAbsolutePodNum value for this AdBreak.
    
    Returns:
    
    linearAbsolutePodNum * Pod number of the ad break, for "ad break specific" records like AdRequest, AdResponse, AdDecision, etc. This field is only used for Linear streams.
  - setLinearAbsolutePodNum
```
public void setLinearAbsolutePodNum(Integer linearAbsolutePodNum)
```
    Sets the linearAbsolutePodNum value for this AdBreak.
    
    Parameters:
    
    linearAbsolutePodNum - * Pod number of the ad break, for "ad break specific" records like AdRequest, AdResponse, AdDecision, etc. This field is only used for Linear streams.
  - getAdBreakDurationMillis
```
public Long getAdBreakDurationMillis()
```
    Gets the adBreakDurationMillis value for this AdBreak.
    
    Returns:
    
    adBreakDurationMillis * The duration in milliseconds of the entire ad break, from when content stops playing until it resumes.
  - setAdBreakDurationMillis
```
public void setAdBreakDurationMillis(Long adBreakDurationMillis)
```
    Sets the adBreakDurationMillis value for this AdBreak.
    
    Parameters:
    
    adBreakDurationMillis - * The duration in milliseconds of the entire ad break, from when content stops playing until it resumes.
  - getFilledDurationMillis
```
public Long getFilledDurationMillis()
```
    Gets the filledDurationMillis value for this AdBreak.
    
    Returns:
    
    filledDurationMillis * 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.
  - setFilledDurationMillis
```
public void setFilledDurationMillis(Long filledDurationMillis)
```
    Sets the filledDurationMillis value for this AdBreak.
    
    Parameters:
    
    filledDurationMillis - * 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.
  - getServedDurationMillis
```
public Long getServedDurationMillis()
```
    Gets the servedDurationMillis value for this AdBreak.
    
    Returns:
    
    servedDurationMillis * 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.
  - setServedDurationMillis
```
public void setServedDurationMillis(Long servedDurationMillis)
```
    Sets the servedDurationMillis value for this AdBreak.
    
    Parameters:
    
    servedDurationMillis - * 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.
  - getStartDateTime
```
public DateTime getStartDateTime()
```
    Gets the startDateTime value for this AdBreak.
    
    Returns:
    
    startDateTime * The date and time this ad break started (the time the ad request was made).
  - setStartDateTime
```
public void setStartDateTime(DateTime startDateTime)
```
    Sets the startDateTime value for this AdBreak.
    
    Parameters:
    
    startDateTime - * The date and time this ad break started (the time the ad request was made).
  - getStartTimeOffsetMillis
```
public Long getStartTimeOffsetMillis()
```
    Gets the startTimeOffsetMillis value for this AdBreak.
    
    Returns:
    
    startTimeOffsetMillis * The offset of the ad break within the content in milliseconds. Used for VOD sessions only.
  - setStartTimeOffsetMillis
```
public void setStartTimeOffsetMillis(Long startTimeOffsetMillis)
```
    Sets the startTimeOffsetMillis value for this AdBreak.
    
    Parameters:
    
    startTimeOffsetMillis - * The offset of the ad break within the content in milliseconds. Used for VOD sessions only.
  - getSamError
```
public SamError getSamError()
```
    Gets the samError value for this AdBreak.
    
    Returns:
    
    samError * Any error that occurred while attempting to stitch the ad break into the stream.
  - setSamError
```
public void setSamError(SamError samError)
```
    Sets the samError value for this AdBreak.
    
    Parameters:
    
    samError - * Any error that occurred while attempting to stitch the ad break into the stream.
  - getMidrollIndex
```
public Integer getMidrollIndex()
```
    Gets the midrollIndex value for this AdBreak.
    
    Returns:
    
    midrollIndex * For break type MIDROLL, the 1-based index of the mid-roll position. Only applies to VOD VMAP ad breaks.
  - setMidrollIndex
```
public void setMidrollIndex(Integer midrollIndex)
```
    Sets the midrollIndex value for this AdBreak.
    
    Parameters:
    
    midrollIndex - * For break type MIDROLL, the 1-based index of the mid-roll position. Only applies to VOD VMAP ad breaks.
  - getDecisionedAds
```
public Boolean getDecisionedAds()
```
    Gets the decisionedAds value for this AdBreak.
    
    Returns:
    
    decisionedAds * Whether ads were decisioned for this ad break.
  - setDecisionedAds
```
public void setDecisionedAds(Boolean decisionedAds)
```
    Sets the decisionedAds value for this AdBreak.
    
    Parameters:
    
    decisionedAds - * Whether ads were decisioned for this ad break.
  - getTrackingEvents
```
public TrackingEvent[] getTrackingEvents()
```
    Gets the trackingEvents value for this AdBreak.
    
    Returns:
    
    trackingEvents * The list of tracking events associated with this ad break.
  - setTrackingEvents
```
public void setTrackingEvents(TrackingEvent[] trackingEvents)
```
    Sets the trackingEvents value for this AdBreak.
    
    Parameters:
    
    trackingEvents - * The list of tracking events associated with this ad break.
  - getTrackingEvents
```
public TrackingEvent getTrackingEvents(int i)
```
  - setTrackingEvents
```
public void setTrackingEvents(int i,
                              TrackingEvent _value)
```
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getTypeDesc
```
public static org.apache.axis.description.TypeDesc getTypeDesc()
```
    Return type metadata object
  - getSerializer
```
public static org.apache.axis.encoding.Serializer getSerializer(String mechType,
                                                                Class _javaType,
                                                                QName _xmlType)
```
    Get Custom Serializer
  - getDeserializer
```
public static org.apache.axis.encoding.Deserializer getDeserializer(String mechType,
                                                                    Class _javaType,
                                                                    QName _xmlType)
```
    Get Custom Deserializer

Class AdBreak

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AdBreak

AdBreak

Method Detail

toString

getRootAdResponses

setRootAdResponses

getRootAdResponses

setRootAdResponses

getAdDecisionCreatives

setAdDecisionCreatives

getAdDecisionCreatives

setAdDecisionCreatives

getPodNum

setPodNum

getLinearAbsolutePodNum

setLinearAbsolutePodNum

getAdBreakDurationMillis

setAdBreakDurationMillis

getFilledDurationMillis

setFilledDurationMillis

getServedDurationMillis

setServedDurationMillis

getStartDateTime

setStartDateTime

getStartTimeOffsetMillis

setStartTimeOffsetMillis

getSamError

setSamError

getMidrollIndex

setMidrollIndex

getDecisionedAds

setDecisionedAds

getTrackingEvents

setTrackingEvents

getTrackingEvents

setTrackingEvents

equals

hashCode

getTypeDesc

getSerializer

getDeserializer