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

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

A Creative that contains a custom HTML snippet and file assets.

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

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ html_snippet`	`string` Required. The HTML snippet that this creative delivers.
`↳ amp_html_snippet`	`string` The AMP HTML snippet that this creative delivers.
`↳ interstitial`	`bool` Whether this custom creative is an interstitial. An interstitial creative will not consider an impression served until it is fully rendered in the browser.
`↳ 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`.
`↳ safe_frame_compatible`	`bool` Input only. Whether the creative is compatible for SafeFrame rendering.
`↳ effective_safe_frame_compatible`	`bool` Output only. The effective value of whether the creative is compatible for SafeFrame rendering, as decided by the service.
`↳ third_party_impression_tracking_urls`	`string[]` Optional. Impression tracking URLs to ping when this creative is displayed.
`↳ locked_orientation`	`int` Optional. A locked orientation for this creative to be displayed in.
`↳ custom_creative_assets`	`array<CustomCreativeAsset>` Optional. File assets that are associated with this creative, and can be referenced in the snippet.

getHtmlSnippet

Required. The HTML snippet that this creative delivers.

Returns
Type	Description
`string`

hasHtmlSnippet

clearHtmlSnippet

setHtmlSnippet

Required. The HTML snippet that this creative delivers.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAmpHtmlSnippet

The AMP HTML snippet that this creative delivers.

Returns
Type	Description
`string`

hasAmpHtmlSnippet

clearAmpHtmlSnippet

setAmpHtmlSnippet

The AMP HTML snippet that this creative delivers.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getInterstitial

Whether this custom creative is an interstitial. An interstitial creative will not consider an impression served until it is fully rendered in the browser.

Returns
Type	Description
`bool`

hasInterstitial

clearInterstitial

setInterstitial

Whether this custom creative is an interstitial. An interstitial creative will not consider an impression served until it is fully rendered in the browser.

Parameter
Name	Description
`var`	`bool`

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`

getSafeFrameCompatible

Input only. Whether the creative is compatible for SafeFrame rendering.

Returns
Type	Description
`bool`

hasSafeFrameCompatible

clearSafeFrameCompatible

setSafeFrameCompatible