Google Ads Data Manager V1 Client - Class ViewabilityInfo (0.6.0)

Reference documentation and code samples for the Google Ads Data Manager V1 Client class ViewabilityInfo.

Details of the viewability of the ad served.

Generated from protobuf message google.ads.datamanager.v1.ViewabilityInfo

Namespace

Google \ Ads \ DataManager \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ view_type`	`int` Required. The type of the event.
`↳ viewable_percent`	`int` Optional. The numerical percent (0-100) of the pixels that were viewable.
`↳ viewable_duration`	`Google\Protobuf\Duration` Optional. The amount of time the ad was viewable for.
`↳ media_skippable`	`bool` Optional. Whether the ad media was skippable or not.
`↳ media_quartile`	`int` Optional. The amount of the media that was played as discrete quartiles.
`↳ media_duration`	`Google\Protobuf\Duration` Optional. The duration of the ad media.
`↳ media_volume_percent`	`int` Optional. The numerical percent (0-100) of the volume of the media playback.
`↳ playback_duration`	`Google\Protobuf\Duration` Optional. The duration of playback of the ad media, regardless of whether it was viewable or not.

getViewType

Required. The type of the event.

Returns
Type	Description
`int`	Enum of type ViewType.

setViewType

Required. The type of the event.

Parameter
Name	Description
`var`	`int` Enum of type ViewType.

Returns
Type	Description
`$this`

getViewablePercent

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

Returns
Type	Description
`int`

setViewablePercent

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

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getViewableDuration

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

Returns
Type	Description
`Google\Protobuf\Duration\|null`

hasViewableDuration

clearViewableDuration

setViewableDuration

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

Parameter
Name	Description
`var`	`Google\Protobuf\Duration`

Returns
Type	Description
`$this`

getMediaSkippable

Optional. Whether the ad media was skippable or not.

Returns
Type	Description
`bool`

setMediaSkippable

Optional. Whether the ad media was skippable or not.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getMediaQuartile

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

Returns
Type	Description
`int`	Enum of type MediaQuartile.

setMediaQuartile

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

Parameter
Name	Description
`var`	`int` Enum of type MediaQuartile.

Returns
Type	Description
`$this`

getMediaDuration

Optional. The duration of the ad media.

Returns
Type	Description
`Google\Protobuf\Duration\|null`

hasMediaDuration

clearMediaDuration

setMediaDuration