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

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

A Creative that loads an image asset from a specified URL.

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

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.

↳ alt_text string

Optional. Alternative text to be rendered along with the creative used mainly for accessibility. This field has a maximum length of 500 characters.

↳ image_url string

Required. The URL where the actual asset resides. This field has a maximum length of 1024 characters.

↳ third_party_impression_tracking_urls string[]

Optional. Impression tracking URLs to ping when this creative is displayed. Each string has a maximum length of 1024 characters.

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

getAltText

Optional. Alternative text to be rendered along with the creative used mainly for accessibility. This field has a maximum length of 500 characters.

Returns
Type Description
string

hasAltText

clearAltText

setAltText

Optional. Alternative text to be rendered along with the creative used mainly for accessibility. This field has a maximum length of 500 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getImageUrl

Required. The URL where the actual asset resides. This field has a maximum length of 1024 characters.

Returns
Type Description
string

hasImageUrl

clearImageUrl

setImageUrl

Required. The URL where the actual asset resides. This field has a maximum length of 1024 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getThirdPartyImpressionTrackingUrls

Optional. Impression tracking URLs to ping when this creative is displayed.

Each string has a maximum length of 1024 characters.

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setThirdPartyImpressionTrackingUrls

Optional. Impression tracking URLs to ping when this creative is displayed.

Each string has a maximum length of 1024 characters.

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