Reference documentation and code samples for the Google Ads Ad Manager V1 Client class Html5CreativeDetails.
A Creative that contains a zipped HTML5 bundle asset, a list of third party impression trackers, and a third party click tracker.
Generated from protobuf message google.ads.admanager.v1.Html5CreativeDetails
Namespace
Google \ Ads \ AdManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ locked_orientation |
int
Optional. A locked orientation for this creative to be displayed in. |
↳ override_size |
bool
Optional. Allows the creative size to differ from the actual HTML5 asset size. |
↳ third_party_impression_tracking_urls |
string[]
Optional. Impression tracking URLs to ping when this creative is displayed. |
↳ third_party_click_tracking_url |
string
Optional. A click tracking URL to ping when this creative is clicked. |
↳ safe_frame_compatible |
bool
Optional. Whether the creative is compatible for SafeFrame rendering. |
↳ html5_asset |
CreativeAsset
Required. The HTML5 asset. To preview the HTML5 asset, use the |
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 |
|
getOverrideSize
Optional. Allows the creative size to differ from the actual HTML5 asset size.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasOverrideSize
clearOverrideSize
setOverrideSize
Optional. Allows the creative size to differ from the actual HTML5 asset size.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| 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 |
|
getThirdPartyClickTrackingUrl
Optional. A click tracking URL to ping when this creative is clicked.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasThirdPartyClickTrackingUrl
clearThirdPartyClickTrackingUrl
setThirdPartyClickTrackingUrl
Optional. A click tracking URL to ping when this creative is clicked.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| 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 |
|
getHtml5Asset
Required. The HTML5 asset. To preview the HTML5 asset, use the
CreativeAsset.asset_url. In this field, the
CreativeAsset.asset_byte_array must be a zip bundle and the
CreativeAsset.file_name must have a zip extension.
| Returns | |
|---|---|
| Type | Description |
CreativeAsset|null |
|
hasHtml5Asset
clearHtml5Asset
setHtml5Asset
Required. The HTML5 asset. To preview the HTML5 asset, use the
CreativeAsset.asset_url. In this field, the
CreativeAsset.asset_byte_array must be a zip bundle and the
CreativeAsset.file_name must have a zip extension.
| Parameter | |
|---|---|
| Name | Description |
var |
CreativeAsset
|
| Returns | |
|---|---|
| Type | Description |
$this |
|