Interface DaiSession.AdBreakOrBuilder (0.58.0)

0.58.0 (latest) 0.54.0 0.53.0 0.52.0 0.50.0 0.47.0 0.46.0 0.44.0 0.42.0 0.41.0 0.40.0 0.39.0 0.37.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.29.0 0.27.0 0.26.0 0.23.0 0.22.0 0.21.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public static interface DaiSession.AdBreakOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsTrackingPings(long key)

public abstract boolean containsTrackingPings(long key)

Output only. Tracking pings that were issued for this break. Keyed by a unique ID to reference this tracking ping from a different submessage.

map<int64, .google.ads.admanager.v1.DaiSession.AdBreak.TrackingPing> tracking_pings = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
key	long

Returns
Type	Description
boolean

getAdBreakId()

public abstract String getAdBreakId()

Output only. Publisher-provided or DAI-generated break ID for the Ad break API or pod serving API.

optional string ad_break_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The adBreakId.

getAdBreakIdBytes()

public abstract ByteString getAdBreakIdBytes()

Output only. Publisher-provided or DAI-generated break ID for the Ad break API or pod serving API.

optional string ad_break_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for adBreakId.

getBreakSequence()

public abstract long getBreakSequence()

Output only. The index of this ad break in the session.

optional int64 break_sequence = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
long	The breakSequence.

getBreakType()

public abstract BreakTypeEnum.BreakType getBreakType()

Output only. Type of break this represents.

optional .google.ads.admanager.v1.BreakTypeEnum.BreakType break_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
BreakTypeEnum.BreakType	The breakType.

getBreakTypeValue()

public abstract int getBreakTypeValue()

Output only. Type of break this represents.

optional .google.ads.admanager.v1.BreakTypeEnum.BreakType break_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for breakType.

getExecutedBreakDuration()

public abstract Duration getExecutedBreakDuration()

Output only. The total duration of the break as it was served by DAI. In VOD, this value is the duration of ads inserted in between content. In linear, this value is the duration between cue out and cue in.

.google.protobuf.Duration executed_break_duration = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Duration	The executedBreakDuration.

getExecutedBreakDurationOrBuilder()

public abstract DurationOrBuilder getExecutedBreakDurationOrBuilder()

Output only. The total duration of the break as it was served by DAI. In VOD, this value is the duration of ads inserted in between content. In linear, this value is the duration between cue out and cue in.

.google.protobuf.Duration executed_break_duration = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DurationOrBuilder

getLinear()

public abstract DaiSession.AdBreak.LinearBreak getLinear()

Output only. Information on the break for a linear session.

.google.ads.admanager.v1.DaiSession.AdBreak.LinearBreak linear = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DaiSession.AdBreak.LinearBreak	The linear.

getLinearOrBuilder()

public abstract DaiSession.AdBreak.LinearBreakOrBuilder getLinearOrBuilder()

Output only. Information on the break for a linear session.

.google.ads.admanager.v1.DaiSession.AdBreak.LinearBreak linear = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DaiSession.AdBreak.LinearBreakOrBuilder

getPodKeys(int index)

public abstract long getPodKeys(int index)

Output only. Ad pod ID that links to one or more decisioned ad pods for this break. Most types of sessions will have a single pod key, but in the case of prefetched pods there will be two pod keys.

repeated int64 pod_keys = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
long	The podKeys at the given index.

getPodKeysCount()

public abstract int getPodKeysCount()

Output only. Ad pod ID that links to one or more decisioned ad pods for this break. Most types of sessions will have a single pod key, but in the case of prefetched pods there will be two pod keys.

repeated int64 pod_keys = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The count of podKeys.

getPodKeysList()

public abstract List<Long> getPodKeysList()

Output only. Ad pod ID that links to one or more decisioned ad pods for this break. Most types of sessions will have a single pod key, but in the case of prefetched pods there will be two pod keys.

repeated int64 pod_keys = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<Long>	A list containing the podKeys.

getServedAdsDuration()

public abstract Duration getServedAdsDuration()

Output only. The duration of ads that were inserted for this break.

.google.protobuf.Duration served_ads_duration = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Duration	The servedAdsDuration.

getServedAdsDurationOrBuilder()

public abstract DurationOrBuilder getServedAdsDurationOrBuilder()

Output only. The duration of ads that were inserted for this break.

.google.protobuf.Duration served_ads_duration = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DurationOrBuilder

getStreamTypeInfoCase()

public abstract DaiSession.AdBreak.StreamTypeInfoCase getStreamTypeInfoCase()

Returns
Type	Description
DaiSession.AdBreak.StreamTypeInfoCase

getTrackingPings() (deprecated)

public abstract Map<Long,DaiSession.AdBreak.TrackingPing> getTrackingPings()

Use #getTrackingPingsMap() instead.

Returns
Type	Description
Map<Long,TrackingPing>

getTrackingPingsCount()

public abstract int getTrackingPingsCount()

Output only. Tracking pings that were issued for this break. Keyed by a unique ID to reference this tracking ping from a different submessage.

map<int64, .google.ads.admanager.v1.DaiSession.AdBreak.TrackingPing> tracking_pings = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getTrackingPingsMap()

public abstract Map<Long,DaiSession.AdBreak.TrackingPing> getTrackingPingsMap()

Output only. Tracking pings that were issued for this break. Keyed by a unique ID to reference this tracking ping from a different submessage.

map<int64, .google.ads.admanager.v1.DaiSession.AdBreak.TrackingPing> tracking_pings = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Map<Long,TrackingPing>

getTrackingPingsOrDefault(long key, DaiSession.AdBreak.TrackingPing defaultValue)

public abstract DaiSession.AdBreak.TrackingPing getTrackingPingsOrDefault(long key, DaiSession.AdBreak.TrackingPing defaultValue)

Output only. Tracking pings that were issued for this break. Keyed by a unique ID to reference this tracking ping from a different submessage.

map<int64, .google.ads.admanager.v1.DaiSession.AdBreak.TrackingPing> tracking_pings = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name	Description
key	long
defaultValue	DaiSession.AdBreak.TrackingPing

Returns
Type	Description
DaiSession.AdBreak.TrackingPing

getTrackingPingsOrThrow(long key)

public abstract DaiSession.AdBreak.TrackingPing getTrackingPingsOrThrow(long key)

Output only. Tracking pings that were issued for this break. Keyed by a unique ID to reference this tracking ping from a different submessage.

map<int64, .google.ads.admanager.v1.DaiSession.AdBreak.TrackingPing> tracking_pings = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
key	long

Returns
Type	Description
DaiSession.AdBreak.TrackingPing

getVod()

public abstract DaiSession.AdBreak.VodBreak getVod()

Output only. Information on the break for a VOD session.

.google.ads.admanager.v1.DaiSession.AdBreak.VodBreak vod = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DaiSession.AdBreak.VodBreak	The vod.

getVodOrBuilder()

public abstract DaiSession.AdBreak.VodBreakOrBuilder getVodOrBuilder()

Output only. Information on the break for a VOD session.

.google.ads.admanager.v1.DaiSession.AdBreak.VodBreak vod = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DaiSession.AdBreak.VodBreakOrBuilder

hasAdBreakId()

public abstract boolean hasAdBreakId()

Output only. Publisher-provided or DAI-generated break ID for the Ad break API or pod serving API.

optional string ad_break_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the adBreakId field is set.

hasBreakSequence()

public abstract boolean hasBreakSequence()

Output only. The index of this ad break in the session.

optional int64 break_sequence = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the breakSequence field is set.

hasBreakType()

public abstract boolean hasBreakType()

Output only. Type of break this represents.

optional .google.ads.admanager.v1.BreakTypeEnum.BreakType break_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the breakType field is set.

hasExecutedBreakDuration()

public abstract boolean hasExecutedBreakDuration()

Output only. The total duration of the break as it was served by DAI. In VOD, this value is the duration of ads inserted in between content. In linear, this value is the duration between cue out and cue in.

.google.protobuf.Duration executed_break_duration = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the executedBreakDuration field is set.

hasLinear()

public abstract boolean hasLinear()

Output only. Information on the break for a linear session.

.google.ads.admanager.v1.DaiSession.AdBreak.LinearBreak linear = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the linear field is set.

hasServedAdsDuration()

public abstract boolean hasServedAdsDuration()

Output only. The duration of ads that were inserted for this break.

.google.protobuf.Duration served_ads_duration = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the servedAdsDuration field is set.

hasVod()

public abstract boolean hasVod()

Output only. Information on the break for a VOD session.

.google.ads.admanager.v1.DaiSession.AdBreak.VodBreak vod = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the vod field is set.