Interface RichMediaStudioCreativeDetailsOrBuilder (0.62.0)

public interface RichMediaStudioCreativeDetailsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAdTagKeys(int index)

public abstract String getAdTagKeys(int index)

Optional. Ad tag keys.

repeated string ad_tag_keys = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The adTagKeys at the given index.

getAdTagKeysBytes(int index)

public abstract ByteString getAdTagKeysBytes(int index)

Optional. Ad tag keys.

repeated string ad_tag_keys = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the adTagKeys at the given index.

getAdTagKeysCount()

public abstract int getAdTagKeysCount()

Optional. Ad tag keys.

repeated string ad_tag_keys = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of adTagKeys.

getAdTagKeysList()

public abstract List<String> getAdTagKeysList()

Optional. Ad tag keys.

repeated string ad_tag_keys = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<String>

A list containing the adTagKeys.

getAllImpressionsUrl()

public abstract String 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://.

optional string all_impressions_url = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The allImpressionsUrl.

getAllImpressionsUrlBytes()

public abstract ByteString getAllImpressionsUrlBytes()

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://.

optional string all_impressions_url = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for allImpressionsUrl.

getBackupImageImpressionsUrl()

public abstract String getBackupImageImpressionsUrl()

Optional. The tracking URL to be triggered when the Rich Media backup image is served.

optional string backup_image_impressions_url = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The backupImageImpressionsUrl.

getBackupImageImpressionsUrlBytes()

public abstract ByteString getBackupImageImpressionsUrlBytes()

Optional. The tracking URL to be triggered when the Rich Media backup image is served.

optional string backup_image_impressions_url = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for backupImageImpressionsUrl.

getBillingAttribute()

public abstract RichMediaStudioCreativeBillingAttributeEnum.RichMediaStudioCreativeBillingAttribute getBillingAttribute()

Optional. The billing attribute associated with this creative.

optional .google.ads.admanager.v1.RichMediaStudioCreativeBillingAttributeEnum.RichMediaStudioCreativeBillingAttribute billing_attribute = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RichMediaStudioCreativeBillingAttributeEnum.RichMediaStudioCreativeBillingAttribute

The billingAttribute.

getBillingAttributeValue()

public abstract int getBillingAttributeValue()

Optional. The billing attribute associated with this creative.

optional .google.ads.admanager.v1.RichMediaStudioCreativeBillingAttributeEnum.RichMediaStudioCreativeBillingAttribute billing_attribute = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for billingAttribute.

getCreativeFormat()

public abstract RichMediaStudioCreativeFormatEnum.RichMediaStudioCreativeFormat getCreativeFormat()

Optional. The creative format of the Rich Media Studio creative.

optional .google.ads.admanager.v1.RichMediaStudioCreativeFormatEnum.RichMediaStudioCreativeFormat creative_format = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RichMediaStudioCreativeFormatEnum.RichMediaStudioCreativeFormat

The creativeFormat.

getCreativeFormatValue()

public abstract int getCreativeFormatValue()

Optional. The creative format of the Rich Media Studio creative.

optional .google.ads.admanager.v1.RichMediaStudioCreativeFormatEnum.RichMediaStudioCreativeFormat creative_format = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for creativeFormat.

getCustomKeyValues(int index)

public abstract String getCustomKeyValues(int index)

Optional. Custom key values.

repeated string custom_key_values = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The customKeyValues at the given index.

getCustomKeyValuesBytes(int index)

public abstract ByteString getCustomKeyValuesBytes(int index)

Optional. Custom key values.

repeated string custom_key_values = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the customKeyValues at the given index.

getCustomKeyValuesCount()

public abstract int getCustomKeyValuesCount()

Optional. Custom key values.

repeated string custom_key_values = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of customKeyValues.

getCustomKeyValuesList()

public abstract List<String> getCustomKeyValuesList()

Optional. Custom key values.

repeated string custom_key_values = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<String>

A list containing the customKeyValues.

getDuration()

public abstract Duration getDuration()

Optional. The duration of the creative.

optional .google.protobuf.Duration duration = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The duration.

getDurationOrBuilder()

public abstract DurationOrBuilder getDurationOrBuilder()

Optional. The duration of the creative.

optional .google.protobuf.Duration duration = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getLockedOrientation()

public abstract CreativeLockedOrientationEnum.CreativeLockedOrientation getLockedOrientation()

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

optional .google.ads.admanager.v1.CreativeLockedOrientationEnum.CreativeLockedOrientation locked_orientation = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreativeLockedOrientationEnum.CreativeLockedOrientation

The lockedOrientation.

getLockedOrientationValue()

public abstract int getLockedOrientationValue()

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

optional .google.ads.admanager.v1.CreativeLockedOrientationEnum.CreativeLockedOrientation locked_orientation = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for lockedOrientation.

getOverrideCss()

public abstract String getOverrideCss()

Optional. The override CSS. You can put custom CSS code here to repair creative styling; e.g. tr td { background-color:#FBB; }.

optional string override_css = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The overrideCss.

getOverrideCssBytes()

public abstract ByteString getOverrideCssBytes()

Optional. The override CSS. You can put custom CSS code here to repair creative styling; e.g. tr td { background-color:#FBB; }.

optional string override_css = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for overrideCss.

getRequiredFlashPluginVersion()

public abstract String getRequiredFlashPluginVersion()

Output only. The Flash plugin version required to view this creative; e.g. Flash 10.2/AS 3.

optional string required_flash_plugin_version = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The requiredFlashPluginVersion.

getRequiredFlashPluginVersionBytes()

public abstract ByteString getRequiredFlashPluginVersionBytes()

Output only. The Flash plugin version required to view this creative; e.g. Flash 10.2/AS 3.

optional string required_flash_plugin_version = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for requiredFlashPluginVersion.

getRichMediaImpressionsUrl()

public abstract String 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://.

optional string rich_media_impressions_url = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The richMediaImpressionsUrl.

getRichMediaImpressionsUrlBytes()

public abstract ByteString getRichMediaImpressionsUrlBytes()

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://.

optional string rich_media_impressions_url = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for richMediaImpressionsUrl.

getRichMediaStudioChildAssetProperties(int index)

public abstract RichMediaStudioChildAssetProperty getRichMediaStudioChildAssetProperties(int index)

Output only. Child assets associated with this creative.

repeated .google.ads.admanager.v1.RichMediaStudioChildAssetProperty rich_media_studio_child_asset_properties = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
RichMediaStudioChildAssetProperty

getRichMediaStudioChildAssetPropertiesCount()

public abstract int getRichMediaStudioChildAssetPropertiesCount()

Output only. Child assets associated with this creative.

repeated .google.ads.admanager.v1.RichMediaStudioChildAssetProperty rich_media_studio_child_asset_properties = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getRichMediaStudioChildAssetPropertiesList()

public abstract List<RichMediaStudioChildAssetProperty> getRichMediaStudioChildAssetPropertiesList()

Output only. Child assets associated with this creative.

repeated .google.ads.admanager.v1.RichMediaStudioChildAssetProperty rich_media_studio_child_asset_properties = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<RichMediaStudioChildAssetProperty>

getRichMediaStudioChildAssetPropertiesOrBuilder(int index)

public abstract RichMediaStudioChildAssetPropertyOrBuilder getRichMediaStudioChildAssetPropertiesOrBuilder(int index)

Output only. Child assets associated with this creative.

repeated .google.ads.admanager.v1.RichMediaStudioChildAssetProperty rich_media_studio_child_asset_properties = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
RichMediaStudioChildAssetPropertyOrBuilder

getRichMediaStudioChildAssetPropertiesOrBuilderList()

public abstract List<? extends RichMediaStudioChildAssetPropertyOrBuilder> getRichMediaStudioChildAssetPropertiesOrBuilderList()

Output only. Child assets associated with this creative.

repeated .google.ads.admanager.v1.RichMediaStudioChildAssetProperty rich_media_studio_child_asset_properties = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.RichMediaStudioChildAssetPropertyOrBuilder>

getSslManualOverride()

public abstract CreativeSslOverrideEnum.CreativeSslOverride getSslManualOverride()

Optional. The manual override for the SSL compatibility of this creative.

optional .google.ads.admanager.v1.CreativeSslOverrideEnum.CreativeSslOverride ssl_manual_override = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreativeSslOverrideEnum.CreativeSslOverride

The sslManualOverride.

getSslManualOverrideValue()

public abstract int getSslManualOverrideValue()

Optional. The manual override for the SSL compatibility of this creative.

optional .google.ads.admanager.v1.CreativeSslOverrideEnum.CreativeSslOverride ssl_manual_override = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for sslManualOverride.

getSslScanResult()

public abstract CreativeSslScanResultEnum.CreativeSslScanResult getSslScanResult()

Output only. The SSL compatibility scan result of this creative.

optional .google.ads.admanager.v1.CreativeSslScanResultEnum.CreativeSslScanResult ssl_scan_result = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CreativeSslScanResultEnum.CreativeSslScanResult

The sslScanResult.

getSslScanResultValue()

public abstract int getSslScanResultValue()

Output only. The SSL compatibility scan result of this creative.

optional .google.ads.admanager.v1.CreativeSslScanResultEnum.CreativeSslScanResult ssl_scan_result = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for sslScanResult.

getStudioCreativeId()

public abstract long getStudioCreativeId()

Output only. The creative ID as known by Rich Media Studio creative.

optional int64 studio_creative_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The studioCreativeId.

getSurveyUrl()

public abstract String getSurveyUrl()

Optional. The survey URL for this creative.

optional string survey_url = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The surveyUrl.

getSurveyUrlBytes()

public abstract ByteString getSurveyUrlBytes()

Optional. The survey URL for this creative.

optional string survey_url = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for surveyUrl.

getTotalFileSize()

public abstract long getTotalFileSize()

Output only. The total size of all assets in bytes.

optional int64 total_file_size = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The totalFileSize.

hasAllImpressionsUrl()

public abstract boolean hasAllImpressionsUrl()

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://.

optional string all_impressions_url = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the allImpressionsUrl field is set.

hasBackupImageImpressionsUrl()

public abstract boolean hasBackupImageImpressionsUrl()

Optional. The tracking URL to be triggered when the Rich Media backup image is served.

optional string backup_image_impressions_url = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the backupImageImpressionsUrl field is set.

hasBillingAttribute()

public abstract boolean hasBillingAttribute()

Optional. The billing attribute associated with this creative.

optional .google.ads.admanager.v1.RichMediaStudioCreativeBillingAttributeEnum.RichMediaStudioCreativeBillingAttribute billing_attribute = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the billingAttribute field is set.

hasCreativeFormat()

public abstract boolean hasCreativeFormat()

Optional. The creative format of the Rich Media Studio creative.

optional .google.ads.admanager.v1.RichMediaStudioCreativeFormatEnum.RichMediaStudioCreativeFormat creative_format = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the creativeFormat field is set.

hasDuration()

public abstract boolean hasDuration()

Optional. The duration of the creative.

optional .google.protobuf.Duration duration = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the duration field is set.

hasLockedOrientation()

public abstract boolean hasLockedOrientation()

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

optional .google.ads.admanager.v1.CreativeLockedOrientationEnum.CreativeLockedOrientation locked_orientation = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the lockedOrientation field is set.

hasOverrideCss()

public abstract boolean hasOverrideCss()

Optional. The override CSS. You can put custom CSS code here to repair creative styling; e.g. tr td { background-color:#FBB; }.

optional string override_css = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the overrideCss field is set.

hasRequiredFlashPluginVersion()

public abstract boolean hasRequiredFlashPluginVersion()

Output only. The Flash plugin version required to view this creative; e.g. Flash 10.2/AS 3.

optional string required_flash_plugin_version = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the requiredFlashPluginVersion field is set.

hasRichMediaImpressionsUrl()

public abstract boolean hasRichMediaImpressionsUrl()

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://.

optional string rich_media_impressions_url = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the richMediaImpressionsUrl field is set.

hasSslManualOverride()

public abstract boolean hasSslManualOverride()

Optional. The manual override for the SSL compatibility of this creative.

optional .google.ads.admanager.v1.CreativeSslOverrideEnum.CreativeSslOverride ssl_manual_override = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the sslManualOverride field is set.

hasSslScanResult()

public abstract boolean hasSslScanResult()

Output only. The SSL compatibility scan result of this creative.

optional .google.ads.admanager.v1.CreativeSslScanResultEnum.CreativeSslScanResult ssl_scan_result = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the sslScanResult field is set.

hasStudioCreativeId()

public abstract boolean hasStudioCreativeId()

Output only. The creative ID as known by Rich Media Studio creative.

optional int64 studio_creative_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the studioCreativeId field is set.

hasSurveyUrl()

public abstract boolean hasSurveyUrl()

Optional. The survey URL for this creative.

optional string survey_url = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the surveyUrl field is set.

hasTotalFileSize()

public abstract boolean hasTotalFileSize()

Output only. The total size of all assets in bytes.

optional int64 total_file_size = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the totalFileSize field is set.