Reference documentation and code samples for the Google Ads Ad Manager V1 Client class RichMediaStudioCreativeDetails.
A Creative that is created by a Rich Media Studio. You cannot create this creative, but you can update some fields of this creative.
Generated from protobuf message google.ads.admanager.v1.RichMediaStudioCreativeDetails
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. |
↳ studio_creative_id |
int|string
Output only. The creative ID as known by Rich Media Studio creative. |
↳ creative_format |
int
Optional. The creative format of the Rich Media Studio creative. |
↳ total_file_size |
int|string
Output only. The total size of all assets in bytes. |
↳ ad_tag_keys |
string[]
Optional. Ad tag keys. |
↳ custom_key_values |
string[]
Optional. Custom key values. |
↳ survey_url |
string
Optional. The survey URL for this creative. |
↳ all_impressions_url |
string
Optional. The tracking URL to be triggered when an ad starts to play, whether Rich Media or backup content is displayed. Behaves like the /imp URL that DART used to track impressions. This URL can't exceed 1024 characters and must start with http:// or https://. |
↳ rich_media_impressions_url |
string
Optional. The tracking URL to be triggered when any rich media artwork is displayed in an ad. Behaves like the /imp URL that DART used to track impressions. This URL can't exceed 1024 characters and must start with http:// or https://. |
↳ backup_image_impressions_url |
string
Optional. The tracking URL to be triggered when the Rich Media backup image is served. |
↳ override_css |
string
Optional. The override CSS. You can put custom CSS code here to repair creative styling; e.g. |
↳ required_flash_plugin_version |
string
Output only. The Flash plugin version required to view this creative; e.g. |
↳ duration |
Google\Protobuf\Duration
Optional. The duration of the creative. |
↳ billing_attribute |
int
Optional. The billing attribute associated with this creative. |
↳ rich_media_studio_child_asset_properties |
array<RichMediaStudioChildAssetProperty>
Output only. Child assets associated with this creative. |
↳ 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. |
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 |
|
getStudioCreativeId
Output only. The creative ID as known by Rich Media Studio creative.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasStudioCreativeId
clearStudioCreativeId
setStudioCreativeId
Output only. The creative ID as known by Rich Media Studio creative.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreativeFormat
Optional. The creative format of the Rich Media Studio creative.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasCreativeFormat
clearCreativeFormat
setCreativeFormat
Optional. The creative format of the Rich Media Studio creative.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTotalFileSize
Output only. The total size of all assets in bytes.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasTotalFileSize
clearTotalFileSize
setTotalFileSize
Output only. The total size of all assets in bytes.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdTagKeys
Optional. Ad tag keys.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setAdTagKeys
Optional. Ad tag keys.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCustomKeyValues
Optional. Custom key values.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setCustomKeyValues
Optional. Custom key values.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSurveyUrl
Optional. The survey URL for this creative.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSurveyUrl
clearSurveyUrl
setSurveyUrl
Optional. The survey URL for this creative.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAllImpressionsUrl
Optional. The tracking URL to be triggered when an ad starts to play, whether Rich Media or backup content is displayed. Behaves like the /imp URL that DART used to track impressions. This URL can't exceed 1024 characters and must start with http:// or https://.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasAllImpressionsUrl
clearAllImpressionsUrl
setAllImpressionsUrl
Optional. The tracking URL to be triggered when an ad starts to play, whether Rich Media or backup content is displayed. Behaves like the /imp URL that DART used to track impressions. This URL can't exceed 1024 characters and must start with http:// or https://.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRichMediaImpressionsUrl
Optional. The tracking URL to be triggered when any rich media artwork is displayed in an ad. Behaves like the /imp URL that DART used to track impressions. This URL can't exceed 1024 characters and must start with http:// or https://.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasRichMediaImpressionsUrl
clearRichMediaImpressionsUrl
setRichMediaImpressionsUrl
Optional. The tracking URL to be triggered when any rich media artwork is displayed in an ad. Behaves like the /imp URL that DART used to track impressions. This URL can't exceed 1024 characters and must start with http:// or https://.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBackupImageImpressionsUrl
Optional. The tracking URL to be triggered when the Rich Media backup image is served.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasBackupImageImpressionsUrl
clearBackupImageImpressionsUrl
setBackupImageImpressionsUrl
Optional. The tracking URL to be triggered when the Rich Media backup image is served.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOverrideCss
Optional. The override CSS. You can put custom CSS code here to repair
creative styling; e.g. tr td { background-color:#FBB; }.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasOverrideCss
clearOverrideCss
setOverrideCss
Optional. The override CSS. You can put custom CSS code here to repair
creative styling; e.g. tr td { background-color:#FBB; }.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequiredFlashPluginVersion
Output only. The Flash plugin version required to view this creative; e.g.
Flash 10.2/AS 3.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasRequiredFlashPluginVersion
clearRequiredFlashPluginVersion
setRequiredFlashPluginVersion
Output only. The Flash plugin version required to view this creative; e.g.
Flash 10.2/AS 3.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDuration
Optional. The duration of the creative.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasDuration
clearDuration
setDuration
Optional. The duration of the creative.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBillingAttribute
Optional. The billing attribute associated with this creative.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasBillingAttribute
clearBillingAttribute
setBillingAttribute
Optional. The billing attribute associated with this creative.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRichMediaStudioChildAssetProperties
Output only. Child assets associated with this creative.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<RichMediaStudioChildAssetProperty> |
|
setRichMediaStudioChildAssetProperties
Output only. Child assets associated with this creative.
| Parameter | |
|---|---|
| Name | Description |
var |
array<RichMediaStudioChildAssetProperty>
|
| 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 |
|