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

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

An overlay Creative that displays an image and is served via VAST 2.0 XML.

Overlays cover part of the video content they are displayed on top of.

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

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ locked_orientation`	`int` Optional. A locked orientation for this creative to be displayed in.
`↳ 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`.
`↳ override_size`	`bool` Optional. Allows the creative size to differ from the actual image asset size.
`↳ primary_image_asset`	`CreativeAsset` Required. The primary image asset associated with 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[]` Output only. The resource names of the companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"
`↳ 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.
`↳ duration`	`Google\Protobuf\Duration` Optional. Minimum suggested duration.
`↳ 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.

getLockedOrientation

Optional. A locked orientation for this creative to be displayed in.

Returns
Type	Description
`int`

hasLockedOrientation

clearLockedOrientation

setLockedOrientation

Optional. A locked orientation for this creative to be displayed in.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

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`

getOverrideSize

Optional. Allows the creative size to differ from the actual image asset size.

Returns
Type	Description
`bool`

hasOverrideSize

clearOverrideSize

setOverrideSize

Optional. Allows the creative size to differ from the actual image asset size.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getPrimaryImageAsset

Required. The primary image asset associated with this creative.

Returns
Type	Description
`CreativeAsset\|null`

hasPrimaryImageAsset

clearPrimaryImageAsset

setPrimaryImageAsset

Required. The primary image asset associated with this creative.

Parameter
Name	Description
`var`	`CreativeAsset`

Returns
Type	Description
`$this`

getCreativeSetDisplayName

Output only. The display name of the creative set.

Returns
Type	Description
`string`

hasCreativeSetDisplayName

clearCreativeSetDisplayName

setCreativeSetDisplayName

Output only. The display name of the creative set.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreativeSet

Output only. The resource name of the creative set.

Format: "networks/{network_code}/creativeSets/{creative_set_id}"

Returns
Type	Description
`string`

hasCreativeSet

clearCreativeSet

setCreativeSet

Output only. The resource name of the creative set.

Format: "networks/{network_code}/creativeSets/{creative_set_id}"

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCompanionCreatives

Output only. The resource names of the companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"

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

setCompanionCreatives

Output only. The resource names of the companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getTrackingUrls

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

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

setTrackingUrls