public interface CustomCreativeDetailsOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAmpHtmlSnippet()
public abstract String getAmpHtmlSnippet()The AMP HTML snippet that this creative delivers.
optional string amp_html_snippet = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The ampHtmlSnippet. |
getAmpHtmlSnippetBytes()
public abstract ByteString getAmpHtmlSnippetBytes()The AMP HTML snippet that this creative delivers.
optional string amp_html_snippet = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for ampHtmlSnippet. |
getCustomCreativeAssets(int index)
public abstract CustomCreativeAsset getCustomCreativeAssets(int index)Optional. File assets that are associated with this creative, and can be referenced in the snippet.
repeated .google.ads.admanager.v1.CustomCreativeAsset custom_creative_assets = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeAsset |
|
getCustomCreativeAssetsCount()
public abstract int getCustomCreativeAssetsCount()Optional. File assets that are associated with this creative, and can be referenced in the snippet.
repeated .google.ads.admanager.v1.CustomCreativeAsset custom_creative_assets = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getCustomCreativeAssetsList()
public abstract List<CustomCreativeAsset> getCustomCreativeAssetsList()Optional. File assets that are associated with this creative, and can be referenced in the snippet.
repeated .google.ads.admanager.v1.CustomCreativeAsset custom_creative_assets = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<CustomCreativeAsset> |
|
getCustomCreativeAssetsOrBuilder(int index)
public abstract CustomCreativeAssetOrBuilder getCustomCreativeAssetsOrBuilder(int index)Optional. File assets that are associated with this creative, and can be referenced in the snippet.
repeated .google.ads.admanager.v1.CustomCreativeAsset custom_creative_assets = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeAssetOrBuilder |
|
getCustomCreativeAssetsOrBuilderList()
public abstract List<? extends CustomCreativeAssetOrBuilder> getCustomCreativeAssetsOrBuilderList()Optional. File assets that are associated with this creative, and can be referenced in the snippet.
repeated .google.ads.admanager.v1.CustomCreativeAsset custom_creative_assets = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.ads.admanager.v1.CustomCreativeAssetOrBuilder> |
|
getDestinationUrl()
public abstract String 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.
optional string destination_url = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The destinationUrl. |
getDestinationUrlBytes()
public abstract ByteString getDestinationUrlBytes() 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.
optional string destination_url = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for destinationUrl. |
getDestinationUrlType()
public abstract CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType getDestinationUrlType() Optional. The action that should be performed if the user clicks on the
creative. This attribute defaults to CLICK_TO_WEB.
optional .google.ads.admanager.v1.CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType destination_url_type = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType |
The destinationUrlType. |
getDestinationUrlTypeValue()
public abstract int getDestinationUrlTypeValue() Optional. The action that should be performed if the user clicks on the
creative. This attribute defaults to CLICK_TO_WEB.
optional .google.ads.admanager.v1.CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType destination_url_type = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for destinationUrlType. |
getEffectiveSafeFrameCompatible()
public abstract boolean getEffectiveSafeFrameCompatible()Output only. The effective value of whether the creative is compatible for SafeFrame rendering, as decided by the service.
optional bool effective_safe_frame_compatible = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The effectiveSafeFrameCompatible. |
getHtmlSnippet()
public abstract String getHtmlSnippet()Required. The HTML snippet that this creative delivers.
optional string html_snippet = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The htmlSnippet. |
getHtmlSnippetBytes()
public abstract ByteString getHtmlSnippetBytes()Required. The HTML snippet that this creative delivers.
optional string html_snippet = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for htmlSnippet. |
getInterstitial()
public abstract boolean getInterstitial()Whether this custom creative is an interstitial. An interstitial creative will not consider an impression served until it is fully rendered in the browser.
optional bool interstitial = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
The interstitial. |
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 = 8 [(.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 = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for lockedOrientation. |
getSafeFrameCompatible()
public abstract boolean getSafeFrameCompatible()Input only. Whether the creative is compatible for SafeFrame rendering.
optional bool safe_frame_compatible = 5 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The safeFrameCompatible. |
getThirdPartyImpressionTrackingUrls(int index)
public abstract String getThirdPartyImpressionTrackingUrls(int index)Optional. Impression tracking URLs to ping when this creative is displayed.
repeated string third_party_impression_tracking_urls = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The thirdPartyImpressionTrackingUrls at the given index. |
getThirdPartyImpressionTrackingUrlsBytes(int index)
public abstract ByteString getThirdPartyImpressionTrackingUrlsBytes(int index)Optional. Impression tracking URLs to ping when this creative is displayed.
repeated string third_party_impression_tracking_urls = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the thirdPartyImpressionTrackingUrls at the given index. |
getThirdPartyImpressionTrackingUrlsCount()
public abstract int getThirdPartyImpressionTrackingUrlsCount()Optional. Impression tracking URLs to ping when this creative is displayed.
repeated string third_party_impression_tracking_urls = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of thirdPartyImpressionTrackingUrls. |
getThirdPartyImpressionTrackingUrlsList()
public abstract List<String> getThirdPartyImpressionTrackingUrlsList()Optional. Impression tracking URLs to ping when this creative is displayed.
repeated string third_party_impression_tracking_urls = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the thirdPartyImpressionTrackingUrls. |
hasAmpHtmlSnippet()
public abstract boolean hasAmpHtmlSnippet()The AMP HTML snippet that this creative delivers.
optional string amp_html_snippet = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the ampHtmlSnippet field is set. |
hasDestinationUrl()
public abstract boolean hasDestinationUrl() 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.
optional string destination_url = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the destinationUrl field is set. |
hasDestinationUrlType()
public abstract boolean hasDestinationUrlType() Optional. The action that should be performed if the user clicks on the
creative. This attribute defaults to CLICK_TO_WEB.
optional .google.ads.admanager.v1.CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType destination_url_type = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the destinationUrlType field is set. |
hasEffectiveSafeFrameCompatible()
public abstract boolean hasEffectiveSafeFrameCompatible()Output only. The effective value of whether the creative is compatible for SafeFrame rendering, as decided by the service.
optional bool effective_safe_frame_compatible = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the effectiveSafeFrameCompatible field is set. |
hasHtmlSnippet()
public abstract boolean hasHtmlSnippet()Required. The HTML snippet that this creative delivers.
optional string html_snippet = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the htmlSnippet field is set. |
hasInterstitial()
public abstract boolean hasInterstitial()Whether this custom creative is an interstitial. An interstitial creative will not consider an impression served until it is fully rendered in the browser.
optional bool interstitial = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the interstitial 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 = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the lockedOrientation field is set. |
hasSafeFrameCompatible()
public abstract boolean hasSafeFrameCompatible()Input only. Whether the creative is compatible for SafeFrame rendering.
optional bool safe_frame_compatible = 5 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the safeFrameCompatible field is set. |