Interface DaiSession.AdPodOrBuilder (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.AdPodOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsCreatives(long key)

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

Returns
Type	Description
ByteString	The bytes for adBreakId.

getAdRequestKey()

public abstract 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 abstract Map<Long,DaiSession.Creative> getCreatives()

Use #getCreativesMap() instead.

Returns
Type	Description
Map<Long,Creative>

getCreativesCount()

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

getLabel()

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

getPrefetchStage()

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

Returns
Type	Description
boolean	Whether the adBreakId field is set.

hasAdRequestKey()

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