Google Ads Ad Manager V1 Client - Class ImageRedirectOverlayCreativeDetails (0.15.0)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class ImageRedirectOverlayCreativeDetails.

An overlay Creative that loads an image asset from a specified URL and is served via VAST XML. Overlays cover part of the video content they are displayed on top of. This creative is read only.

Generated from protobuf message google.ads.admanager.v1.ImageRedirectOverlayCreativeDetails

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ destination_url`	`string` Optional. The URL that the user is directed to if they click on the creative. This attribute is required unless the `destinationUrlType` is `NONE`, and has a maximum length of 1024 characters.
`↳ destination_url_type`	`int` Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to `CLICK_TO_WEB`.
`↳ image_url`	`string` Required. The URL where the actual image asset resides. This attribute is required and has a maximum length of 1024 characters.
`↳ asset_size`	`Size` Optional. The size of the image asset. Note that this may differ from the creative size if the asset is not expected to fill the entire video player.
`↳ duration`	`Google\Protobuf\Duration` Optional. Minimum suggested duration.
`↳ tracking_urls`	`array<VideoTrackingUrl>` Optional. URLs that will be pinged when conversion events happen.
`↳ custom_parameters`	`string` Optional. A comma separated key=value list of parameters that will be supplied to the creative, written into the VAST `AdParameters` node.
`↳ expected_companions`	`array<CreativePlaceholder>` Optional. `CreativePlaceholder` objects a creative set should fulfill.
`↳ expected_companion_delivery_option`	`int` Output only. The companion delivery option this set will be served with.
`↳ vast_preview_url`	`string` Output only. An ad tag URL that will return a preview of the VAST XML response specific to this creative.
`↳ creative_set_display_name`	`string` Output only. The display name of the creative set.
`↳ creative_set`	`string` Output only. The resource name of the creative set. Format: "networks/{network_code}/creativeSets/{creative_set_id}"
`↳ companion_creatives`	`string[]` Optional. The companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"

getDestinationUrl

Optional. The URL that the user is directed to if they click on the creative. This attribute is required unless the destinationUrlType is NONE, and has a maximum length of 1024 characters.

Returns
Type	Description
`string`

hasDestinationUrl

clearDestinationUrl

setDestinationUrl

Optional. The URL that the user is directed to if they click on the creative. This attribute is required unless the destinationUrlType is NONE, and has a maximum length of 1024 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDestinationUrlType

Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to CLICK_TO_WEB.

Returns
Type	Description
`int`

hasDestinationUrlType

clearDestinationUrlType

setDestinationUrlType

Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to CLICK_TO_WEB.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getImageUrl

Required. The URL where the actual image asset resides. This attribute is required and has a maximum length of 1024 characters.

Returns
Type	Description
`string`

hasImageUrl

clearImageUrl

setImageUrl

Required. The URL where the actual image asset resides. This attribute is required and has a maximum length of 1024 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAssetSize

Optional. The size of the image asset. Note that this may differ from the creative size if the asset is not expected to fill the entire video player.

Returns
Type	Description
`Size\|null`

hasAssetSize

clearAssetSize

setAssetSize

Optional. The size of the image asset. Note that this may differ from the creative size if the asset is not expected to fill the entire video player.

Parameter
Name	Description
`var`	`Size`

Returns
Type	Description
`$this`

getDuration

Optional. Minimum suggested duration.

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

hasDuration

clearDuration

setDuration

Optional. Minimum suggested duration.

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

Returns
Type	Description
`$this`

getTrackingUrls

Optional. URLs that will be pinged when conversion events happen.

Returns
Type	Description
`Google\Protobuf\RepeatedField<VideoTrackingUrl>`

setTrackingUrls

Optional. URLs that will be pinged when conversion events happen.

Parameter
Name	Description
`var`	`array<VideoTrackingUrl>`

Returns
Type	Description
`$this`

getCustomParameters

Optional. A comma separated key=value list of parameters that will be supplied to the creative, written into the VAST AdParameters node.

Returns
Type	Description
`string`

hasCustomParameters

clearCustomParameters

setCustomParameters

Optional. A comma separated key=value list of parameters that will be supplied to the creative, written into the VAST AdParameters node.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getExpectedCompanions

Optional. CreativePlaceholder objects a creative set should fulfill.

Returns
Type	Description
`Google\Protobuf\RepeatedField<CreativePlaceholder>`

setExpectedCompanions

Optional. CreativePlaceholder objects a creative set should fulfill.

Parameter
Name	Description
`var`	`array<CreativePlaceholder>`

Returns
Type	Description
`$this`

getExpectedCompanionDeliveryOption

Output only. The companion delivery option this set will be served with.

Returns
Type	Description
`int`

hasExpectedCompanionDeliveryOption

clearExpectedCompanionDeliveryOption

setExpectedCompanionDeliveryOption