Interface DaiSessionOrBuilder (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 interface DaiSessionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAdBreaks(long key)

public abstract boolean containsAdBreaks(long key)

Output only. All DAI ad breaks for this session. Contains information such as ad duration, slate duration, and various ad statuses. Keyed by a unique ID to reference an ad break from a different submessage.

map<int64, .google.ads.admanager.v1.DaiSession.AdBreak> ad_breaks = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
key	long

Returns
Type	Description
boolean

containsAdPods(long key)

public abstract boolean containsAdPods(long key)

Output only. All decisioned ad pods for this session, disregarding serving status. Keyed by a unique ID to reference an ad pod from a different submessage.

map<int64, .google.ads.admanager.v1.DaiSession.AdPod> ad_pods = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
key	long

Returns
Type	Description
boolean

containsAdSelections(long key)

public abstract boolean containsAdSelections(long key)

Output only. The ad requests, ad responses and nested ads in the DAI session.

map<int64, .google.ads.admanager.v1.DaiSession.AdSelection> ad_selections = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
key	long

Returns
Type	Description
boolean

getAdBreaks() (deprecated)

public abstract Map<Long,DaiSession.AdBreak> getAdBreaks()

Use #getAdBreaksMap() instead.

Returns
Type	Description
Map<Long,AdBreak>

getAdBreaksCount()

public abstract int getAdBreaksCount()

Output only. All DAI ad breaks for this session. Contains information such as ad duration, slate duration, and various ad statuses. Keyed by a unique ID to reference an ad break from a different submessage.

map<int64, .google.ads.admanager.v1.DaiSession.AdBreak> ad_breaks = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getAdBreaksMap()

public abstract Map<Long,DaiSession.AdBreak> getAdBreaksMap()

Output only. All DAI ad breaks for this session. Contains information such as ad duration, slate duration, and various ad statuses. Keyed by a unique ID to reference an ad break from a different submessage.

map<int64, .google.ads.admanager.v1.DaiSession.AdBreak> ad_breaks = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Map<Long,AdBreak>

getAdBreaksOrDefault(long key, DaiSession.AdBreak defaultValue)

public abstract DaiSession.AdBreak getAdBreaksOrDefault(long key, DaiSession.AdBreak defaultValue)

Output only. All DAI ad breaks for this session. Contains information such as ad duration, slate duration, and various ad statuses. Keyed by a unique ID to reference an ad break from a different submessage.

map<int64, .google.ads.admanager.v1.DaiSession.AdBreak> ad_breaks = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name	Description
key	long
defaultValue	DaiSession.AdBreak

Returns
Type	Description
DaiSession.AdBreak

getAdBreaksOrThrow(long key)

public abstract DaiSession.AdBreak getAdBreaksOrThrow(long key)

Output only. All DAI ad breaks for this session. Contains information such as ad duration, slate duration, and various ad statuses. Keyed by a unique ID to reference an ad break from a different submessage.

map<int64, .google.ads.admanager.v1.DaiSession.AdBreak> ad_breaks = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
key	long

Returns
Type	Description
DaiSession.AdBreak

getAdPods() (deprecated)

public abstract Map<Long,DaiSession.AdPod> getAdPods()

Use #getAdPodsMap() instead.

Returns
Type	Description
Map<Long,AdPod>

getAdPodsCount()

public abstract int getAdPodsCount()

Output only. All decisioned ad pods for this session, disregarding serving status. Keyed by a unique ID to reference an ad pod from a different submessage.

map<int64, .google.ads.admanager.v1.DaiSession.AdPod> ad_pods = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getAdPodsMap()

public abstract Map<Long,DaiSession.AdPod> getAdPodsMap()

Output only. All decisioned ad pods for this session, disregarding serving status. Keyed by a unique ID to reference an ad pod from a different submessage.

map<int64, .google.ads.admanager.v1.DaiSession.AdPod> ad_pods = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Map<Long,AdPod>

getAdPodsOrDefault(long key, DaiSession.AdPod defaultValue)

public abstract DaiSession.AdPod getAdPodsOrDefault(long key, DaiSession.AdPod defaultValue)

Output only. All decisioned ad pods for this session, disregarding serving status. Keyed by a unique ID to reference an ad pod from a different submessage.

map<int64, .google.ads.admanager.v1.DaiSession.AdPod> ad_pods = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name	Description
key	long
defaultValue	DaiSession.AdPod

Returns
Type	Description
DaiSession.AdPod

getAdPodsOrThrow(long key)

public abstract DaiSession.AdPod getAdPodsOrThrow(long key)

Output only. All decisioned ad pods for this session, disregarding serving status. Keyed by a unique ID to reference an ad pod from a different submessage.

map<int64, .google.ads.admanager.v1.DaiSession.AdPod> ad_pods = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
key	long

Returns
Type	Description
DaiSession.AdPod

getAdSelections() (deprecated)

public abstract Map<Long,DaiSession.AdSelection> getAdSelections()

Use #getAdSelectionsMap() instead.

Returns
Type	Description
Map<Long,AdSelection>

getAdSelectionsCount()

public abstract int getAdSelectionsCount()

Output only. The ad requests, ad responses and nested ads in the DAI session.

map<int64, .google.ads.admanager.v1.DaiSession.AdSelection> ad_selections = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getAdSelectionsMap()

public abstract Map<Long,DaiSession.AdSelection> getAdSelectionsMap()

Output only. The ad requests, ad responses and nested ads in the DAI session.

map<int64, .google.ads.admanager.v1.DaiSession.AdSelection> ad_selections = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Map<Long,AdSelection>

getAdSelectionsOrDefault(long key, DaiSession.AdSelection defaultValue)

public abstract DaiSession.AdSelection getAdSelectionsOrDefault(long key, DaiSession.AdSelection defaultValue)

Output only. The ad requests, ad responses and nested ads in the DAI session.

map<int64, .google.ads.admanager.v1.DaiSession.AdSelection> ad_selections = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name	Description
key	long
defaultValue	DaiSession.AdSelection

Returns
Type	Description
DaiSession.AdSelection

getAdSelectionsOrThrow(long key)

public abstract DaiSession.AdSelection getAdSelectionsOrThrow(long key)

Output only. The ad requests, ad responses and nested ads in the DAI session.

map<int64, .google.ads.admanager.v1.DaiSession.AdSelection> ad_selections = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
key	long

Returns
Type	Description
DaiSession.AdSelection

getCreationContext()

public abstract DaiSession.CreationContext getCreationContext()

Output only. Context data to create the DAI session.

.google.ads.admanager.v1.DaiSession.CreationContext creation_context = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DaiSession.CreationContext	The creationContext.

getCreationContextOrBuilder()

public abstract DaiSession.CreationContextOrBuilder getCreationContextOrBuilder()

Output only. Context data to create the DAI session.

.google.ads.admanager.v1.DaiSession.CreationContext creation_context = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DaiSession.CreationContextOrBuilder

getFindings(int index)

public abstract DaiSession.Finding getFindings(int index)

Output only. Information about errors or notable discoveries that occurred during a session.

repeated .google.ads.admanager.v1.DaiSession.Finding findings = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
DaiSession.Finding

getFindingsCount()

public abstract int getFindingsCount()

Output only. Information about errors or notable discoveries that occurred during a session.

repeated .google.ads.admanager.v1.DaiSession.Finding findings = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getFindingsList()

public abstract List<DaiSession.Finding> getFindingsList()

Output only. Information about errors or notable discoveries that occurred during a session.

repeated .google.ads.admanager.v1.DaiSession.Finding findings = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<Finding>

getFindingsOrBuilder(int index)

public abstract DaiSession.FindingOrBuilder getFindingsOrBuilder(int index)

Output only. Information about errors or notable discoveries that occurred during a session.

repeated .google.ads.admanager.v1.DaiSession.Finding findings = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
DaiSession.FindingOrBuilder

getFindingsOrBuilderList()

public abstract List<? extends DaiSession.FindingOrBuilder> getFindingsOrBuilderList()

Output only. Information about errors or notable discoveries that occurred during a session.

repeated .google.ads.admanager.v1.DaiSession.Finding findings = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<? extends com.google.ads.admanager.v1.DaiSession.FindingOrBuilder>

getName()

public abstract String getName()

Identifier. The resource name of the DaiSession.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. The resource name of the DaiSession.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
ByteString	The bytes for name.

getSessionDuration()

public abstract Duration getSessionDuration()

Output only. The duration of the DAI session, calculated as the difference between the timestamp of DAI's latest recorded event and the timestamp of the session create request.

.google.protobuf.Duration session_duration = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Duration	The sessionDuration.

getSessionDurationOrBuilder()

public abstract DurationOrBuilder getSessionDurationOrBuilder()

Output only. The duration of the DAI session, calculated as the difference between the timestamp of DAI's latest recorded event and the timestamp of the session create request.

.google.protobuf.Duration session_duration = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DurationOrBuilder

getSlate()

public abstract DaiSession.Creative getSlate()

Output only. Slate creative to use in the DAI session for unfilled ad durations.

.google.ads.admanager.v1.DaiSession.Creative slate = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DaiSession.Creative	The slate.

getSlateOrBuilder()

public abstract DaiSession.CreativeOrBuilder getSlateOrBuilder()

Output only. Slate creative to use in the DAI session for unfilled ad durations.

.google.ads.admanager.v1.DaiSession.Creative slate = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DaiSession.CreativeOrBuilder

hasCreationContext()

public abstract boolean hasCreationContext()

Output only. Context data to create the DAI session.

.google.ads.admanager.v1.DaiSession.CreationContext creation_context = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the creationContext field is set.

hasSessionDuration()

public abstract boolean hasSessionDuration()

Output only. The duration of the DAI session, calculated as the difference between the timestamp of DAI's latest recorded event and the timestamp of the session create request.

.google.protobuf.Duration session_duration = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the sessionDuration field is set.

hasSlate()

public abstract boolean hasSlate()

Output only. Slate creative to use in the DAI session for unfilled ad durations.

.google.ads.admanager.v1.DaiSession.Creative slate = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the slate field is set.