Reference documentation and code samples for the Google Ads Ad Manager V1 Client class AspectRatioImageCreativeDetails.
A Creative intended for mobile platforms that displays an image, whose size is defined as an aspect ratio. It can have multiple images whose dimensions conform to that aspect ratio.
Generated from protobuf message google.ads.admanager.v1.AspectRatioImageCreativeDetails
Namespace
Google \ Ads \ AdManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ alt_text |
string
Optional. The text that is served along with the image creative, primarily for accessibility. If no suitable image size is available for the device, this text replaces the image completely. This field is optional and 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 |
↳ destination_url_type |
int
Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to |
↳ image_assets |
array<CreativeAsset>
Required. The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset. |
↳ third_party_impression_tracking_urls |
string[]
Optional. Third party impression tracking URLs to ping when this creative is displayed. |
getAltText
Optional. The text that is served along with the image creative, primarily for accessibility. If no suitable image size is available for the device, this text replaces the image completely. This field is optional and has a maximum length of 500 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasAltText
clearAltText
setAltText
Optional. The text that is served along with the image creative, primarily for accessibility. If no suitable image size is available for the device, this text replaces the image completely. This field is optional and 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 |
|
getImageAssets
Required. The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<CreativeAsset> |
|
setImageAssets
Required. The images associated with this creative. The ad server will choose one based on the capabilities of the device. Each asset should have a size which is of the same aspect ratio as the Creative.size. This attribute is required and must have at least one asset.
| Parameter | |
|---|---|
| Name | Description |
var |
array<CreativeAsset>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getThirdPartyImpressionTrackingUrls
Optional. Third party impression tracking URLs to ping when this creative is displayed.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setThirdPartyImpressionTrackingUrls
Optional. Third party impression tracking URLs to ping when this creative is displayed.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|