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

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

A Creative that is served by a 3rd-party vendor.

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

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ snippet string

The HTML snippet that this creative delivers.

↳ expanded_snippet string

Output only. The HTML snippet that this creative delivers with macros expanded.

↳ locked_orientation int

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

↳ ssl_scan_result int

Output only. The SSL compatibility scan result of this creative.

↳ ssl_manual_override int

Optional. The manual override for the SSL compatibility of this creative.

↳ safe_frame_compatible bool

Optional. Whether the Creative is compatible for SafeFrame rendering.

↳ third_party_impression_tracking_urls string[]

Optional. A list of impression tracking URLs to ping when this creative is displayed.

↳ amp_redirect_url string

Optional. The URL of the AMP creative.

↳ 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.

getSnippet

The HTML snippet that this creative delivers.

Returns
Type Description
string

hasSnippet

clearSnippet

setSnippet

The HTML snippet that this creative delivers.

Parameter
Name Description
var string
Returns
Type Description
$this

getExpandedSnippet

Output only. The HTML snippet that this creative delivers with macros expanded.

Returns
Type Description
string

hasExpandedSnippet

clearExpandedSnippet

setExpandedSnippet

Output only. The HTML snippet that this creative delivers with macros expanded.

Parameter
Name Description
var string
Returns
Type Description
$this

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

getSslScanResult

Output only. The SSL compatibility scan result of this creative.

Returns
Type Description
int

hasSslScanResult

clearSslScanResult

setSslScanResult

Output only. The SSL compatibility scan result of this creative.

Parameter
Name Description
var int
Returns
Type Description
$this

getSslManualOverride

Optional. The manual override for the SSL compatibility of this creative.

Returns
Type Description
int

hasSslManualOverride

clearSslManualOverride

setSslManualOverride

Optional. The manual override for the SSL compatibility of this creative.

Parameter
Name Description
var int
Returns
Type Description
$this

getSafeFrameCompatible

Optional. Whether the Creative is compatible for SafeFrame rendering.

Returns
Type Description
bool

hasSafeFrameCompatible

clearSafeFrameCompatible

setSafeFrameCompatible

Optional. Whether the Creative is compatible for SafeFrame rendering.

Parameter
Name Description
var bool
Returns
Type Description
$this

getThirdPartyImpressionTrackingUrls

Optional. A list of impression tracking URLs to ping when this creative is displayed.

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setThirdPartyImpressionTrackingUrls

Optional. A list of impression tracking URLs to ping when this creative is displayed.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getAmpRedirectUrl

Optional. The URL of the AMP creative.

Returns
Type Description
string

hasAmpRedirectUrl

clearAmpRedirectUrl

setAmpRedirectUrl

Optional. The URL of the AMP creative.

Parameter
Name Description
var string
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