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
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static DaiSession.AdBreak.Builder newBuilder()
newBuilder(DaiSession.AdBreak prototype)
public static DaiSession.AdBreak.Builder newBuilder(DaiSession.AdBreak prototype)
public static DaiSession.AdBreak parseDelimitedFrom(InputStream input)
public static DaiSession.AdBreak parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static DaiSession.AdBreak parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DaiSession.AdBreak parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static DaiSession.AdBreak parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DaiSession.AdBreak parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DaiSession.AdBreak parseFrom(CodedInputStream input)
public static DaiSession.AdBreak parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DaiSession.AdBreak parseFrom(InputStream input)
public static DaiSession.AdBreak parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static DaiSession.AdBreak parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DaiSession.AdBreak parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<DaiSession.AdBreak> parser()
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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];
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()
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];
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];
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];
getParserForType()
public Parser<DaiSession.AdBreak> getParserForType()
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];
getStreamTypeInfoCase()
public DaiSession.AdBreak.StreamTypeInfoCase getStreamTypeInfoCase()
getTrackingPings() (deprecated)
public Map<Long,DaiSession.AdBreak.TrackingPing> getTrackingPings()
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];
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];
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
|
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];
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];
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()
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
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()
Overrides
newBuilderForType()
public DaiSession.AdBreak.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected DaiSession.AdBreak.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public DaiSession.AdBreak.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides