public final class CustomCreativeDetails extends GeneratedMessage implements CustomCreativeDetailsOrBuilder
A Creative that contains a custom HTML snippet and file assets.
Protobuf type google.ads.admanager.v1.CustomCreativeDetails
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
AMP_HTML_SNIPPET_FIELD_NUMBER
public static final int AMP_HTML_SNIPPET_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CUSTOM_CREATIVE_ASSETS_FIELD_NUMBER
public static final int CUSTOM_CREATIVE_ASSETS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESTINATION_URL_FIELD_NUMBER
public static final int DESTINATION_URL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESTINATION_URL_TYPE_FIELD_NUMBER
public static final int DESTINATION_URL_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EFFECTIVE_SAFE_FRAME_COMPATIBLE_FIELD_NUMBER
public static final int EFFECTIVE_SAFE_FRAME_COMPATIBLE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
HTML_SNIPPET_FIELD_NUMBER
public static final int HTML_SNIPPET_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
INTERSTITIAL_FIELD_NUMBER
public static final int INTERSTITIAL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LOCKED_ORIENTATION_FIELD_NUMBER
public static final int LOCKED_ORIENTATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SAFE_FRAME_COMPATIBLE_FIELD_NUMBER
public static final int SAFE_FRAME_COMPATIBLE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
THIRD_PARTY_IMPRESSION_TRACKING_URLS_FIELD_NUMBER
public static final int THIRD_PARTY_IMPRESSION_TRACKING_URLS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static CustomCreativeDetails getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CustomCreativeDetails.Builder newBuilder()
newBuilder(CustomCreativeDetails prototype)
public static CustomCreativeDetails.Builder newBuilder(CustomCreativeDetails prototype)
public static CustomCreativeDetails parseDelimitedFrom(InputStream input)
public static CustomCreativeDetails parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CustomCreativeDetails parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CustomCreativeDetails parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CustomCreativeDetails parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CustomCreativeDetails parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CustomCreativeDetails parseFrom(CodedInputStream input)
public static CustomCreativeDetails parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CustomCreativeDetails parseFrom(InputStream input)
public static CustomCreativeDetails parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CustomCreativeDetails parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CustomCreativeDetails parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CustomCreativeDetails> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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
|
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];
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
|
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()
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];
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];
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.
|
getParserForType()
public Parser<CustomCreativeDetails> getParserForType()
Overrides
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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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 |
int
The 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 |
int
The 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CustomCreativeDetails.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected CustomCreativeDetails.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public CustomCreativeDetails.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides