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

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

A Creative that displays an image.

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

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ alt_text string

Alternative text to be rendered along with the creative used mainly for accessibility. This field has a maximum length of 500 characters.
↳ 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.
↳ third_party_impression_tracking_urls string[]

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

Optional. The AMP destination URL for this creative. This must be a valid URL, including the http:// or https:// scheme.
↳ locked_orientation int

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

The primary image asset associated with this creative. This attribute is required.
↳ secondary_image_assets array<CreativeAsset>

Secondary image assets associated with this creative. This attribute is optional. Secondary image assets can be used to store different resolution versions of the primary asset for use on non-standard density screens.
↳ override_size bool

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

getAltText

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

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

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

getThirdPartyImpressionTrackingUrls

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

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setThirdPartyImpressionTrackingUrls

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

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

getAmpDestinationUrl

Optional. The AMP destination URL for this creative. This must be a valid URL, including the http:// or https:// scheme.

Returns
Type Description
string

hasAmpDestinationUrl

clearAmpDestinationUrl

setAmpDestinationUrl

Optional. The AMP destination URL for this creative. This must be a valid URL, including the http:// or https:// scheme.

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

getPrimaryImageAsset

The primary image asset associated with this creative. This attribute is required.

Returns
Type Description
CreativeAsset|null

hasPrimaryImageAsset

clearPrimaryImageAsset

setPrimaryImageAsset

The primary image asset associated with this creative. This attribute is required.

Parameter
Name Description
var CreativeAsset
Returns
Type Description
$this

getSecondaryImageAssets

Secondary image assets associated with this creative. This attribute is optional.

Secondary image assets can be used to store different resolution versions of the primary asset for use on non-standard density screens.

Returns
Type Description
Google\Protobuf\RepeatedField<CreativeAsset>

setSecondaryImageAssets

Secondary image assets associated with this creative. This attribute is optional.

Secondary image assets can be used to store different resolution versions of the primary asset for use on non-standard density screens.

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