public static final class CustomCreativeDetails.Builder extends GeneratedMessage.Builder<CustomCreativeDetails.Builder> implements CustomCreativeDetailsOrBuilderA Creative that contains a custom HTML snippet and file assets.
Protobuf type google.ads.admanager.v1.CustomCreativeDetails
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > CustomCreativeDetails.BuilderImplements
CustomCreativeDetailsOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllCustomCreativeAssets(Iterable<? extends CustomCreativeAsset> values)
public CustomCreativeDetails.Builder addAllCustomCreativeAssets(Iterable<? extends CustomCreativeAsset> values)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 |
values |
Iterable<? extends com.google.ads.admanager.v1.CustomCreativeAsset> |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
|
addAllThirdPartyImpressionTrackingUrls(Iterable<String> values)
public CustomCreativeDetails.Builder addAllThirdPartyImpressionTrackingUrls(Iterable<String> values)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 |
values |
Iterable<String>The thirdPartyImpressionTrackingUrls to add. |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
This builder for chaining. |
addCustomCreativeAssets(CustomCreativeAsset value)
public CustomCreativeDetails.Builder addCustomCreativeAssets(CustomCreativeAsset value)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 |
value |
CustomCreativeAsset |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
|
addCustomCreativeAssets(CustomCreativeAsset.Builder builderForValue)
public CustomCreativeDetails.Builder addCustomCreativeAssets(CustomCreativeAsset.Builder builderForValue)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 |
builderForValue |
CustomCreativeAsset.Builder |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
|
addCustomCreativeAssets(int index, CustomCreativeAsset value)
public CustomCreativeDetails.Builder addCustomCreativeAssets(int index, CustomCreativeAsset value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
CustomCreativeAsset |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
|
addCustomCreativeAssets(int index, CustomCreativeAsset.Builder builderForValue)
public CustomCreativeDetails.Builder addCustomCreativeAssets(int index, CustomCreativeAsset.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
CustomCreativeAsset.Builder |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
|
addCustomCreativeAssetsBuilder()
public CustomCreativeAsset.Builder addCustomCreativeAssetsBuilder()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 |
CustomCreativeAsset.Builder |
|
addCustomCreativeAssetsBuilder(int index)
public CustomCreativeAsset.Builder addCustomCreativeAssetsBuilder(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.Builder |
|
addThirdPartyImpressionTrackingUrls(String value)
public CustomCreativeDetails.Builder addThirdPartyImpressionTrackingUrls(String value)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 |
value |
StringThe thirdPartyImpressionTrackingUrls to add. |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
This builder for chaining. |
addThirdPartyImpressionTrackingUrlsBytes(ByteString value)
public CustomCreativeDetails.Builder addThirdPartyImpressionTrackingUrlsBytes(ByteString value)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 |
value |
ByteStringThe bytes of the thirdPartyImpressionTrackingUrls to add. |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
This builder for chaining. |
build()
public CustomCreativeDetails build()| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails |
|
buildPartial()
public CustomCreativeDetails buildPartial()| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails |
|
clear()
public CustomCreativeDetails.Builder clear()| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
|
clearAmpHtmlSnippet()
public CustomCreativeDetails.Builder clearAmpHtmlSnippet()The AMP HTML snippet that this creative delivers.
optional string amp_html_snippet = 2;
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
This builder for chaining. |
clearCustomCreativeAssets()
public CustomCreativeDetails.Builder clearCustomCreativeAssets()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 |
CustomCreativeDetails.Builder |
|
clearDestinationUrl()
public CustomCreativeDetails.Builder clearDestinationUrl() 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 |
CustomCreativeDetails.Builder |
This builder for chaining. |
clearDestinationUrlType()
public CustomCreativeDetails.Builder clearDestinationUrlType() 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 |
CustomCreativeDetails.Builder |
This builder for chaining. |
clearEffectiveSafeFrameCompatible()
public CustomCreativeDetails.Builder clearEffectiveSafeFrameCompatible()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 |
CustomCreativeDetails.Builder |
This builder for chaining. |
clearHtmlSnippet()
public CustomCreativeDetails.Builder clearHtmlSnippet()Required. The HTML snippet that this creative delivers.
optional string html_snippet = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
This builder for chaining. |
clearInterstitial()
public CustomCreativeDetails.Builder clearInterstitial()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 |
CustomCreativeDetails.Builder |
This builder for chaining. |
clearLockedOrientation()
public CustomCreativeDetails.Builder clearLockedOrientation()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 |
CustomCreativeDetails.Builder |
This builder for chaining. |
clearSafeFrameCompatible()
public CustomCreativeDetails.Builder clearSafeFrameCompatible()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 |
CustomCreativeDetails.Builder |
This builder for chaining. |
clearThirdPartyImpressionTrackingUrls()
public CustomCreativeDetails.Builder clearThirdPartyImpressionTrackingUrls()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 |
CustomCreativeDetails.Builder |
This builder for chaining. |
getAmpHtmlSnippet()
public String getAmpHtmlSnippet()The AMP HTML snippet that this creative delivers.
optional string amp_html_snippet = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The ampHtmlSnippet. |
getAmpHtmlSnippetBytes()
public 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 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 |
|
getCustomCreativeAssetsBuilder(int index)
public CustomCreativeAsset.Builder getCustomCreativeAssetsBuilder(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.Builder |
|
getCustomCreativeAssetsBuilderList()
public List<CustomCreativeAsset.Builder> getCustomCreativeAssetsBuilderList()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<Builder> |
|
getCustomCreativeAssetsCount()
public 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 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 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 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> |
|
getDefaultInstanceForType()
public CustomCreativeDetails getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDestinationUrl()
public 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 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 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 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 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 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 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 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 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 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 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 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 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 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 ProtocolStringList 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 |
ProtocolStringList |
A list containing the thirdPartyImpressionTrackingUrls. |
hasAmpHtmlSnippet()
public 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 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 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 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 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(CustomCreativeDetails other)
public CustomCreativeDetails.Builder mergeFrom(CustomCreativeDetails other)| Parameter | |
|---|---|
| Name | Description |
other |
CustomCreativeDetails |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CustomCreativeDetails.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public CustomCreativeDetails.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
|
removeCustomCreativeAssets(int index)
public CustomCreativeDetails.Builder removeCustomCreativeAssets(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 |
CustomCreativeDetails.Builder |
|
setAmpHtmlSnippet(String value)
public CustomCreativeDetails.Builder setAmpHtmlSnippet(String value)The AMP HTML snippet that this creative delivers.
optional string amp_html_snippet = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe ampHtmlSnippet to set. |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
This builder for chaining. |
setAmpHtmlSnippetBytes(ByteString value)
public CustomCreativeDetails.Builder setAmpHtmlSnippetBytes(ByteString value)The AMP HTML snippet that this creative delivers.
optional string amp_html_snippet = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for ampHtmlSnippet to set. |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
This builder for chaining. |
setCustomCreativeAssets(int index, CustomCreativeAsset value)
public CustomCreativeDetails.Builder setCustomCreativeAssets(int index, CustomCreativeAsset value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
CustomCreativeAsset |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
|
setCustomCreativeAssets(int index, CustomCreativeAsset.Builder builderForValue)
public CustomCreativeDetails.Builder setCustomCreativeAssets(int index, CustomCreativeAsset.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
CustomCreativeAsset.Builder |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
|
setDestinationUrl(String value)
public CustomCreativeDetails.Builder setDestinationUrl(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe destinationUrl to set. |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
This builder for chaining. |
setDestinationUrlBytes(ByteString value)
public CustomCreativeDetails.Builder setDestinationUrlBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for destinationUrl to set. |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
This builder for chaining. |
setDestinationUrlType(CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType value)
public CustomCreativeDetails.Builder setDestinationUrlType(CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
CreativeDestinationUrlTypeEnum.CreativeDestinationUrlTypeThe destinationUrlType to set. |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
This builder for chaining. |
setDestinationUrlTypeValue(int value)
public CustomCreativeDetails.Builder setDestinationUrlTypeValue(int value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for destinationUrlType to set. |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
This builder for chaining. |
setEffectiveSafeFrameCompatible(boolean value)
public CustomCreativeDetails.Builder setEffectiveSafeFrameCompatible(boolean value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe effectiveSafeFrameCompatible to set. |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
This builder for chaining. |
setHtmlSnippet(String value)
public CustomCreativeDetails.Builder setHtmlSnippet(String value)Required. The HTML snippet that this creative delivers.
optional string html_snippet = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe htmlSnippet to set. |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
This builder for chaining. |
setHtmlSnippetBytes(ByteString value)
public CustomCreativeDetails.Builder setHtmlSnippetBytes(ByteString value)Required. The HTML snippet that this creative delivers.
optional string html_snippet = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for htmlSnippet to set. |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
This builder for chaining. |
setInterstitial(boolean value)
public CustomCreativeDetails.Builder setInterstitial(boolean value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe interstitial to set. |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
This builder for chaining. |
setLockedOrientation(CreativeLockedOrientationEnum.CreativeLockedOrientation value)
public CustomCreativeDetails.Builder setLockedOrientation(CreativeLockedOrientationEnum.CreativeLockedOrientation value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
CreativeLockedOrientationEnum.CreativeLockedOrientationThe lockedOrientation to set. |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
This builder for chaining. |
setLockedOrientationValue(int value)
public CustomCreativeDetails.Builder setLockedOrientationValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for lockedOrientation to set. |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
This builder for chaining. |
setSafeFrameCompatible(boolean value)
public CustomCreativeDetails.Builder setSafeFrameCompatible(boolean value)Input only. Whether the creative is compatible for SafeFrame rendering.
optional bool safe_frame_compatible = 5 [(.google.api.field_behavior) = INPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe safeFrameCompatible to set. |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
This builder for chaining. |
setThirdPartyImpressionTrackingUrls(int index, String value)
public CustomCreativeDetails.Builder setThirdPartyImpressionTrackingUrls(int index, String value)Optional. Impression tracking URLs to ping when this creative is displayed.
repeated string third_party_impression_tracking_urls = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe thirdPartyImpressionTrackingUrls to set. |
| Returns | |
|---|---|
| Type | Description |
CustomCreativeDetails.Builder |
This builder for chaining. |