public static final class DaiSession.AdPod.Builder extends GeneratedMessage.Builder<DaiSession.AdPod.Builder> implements DaiSession.AdPodOrBuilderInformation 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
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > DaiSession.AdPod.BuilderImplements
DaiSession.AdPodOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public DaiSession.AdPod build()| Returns | |
|---|---|
| Type | Description |
DaiSession.AdPod |
|
buildPartial()
public DaiSession.AdPod buildPartial()| Returns | |
|---|---|
| Type | Description |
DaiSession.AdPod |
|
clear()
public DaiSession.AdPod.Builder clear()| Returns | |
|---|---|
| Type | Description |
DaiSession.AdPod.Builder |
|
clearAdBreakId()
public DaiSession.AdPod.Builder clearAdBreakId()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 |
DaiSession.AdPod.Builder |
This builder for chaining. |
clearAdRequestKey()
public DaiSession.AdPod.Builder clearAdRequestKey()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 |
DaiSession.AdPod.Builder |
This builder for chaining. |
clearCreatives()
public DaiSession.AdPod.Builder clearCreatives()| Returns | |
|---|---|
| Type | Description |
DaiSession.AdPod.Builder |
|
clearLabel()
public DaiSession.AdPod.Builder clearLabel()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 |
DaiSession.AdPod.Builder |
This builder for chaining. |
clearPrefetchStage()
public DaiSession.AdPod.Builder clearPrefetchStage()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 |
DaiSession.AdPod.Builder |
This builder for chaining. |
clearRequestedBreakType()
public DaiSession.AdPod.Builder clearRequestedBreakType()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 |
DaiSession.AdPod.Builder |
This builder for chaining. |
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 |
|
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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getMutableCreatives() (deprecated)
public Map<Long,DaiSession.Creative> getMutableCreatives()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<Long,Creative> |
|
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(DaiSession.AdPod other)
public DaiSession.AdPod.Builder mergeFrom(DaiSession.AdPod other)| Parameter | |
|---|---|
| Name | Description |
other |
DaiSession.AdPod |
| Returns | |
|---|---|
| Type | Description |
DaiSession.AdPod.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public DaiSession.AdPod.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DaiSession.AdPod.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public DaiSession.AdPod.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
DaiSession.AdPod.Builder |
|
putAllCreatives(Map<Long,DaiSession.Creative> values)
public DaiSession.AdPod.Builder putAllCreatives(Map<Long,DaiSession.Creative> values)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 |
values |
Map<Long,Creative> |
| Returns | |
|---|---|
| Type | Description |
DaiSession.AdPod.Builder |
|
putCreatives(long key, DaiSession.Creative value)
public DaiSession.AdPod.Builder putCreatives(long key, DaiSession.Creative value)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 |
value |
DaiSession.Creative |
| Returns | |
|---|---|
| Type | Description |
DaiSession.AdPod.Builder |
|
putCreativesBuilderIfAbsent(long key)
public DaiSession.Creative.Builder putCreativesBuilderIfAbsent(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.Builder |
|
removeCreatives(long key)
public DaiSession.AdPod.Builder removeCreatives(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.AdPod.Builder |
|
setAdBreakId(String value)
public DaiSession.AdPod.Builder setAdBreakId(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe adBreakId to set. |
| Returns | |
|---|---|
| Type | Description |
DaiSession.AdPod.Builder |
This builder for chaining. |
setAdBreakIdBytes(ByteString value)
public DaiSession.AdPod.Builder setAdBreakIdBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for adBreakId to set. |
| Returns | |
|---|---|
| Type | Description |
DaiSession.AdPod.Builder |
This builder for chaining. |
setAdRequestKey(long value)
public DaiSession.AdPod.Builder setAdRequestKey(long value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe adRequestKey to set. |
| Returns | |
|---|---|
| Type | Description |
DaiSession.AdPod.Builder |
This builder for chaining. |
setLabel(String value)
public DaiSession.AdPod.Builder setLabel(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe label to set. |
| Returns | |
|---|---|
| Type | Description |
DaiSession.AdPod.Builder |
This builder for chaining. |
setLabelBytes(ByteString value)
public DaiSession.AdPod.Builder setLabelBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for label to set. |
| Returns | |
|---|---|
| Type | Description |
DaiSession.AdPod.Builder |
This builder for chaining. |
setPrefetchStage(PrefetchStageTypeEnum.PrefetchStageType value)
public DaiSession.AdPod.Builder setPrefetchStage(PrefetchStageTypeEnum.PrefetchStageType value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
PrefetchStageTypeEnum.PrefetchStageTypeThe prefetchStage to set. |
| Returns | |
|---|---|
| Type | Description |
DaiSession.AdPod.Builder |
This builder for chaining. |
setPrefetchStageValue(int value)
public DaiSession.AdPod.Builder setPrefetchStageValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for prefetchStage to set. |
| Returns | |
|---|---|
| Type | Description |
DaiSession.AdPod.Builder |
This builder for chaining. |
setRequestedBreakType(BreakTypeEnum.BreakType value)
public DaiSession.AdPod.Builder setRequestedBreakType(BreakTypeEnum.BreakType value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
BreakTypeEnum.BreakTypeThe requestedBreakType to set. |
| Returns | |
|---|---|
| Type | Description |
DaiSession.AdPod.Builder |
This builder for chaining. |
setRequestedBreakTypeValue(int value)
public DaiSession.AdPod.Builder setRequestedBreakTypeValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for requestedBreakType to set. |
| Returns | |
|---|---|
| Type | Description |
DaiSession.AdPod.Builder |
This builder for chaining. |