Class DaiSession.AdBreak (0.58.0)

public static final class DaiSession.AdBreak extends GeneratedMessage implements DaiSession.AdBreakOrBuilder

Information about an ad break in this session. Includes statuses such as ad and slate durations.

Protobuf type google.ads.admanager.v1.DaiSession.AdBreak

Static Fields

AD_BREAK_ID_FIELD_NUMBER

public static final int AD_BREAK_ID_FIELD_NUMBER
Field Value
Type Description
int

BREAK_SEQUENCE_FIELD_NUMBER

public static final int BREAK_SEQUENCE_FIELD_NUMBER
Field Value
Type Description
int

BREAK_TYPE_FIELD_NUMBER

public static final int BREAK_TYPE_FIELD_NUMBER
Field Value
Type Description
int

EXECUTED_BREAK_DURATION_FIELD_NUMBER

public static final int EXECUTED_BREAK_DURATION_FIELD_NUMBER
Field Value
Type Description
int

LINEAR_FIELD_NUMBER

public static final int LINEAR_FIELD_NUMBER
Field Value
Type Description
int

POD_KEYS_FIELD_NUMBER

public static final int POD_KEYS_FIELD_NUMBER
Field Value
Type Description
int

SERVED_ADS_DURATION_FIELD_NUMBER

public static final int SERVED_ADS_DURATION_FIELD_NUMBER
Field Value
Type Description
int

TRACKING_PINGS_FIELD_NUMBER

public static final int TRACKING_PINGS_FIELD_NUMBER
Field Value
Type Description
int

VOD_FIELD_NUMBER

public static final int VOD_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DaiSession.AdBreak getDefaultInstance()
Returns
Type Description
DaiSession.AdBreak

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DaiSession.AdBreak.Builder newBuilder()
Returns
Type Description
DaiSession.AdBreak.Builder

newBuilder(DaiSession.AdBreak prototype)

public static DaiSession.AdBreak.Builder newBuilder(DaiSession.AdBreak prototype)
Parameter
Name Description
prototype DaiSession.AdBreak
Returns
Type Description
DaiSession.AdBreak.Builder

parseDelimitedFrom(InputStream input)

public static DaiSession.AdBreak parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DaiSession.AdBreak
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DaiSession.AdBreak parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiSession.AdBreak
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DaiSession.AdBreak parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DaiSession.AdBreak
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DaiSession.AdBreak parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiSession.AdBreak
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DaiSession.AdBreak parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DaiSession.AdBreak
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DaiSession.AdBreak parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiSession.AdBreak
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DaiSession.AdBreak parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DaiSession.AdBreak
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DaiSession.AdBreak parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiSession.AdBreak
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DaiSession.AdBreak parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DaiSession.AdBreak
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DaiSession.AdBreak parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiSession.AdBreak
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DaiSession.AdBreak parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DaiSession.AdBreak
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DaiSession.AdBreak parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiSession.AdBreak
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DaiSession.AdBreak> parser()
Returns
Type Description
Parser<AdBreak>

Methods

containsTrackingPings(long key)

public 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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAdBreakId()

public 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 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 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 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 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.

getDefaultInstanceForType()

public DaiSession.AdBreak getDefaultInstanceForType()
Returns
Type Description
DaiSession.AdBreak

getExecutedBreakDuration()

public 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 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 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 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

getParserForType()

public Parser<DaiSession.AdBreak> getParserForType()
Returns
Type Description
Parser<AdBreak>
Overrides

getPodKeys(int index)

public 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 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 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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServedAdsDuration()

public 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 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 DaiSession.AdBreak.StreamTypeInfoCase getStreamTypeInfoCase()
Returns
Type Description
DaiSession.AdBreak.StreamTypeInfoCase

getTrackingPings() (deprecated)

public Map<Long,DaiSession.AdBreak.TrackingPing> getTrackingPings()
Returns
Type Description
Map<Long,TrackingPing>

getTrackingPingsCount()

public 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 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 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 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 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 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 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 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 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 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 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DaiSession.AdBreak.Builder newBuilderForType()
Returns
Type Description
DaiSession.AdBreak.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected DaiSession.AdBreak.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DaiSession.AdBreak.Builder
Overrides

toBuilder()

public DaiSession.AdBreak.Builder toBuilder()
Returns
Type Description
DaiSession.AdBreak.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException