Class DaiSession (0.58.0)

public final class DaiSession extends GeneratedMessage implements DaiSessionOrBuilder

Representation of an individual Dynamic Ad Insertion (DAI) session watching a LiveStream resource or VOD Content resource. Use the Stream Activity Monitor (SAM) on the Google Ad Manager UI to look up this session. For details, see Locate a DAI session ID or debug key.

Protobuf type google.ads.admanager.v1.DaiSession

Implements

DaiSessionOrBuilder

Static Fields

AD_BREAKS_FIELD_NUMBER

public static final int AD_BREAKS_FIELD_NUMBER
Field Value
Type Description
int

AD_PODS_FIELD_NUMBER

public static final int AD_PODS_FIELD_NUMBER
Field Value
Type Description
int

AD_SELECTIONS_FIELD_NUMBER

public static final int AD_SELECTIONS_FIELD_NUMBER
Field Value
Type Description
int

CREATION_CONTEXT_FIELD_NUMBER

public static final int CREATION_CONTEXT_FIELD_NUMBER
Field Value
Type Description
int

FINDINGS_FIELD_NUMBER

public static final int FINDINGS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SESSION_DURATION_FIELD_NUMBER

public static final int SESSION_DURATION_FIELD_NUMBER
Field Value
Type Description
int

SLATE_FIELD_NUMBER

public static final int SLATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DaiSession getDefaultInstance()
Returns
Type Description
DaiSession

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DaiSession.Builder newBuilder()
Returns
Type Description
DaiSession.Builder

newBuilder(DaiSession prototype)

public static DaiSession.Builder newBuilder(DaiSession prototype)
Parameter
Name Description
prototype DaiSession
Returns
Type Description
DaiSession.Builder

parseDelimitedFrom(InputStream input)

public static DaiSession parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DaiSession
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DaiSession parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiSession
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DaiSession parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DaiSession
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DaiSession parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiSession
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DaiSession parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DaiSession
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DaiSession parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiSession
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DaiSession parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DaiSession
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DaiSession parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiSession
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DaiSession parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DaiSession
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DaiSession parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiSession
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DaiSession parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DaiSession
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DaiSession parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiSession
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DaiSession> parser()
Returns
Type Description
Parser<DaiSession>

Methods

containsAdBreaks(long key)

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAdBreaks() (deprecated)

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

Use #getAdBreaksMap() instead.

Returns
Type Description
Map<Long,AdBreak>

getAdBreaksCount()

public 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 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 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 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 Map<Long,DaiSession.AdPod> getAdPods()

Use #getAdPodsMap() instead.

Returns
Type Description
Map<Long,AdPod>

getAdPodsCount()

public 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 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 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 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 Map<Long,DaiSession.AdSelection> getAdSelections()

Use #getAdSelectionsMap() instead.

Returns
Type Description
Map<Long,AdSelection>

getAdSelectionsCount()

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

getDefaultInstanceForType()

public DaiSession getDefaultInstanceForType()
Returns
Type Description
DaiSession

getFindings(int index)

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

getParserForType()

public Parser<DaiSession> getParserForType()
Returns
Type Description
Parser<DaiSession>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSessionDuration()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
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()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DaiSession.Builder newBuilderForType()
Returns
Type Description
DaiSession.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected DaiSession.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DaiSession.Builder
Overrides

toBuilder()

public DaiSession.Builder toBuilder()
Returns
Type Description
DaiSession.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException