Class ViewabilityInfo (0.16.0)

public final class ViewabilityInfo extends GeneratedMessage implements ViewabilityInfoOrBuilder

Details of the viewability of the ad served.

Protobuf type google.ads.datamanager.v1.ViewabilityInfo

Static Fields

MEDIA_DURATION_FIELD_NUMBER

public static final int MEDIA_DURATION_FIELD_NUMBER
Field Value
Type Description
int

MEDIA_QUARTILE_FIELD_NUMBER

public static final int MEDIA_QUARTILE_FIELD_NUMBER
Field Value
Type Description
int

MEDIA_SKIPPABLE_FIELD_NUMBER

public static final int MEDIA_SKIPPABLE_FIELD_NUMBER
Field Value
Type Description
int

MEDIA_VOLUME_PERCENT_FIELD_NUMBER

public static final int MEDIA_VOLUME_PERCENT_FIELD_NUMBER
Field Value
Type Description
int

PLAYBACK_DURATION_FIELD_NUMBER

public static final int PLAYBACK_DURATION_FIELD_NUMBER
Field Value
Type Description
int

VIEWABLE_DURATION_FIELD_NUMBER

public static final int VIEWABLE_DURATION_FIELD_NUMBER
Field Value
Type Description
int

VIEWABLE_PERCENT_FIELD_NUMBER

public static final int VIEWABLE_PERCENT_FIELD_NUMBER
Field Value
Type Description
int

VIEW_TYPE_FIELD_NUMBER

public static final int VIEW_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ViewabilityInfo getDefaultInstance()
Returns
Type Description
ViewabilityInfo

getDescriptor()

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

newBuilder()

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

newBuilder(ViewabilityInfo prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ViewabilityInfo getDefaultInstanceForType()
Returns
Type Description
ViewabilityInfo

getMediaDuration()

public Duration getMediaDuration()

Optional. The duration of the ad media.

.google.protobuf.Duration media_duration = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The mediaDuration.

getMediaDurationOrBuilder()

public DurationOrBuilder getMediaDurationOrBuilder()

Optional. The duration of the ad media.

.google.protobuf.Duration media_duration = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getMediaQuartile()

public MediaQuartile getMediaQuartile()

Optional. The amount of the media that was played as discrete quartiles.

.google.ads.datamanager.v1.MediaQuartile media_quartile = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MediaQuartile

The mediaQuartile.

getMediaQuartileValue()

public int getMediaQuartileValue()

Optional. The amount of the media that was played as discrete quartiles.

.google.ads.datamanager.v1.MediaQuartile media_quartile = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for mediaQuartile.

getMediaSkippable()

public boolean getMediaSkippable()

Optional. Whether the ad media was skippable or not.

bool media_skippable = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The mediaSkippable.

getMediaVolumePercent()

public int getMediaVolumePercent()

Optional. The numerical percent (0-100) of the volume of the media playback.

int32 media_volume_percent = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The mediaVolumePercent.

getParserForType()

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

getPlaybackDuration()

public Duration getPlaybackDuration()

Optional. The duration of playback of the ad media, regardless of whether it was viewable or not.

.google.protobuf.Duration playback_duration = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The playbackDuration.

getPlaybackDurationOrBuilder()

public DurationOrBuilder getPlaybackDurationOrBuilder()

Optional. The duration of playback of the ad media, regardless of whether it was viewable or not.

.google.protobuf.Duration playback_duration = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getViewType()

public ViewType getViewType()

Required. The type of the event.

.google.ads.datamanager.v1.ViewType view_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ViewType

The viewType.

getViewTypeValue()

public int getViewTypeValue()

Required. The type of the event.

.google.ads.datamanager.v1.ViewType view_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for viewType.

getViewableDuration()

public Duration getViewableDuration()

Optional. The amount of time the ad was viewable for.

.google.protobuf.Duration viewable_duration = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The viewableDuration.

getViewableDurationOrBuilder()

public DurationOrBuilder getViewableDurationOrBuilder()

Optional. The amount of time the ad was viewable for.

.google.protobuf.Duration viewable_duration = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getViewablePercent()

public int getViewablePercent()

Optional. The numerical percent (0-100) of the pixels that were viewable.

int32 viewable_percent = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The viewablePercent.

hasMediaDuration()

public boolean hasMediaDuration()

Optional. The duration of the ad media.

.google.protobuf.Duration media_duration = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the mediaDuration field is set.

hasPlaybackDuration()

public boolean hasPlaybackDuration()

Optional. The duration of playback of the ad media, regardless of whether it was viewable or not.

.google.protobuf.Duration playback_duration = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the playbackDuration field is set.

hasViewableDuration()

public boolean hasViewableDuration()

Optional. The amount of time the ad was viewable for.

.google.protobuf.Duration viewable_duration = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the viewableDuration field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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