Class DaiSession.AdPod (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 final class DaiSession.AdPod extends GeneratedMessage implements DaiSession.AdPodOrBuilder

Information about a single decisioned ad pod in this session. This message pertains to the smallest unit of ads to insert in a session, and might be a pod fragment.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > DaiSession.AdPod

Implements

DaiSession.AdPodOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

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)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

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()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

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()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

AD_BREAK_ID_FIELD_NUMBER

public static final int AD_BREAK_ID_FIELD_NUMBER

Field Value
Type	Description
int

AD_REQUEST_KEY_FIELD_NUMBER

public static final int AD_REQUEST_KEY_FIELD_NUMBER

Field Value
Type	Description
int

CREATIVES_FIELD_NUMBER

public static final int CREATIVES_FIELD_NUMBER

Field Value
Type	Description
int

LABEL_FIELD_NUMBER

public static final int LABEL_FIELD_NUMBER

Field Value
Type	Description
int

PREFETCH_STAGE_FIELD_NUMBER

public static final int PREFETCH_STAGE_FIELD_NUMBER

Field Value
Type	Description
int

REQUESTED_BREAK_TYPE_FIELD_NUMBER

public static final int REQUESTED_BREAK_TYPE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static DaiSession.AdPod getDefaultInstance()

Returns
Type	Description
DaiSession.AdPod

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static DaiSession.AdPod.Builder newBuilder()

Returns
Type	Description
DaiSession.AdPod.Builder

newBuilder(DaiSession.AdPod prototype)

public static DaiSession.AdPod.Builder newBuilder(DaiSession.AdPod prototype)

Parameter
Name	Description
prototype	DaiSession.AdPod

Returns
Type	Description
DaiSession.AdPod.Builder

parseDelimitedFrom(InputStream input)

public static DaiSession.AdPod parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
DaiSession.AdPod

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DaiSession.AdPod parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DaiSession.AdPod

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static DaiSession.AdPod parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
DaiSession.AdPod

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DaiSession.AdPod parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DaiSession.AdPod

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DaiSession.AdPod parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
DaiSession.AdPod

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DaiSession.AdPod parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DaiSession.AdPod

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DaiSession.AdPod parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
DaiSession.AdPod

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DaiSession.AdPod parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DaiSession.AdPod

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static DaiSession.AdPod parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
DaiSession.AdPod

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DaiSession.AdPod parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DaiSession.AdPod

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static DaiSession.AdPod parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
DaiSession.AdPod

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DaiSession.AdPod parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DaiSession.AdPod

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<DaiSession.AdPod> parser()

Returns
Type	Description
Parser<AdPod>

Methods

containsCreatives(long key)

public boolean containsCreatives(long key)

Output only. The creatives in this ad pod. Keyed by a unique ID used to reference this creative from a different submessage.

map<int64, .google.ads.admanager.v1.DaiSession.Creative> creatives = 3 [(.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

AbstractMessage.equals(Object other)

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 = 5 [(.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 = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for adBreakId.

getAdRequestKey()

public long getAdRequestKey()

Output only. Ad request ID that links to the ad request that resulted in this ad pod.

optional int64 ad_request_key = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
long	The adRequestKey.

getCreatives() (deprecated)

public Map<Long,DaiSession.Creative> getCreatives()

Use #getCreativesMap() instead.

Returns
Type	Description
Map<Long,Creative>

getCreativesCount()

public int getCreativesCount()

Output only. The creatives in this ad pod. Keyed by a unique ID used to reference this creative from a different submessage.

map<int64, .google.ads.admanager.v1.DaiSession.Creative> creatives = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getCreativesMap()

public Map<Long,DaiSession.Creative> getCreativesMap()

Output only. The creatives in this ad pod. Keyed by a unique ID used to reference this creative from a different submessage.

map<int64, .google.ads.admanager.v1.DaiSession.Creative> creatives = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Map<Long,Creative>

getCreativesOrDefault(long key, DaiSession.Creative defaultValue)

public DaiSession.Creative getCreativesOrDefault(long key, DaiSession.Creative defaultValue)

Output only. The creatives in this ad pod. Keyed by a unique ID used to reference this creative from a different submessage.

map<int64, .google.ads.admanager.v1.DaiSession.Creative> creatives = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name	Description
key	long
defaultValue	DaiSession.Creative

Returns
Type	Description
DaiSession.Creative

getCreativesOrThrow(long key)

public DaiSession.Creative getCreativesOrThrow(long key)

Output only. The creatives in this ad pod. Keyed by a unique ID used to reference this creative from a different submessage.

map<int64, .google.ads.admanager.v1.DaiSession.Creative> creatives = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
key	long

Returns
Type	Description
DaiSession.Creative

getDefaultInstanceForType()

public DaiSession.AdPod getDefaultInstanceForType()

Returns
Type	Description
DaiSession.AdPod

getLabel()

public String getLabel()

Output only. Descriptive label for this ad pod, used to distinguish ad pods from one another in this session. e.g. "midroll-1", "2".

optional string label = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The label.

getLabelBytes()

public ByteString getLabelBytes()

Output only. Descriptive label for this ad pod, used to distinguish ad pods from one another in this session. e.g. "midroll-1", "2".

optional string label = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for label.

getParserForType()

public Parser<DaiSession.AdPod> getParserForType()

Returns
Type	Description
Parser<AdPod>

Overrides

GeneratedMessage.getParserForType()

getPrefetchStage()

public PrefetchStageTypeEnum.PrefetchStageType getPrefetchStage()

Output only. Indicates the prefetch stage for this ad pod. If prefetch is not enabled this stage is set to the PrefetchStageType.DISABLED value.

optional .google.ads.admanager.v1.PrefetchStageTypeEnum.PrefetchStageType prefetch_stage = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
PrefetchStageTypeEnum.PrefetchStageType	The prefetchStage.

getPrefetchStageValue()

public int getPrefetchStageValue()

Output only. Indicates the prefetch stage for this ad pod. If prefetch is not enabled this stage is set to the PrefetchStageType.DISABLED value.

optional .google.ads.admanager.v1.PrefetchStageTypeEnum.PrefetchStageType prefetch_stage = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getRequestedBreakType()

public BreakTypeEnum.BreakType getRequestedBreakType()

Output only. Type of ad break this ad pod was decisioned for.

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

Returns
Type	Description
BreakTypeEnum.BreakType	The requestedBreakType.

getRequestedBreakTypeValue()

public int getRequestedBreakTypeValue()

Output only. Type of ad break this ad pod was decisioned for.

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

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

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

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 = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the adBreakId field is set.

hasAdRequestKey()

public boolean hasAdRequestKey()

Output only. Ad request ID that links to the ad request that resulted in this ad pod.

optional int64 ad_request_key = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the adRequestKey field is set.

hasLabel()

public boolean hasLabel()

Output only. Descriptive label for this ad pod, used to distinguish ad pods from one another in this session. e.g. "midroll-1", "2".

optional string label = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the label field is set.

hasPrefetchStage()

public boolean hasPrefetchStage()

Output only. Indicates the prefetch stage for this ad pod. If prefetch is not enabled this stage is set to the PrefetchStageType.DISABLED value.

optional .google.ads.admanager.v1.PrefetchStageTypeEnum.PrefetchStageType prefetch_stage = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the prefetchStage field is set.

hasRequestedBreakType()

public boolean hasRequestedBreakType()

Output only. Type of ad break this ad pod was decisioned for.

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

Returns
Type	Description
boolean	Whether the requestedBreakType field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

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

GeneratedMessage.isInitialized()

newBuilderForType()

public DaiSession.AdPod.Builder newBuilderForType()

Returns
Type	Description
DaiSession.AdPod.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected DaiSession.AdPod.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
DaiSession.AdPod.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public DaiSession.AdPod.Builder toBuilder()

Returns
Type	Description
DaiSession.AdPod.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException