Class ViewabilityInfo.Builder (0.16.0)

public static final class ViewabilityInfo.Builder extends GeneratedMessage.Builder<ViewabilityInfo.Builder> implements ViewabilityInfoOrBuilder

Details of the viewability of the ad served.

Protobuf type google.ads.datamanager.v1.ViewabilityInfo

Static Methods

getDescriptor()

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

Methods

build()

public ViewabilityInfo build()
Returns
Type Description
ViewabilityInfo

buildPartial()

public ViewabilityInfo buildPartial()
Returns
Type Description
ViewabilityInfo

clear()

public ViewabilityInfo.Builder clear()
Returns
Type Description
ViewabilityInfo.Builder
Overrides

clearMediaDuration()

public ViewabilityInfo.Builder clearMediaDuration()

Optional. The duration of the ad media.

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

Returns
Type Description
ViewabilityInfo.Builder

clearMediaQuartile()

public ViewabilityInfo.Builder clearMediaQuartile()

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
ViewabilityInfo.Builder

This builder for chaining.

clearMediaSkippable()

public ViewabilityInfo.Builder clearMediaSkippable()

Optional. Whether the ad media was skippable or not.

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

Returns
Type Description
ViewabilityInfo.Builder

This builder for chaining.

clearMediaVolumePercent()

public ViewabilityInfo.Builder clearMediaVolumePercent()

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
ViewabilityInfo.Builder

This builder for chaining.

clearPlaybackDuration()

public ViewabilityInfo.Builder clearPlaybackDuration()

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
ViewabilityInfo.Builder

clearViewType()

public ViewabilityInfo.Builder clearViewType()

Required. The type of the event.

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

Returns
Type Description
ViewabilityInfo.Builder

This builder for chaining.

clearViewableDuration()

public ViewabilityInfo.Builder clearViewableDuration()

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

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

Returns
Type Description
ViewabilityInfo.Builder

clearViewablePercent()

public ViewabilityInfo.Builder clearViewablePercent()

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

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

Returns
Type Description
ViewabilityInfo.Builder

This builder for chaining.

getDefaultInstanceForType()

public ViewabilityInfo getDefaultInstanceForType()
Returns
Type Description
ViewabilityInfo

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getMediaDurationBuilder()

public Duration.Builder getMediaDurationBuilder()

Optional. The duration of the ad media.

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

Returns
Type Description
Builder

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.

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.

getPlaybackDurationBuilder()

public Duration.Builder getPlaybackDurationBuilder()

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
Builder

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

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.

getViewableDurationBuilder()

public Duration.Builder getViewableDurationBuilder()

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

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

Returns
Type Description
Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ViewabilityInfo other)

public ViewabilityInfo.Builder mergeFrom(ViewabilityInfo other)
Parameter
Name Description
other ViewabilityInfo
Returns
Type Description
ViewabilityInfo.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ViewabilityInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ViewabilityInfo.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ViewabilityInfo.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ViewabilityInfo.Builder
Overrides

mergeMediaDuration(Duration value)

public ViewabilityInfo.Builder mergeMediaDuration(Duration value)

Optional. The duration of the ad media.

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

Parameter
Name Description
value Duration
Returns
Type Description
ViewabilityInfo.Builder

mergePlaybackDuration(Duration value)

public ViewabilityInfo.Builder mergePlaybackDuration(Duration value)

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];

Parameter
Name Description
value Duration
Returns
Type Description
ViewabilityInfo.Builder

mergeViewableDuration(Duration value)

public ViewabilityInfo.Builder mergeViewableDuration(Duration value)

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

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

Parameter
Name Description
value Duration
Returns
Type Description
ViewabilityInfo.Builder

setMediaDuration(Duration value)

public ViewabilityInfo.Builder setMediaDuration(Duration value)

Optional. The duration of the ad media.

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

Parameter
Name Description
value Duration
Returns
Type Description
ViewabilityInfo.Builder

setMediaDuration(Duration.Builder builderForValue)

public ViewabilityInfo.Builder setMediaDuration(Duration.Builder builderForValue)

Optional. The duration of the ad media.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ViewabilityInfo.Builder

setMediaQuartile(MediaQuartile value)

public ViewabilityInfo.Builder setMediaQuartile(MediaQuartile value)

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];

Parameter
Name Description
value MediaQuartile

The mediaQuartile to set.

Returns
Type Description
ViewabilityInfo.Builder

This builder for chaining.

setMediaQuartileValue(int value)

public ViewabilityInfo.Builder setMediaQuartileValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for mediaQuartile to set.

Returns
Type Description
ViewabilityInfo.Builder

This builder for chaining.

setMediaSkippable(boolean value)

public ViewabilityInfo.Builder setMediaSkippable(boolean value)

Optional. Whether the ad media was skippable or not.

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

Parameter
Name Description
value boolean

The mediaSkippable to set.

Returns
Type Description
ViewabilityInfo.Builder

This builder for chaining.

setMediaVolumePercent(int value)

public ViewabilityInfo.Builder setMediaVolumePercent(int value)

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

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

Parameter
Name Description
value int

The mediaVolumePercent to set.

Returns
Type Description
ViewabilityInfo.Builder

This builder for chaining.

setPlaybackDuration(Duration value)

public ViewabilityInfo.Builder setPlaybackDuration(Duration value)

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];

Parameter
Name Description
value Duration
Returns
Type Description
ViewabilityInfo.Builder

setPlaybackDuration(Duration.Builder builderForValue)

public ViewabilityInfo.Builder setPlaybackDuration(Duration.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ViewabilityInfo.Builder

setViewType(ViewType value)

public ViewabilityInfo.Builder setViewType(ViewType value)

Required. The type of the event.

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

Parameter
Name Description
value ViewType

The viewType to set.

Returns
Type Description
ViewabilityInfo.Builder

This builder for chaining.

setViewTypeValue(int value)

public ViewabilityInfo.Builder setViewTypeValue(int value)

Required. The type of the event.

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

Parameter
Name Description
value int

The enum numeric value on the wire for viewType to set.

Returns
Type Description
ViewabilityInfo.Builder

This builder for chaining.

setViewableDuration(Duration value)

public ViewabilityInfo.Builder setViewableDuration(Duration value)

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

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

Parameter
Name Description
value Duration
Returns
Type Description
ViewabilityInfo.Builder

setViewableDuration(Duration.Builder builderForValue)

public ViewabilityInfo.Builder setViewableDuration(Duration.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ViewabilityInfo.Builder

setViewablePercent(int value)

public ViewabilityInfo.Builder setViewablePercent(int value)

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

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

Parameter
Name Description
value int

The viewablePercent to set.

Returns
Type Description
ViewabilityInfo.Builder

This builder for chaining.