public final class ImageCreativeDetails extends GeneratedMessage implements ImageCreativeDetailsOrBuilder
A Creative that displays an image.
Protobuf type google.ads.admanager.v1.ImageCreativeDetails
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
ALT_TEXT_FIELD_NUMBER
public static final int ALT_TEXT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
AMP_DESTINATION_URL_FIELD_NUMBER
public static final int AMP_DESTINATION_URL_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 |
|
LOCKED_ORIENTATION_FIELD_NUMBER
public static final int LOCKED_ORIENTATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
OVERRIDE_SIZE_FIELD_NUMBER
public static final int OVERRIDE_SIZE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PRIMARY_IMAGE_ASSET_FIELD_NUMBER
public static final int PRIMARY_IMAGE_ASSET_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SECONDARY_IMAGE_ASSETS_FIELD_NUMBER
public static final int SECONDARY_IMAGE_ASSETS_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 ImageCreativeDetails getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ImageCreativeDetails.Builder newBuilder()
newBuilder(ImageCreativeDetails prototype)
public static ImageCreativeDetails.Builder newBuilder(ImageCreativeDetails prototype)
public static ImageCreativeDetails parseDelimitedFrom(InputStream input)
public static ImageCreativeDetails parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ImageCreativeDetails parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ImageCreativeDetails parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ImageCreativeDetails parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ImageCreativeDetails parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ImageCreativeDetails parseFrom(CodedInputStream input)
public static ImageCreativeDetails parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ImageCreativeDetails parseFrom(InputStream input)
public static ImageCreativeDetails parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ImageCreativeDetails parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ImageCreativeDetails parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ImageCreativeDetails> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAltText()
public String getAltText()
Alternative text to be rendered along with the creative used mainly for
accessibility. This field has a maximum length of 500
characters.
optional string alt_text = 1;
| Returns |
| Type |
Description |
String |
The altText.
|
getAltTextBytes()
public ByteString getAltTextBytes()
Alternative text to be rendered along with the creative used mainly for
accessibility. This field has a maximum length of 500
characters.
optional string alt_text = 1;
| Returns |
| Type |
Description |
ByteString |
The bytes for altText.
|
getAmpDestinationUrl()
public String getAmpDestinationUrl()
Optional. The AMP destination URL for this creative. This must be a valid
URL, including the http:// or https:// scheme.
optional string amp_destination_url = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The ampDestinationUrl.
|
getAmpDestinationUrlBytes()
public ByteString getAmpDestinationUrlBytes()
Optional. The AMP destination URL for this creative. This must be a valid
URL, including the http:// or https:// scheme.
optional string amp_destination_url = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for ampDestinationUrl.
|
getDefaultInstanceForType()
public ImageCreativeDetails 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 = 8 [(.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 = 8 [(.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 = 9 [(.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 = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for destinationUrlType.
|
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 = 5 [(.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 = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for lockedOrientation.
|
getOverrideSize()
public boolean getOverrideSize()
Optional. Allows the creative size to differ from the actual image asset
size.
optional bool override_size = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The overrideSize.
|
getParserForType()
public Parser<ImageCreativeDetails> getParserForType()
Overrides
getPrimaryImageAsset()
public CreativeAsset getPrimaryImageAsset()
The primary image asset associated with this creative. This attribute is
required.
.google.ads.admanager.v1.CreativeAsset primary_image_asset = 6;
getPrimaryImageAssetOrBuilder()
public CreativeAssetOrBuilder getPrimaryImageAssetOrBuilder()
The primary image asset associated with this creative. This attribute is
required.
.google.ads.admanager.v1.CreativeAsset primary_image_asset = 6;
getSecondaryImageAssets(int index)
public CreativeAsset getSecondaryImageAssets(int index)
Secondary image assets associated with this creative. This
attribute is optional.
Secondary image assets can be used to store different resolution versions
of the primary asset for use on non-standard density screens.
repeated .google.ads.admanager.v1.CreativeAsset secondary_image_assets = 7;
| Parameter |
| Name |
Description |
index |
int
|
getSecondaryImageAssetsCount()
public int getSecondaryImageAssetsCount()
Secondary image assets associated with this creative. This
attribute is optional.
Secondary image assets can be used to store different resolution versions
of the primary asset for use on non-standard density screens.
repeated .google.ads.admanager.v1.CreativeAsset secondary_image_assets = 7;
| Returns |
| Type |
Description |
int |
|
getSecondaryImageAssetsList()
public List<CreativeAsset> getSecondaryImageAssetsList()
Secondary image assets associated with this creative. This
attribute is optional.
Secondary image assets can be used to store different resolution versions
of the primary asset for use on non-standard density screens.
repeated .google.ads.admanager.v1.CreativeAsset secondary_image_assets = 7;
getSecondaryImageAssetsOrBuilder(int index)
public CreativeAssetOrBuilder getSecondaryImageAssetsOrBuilder(int index)
Secondary image assets associated with this creative. This
attribute is optional.
Secondary image assets can be used to store different resolution versions
of the primary asset for use on non-standard density screens.
repeated .google.ads.admanager.v1.CreativeAsset secondary_image_assets = 7;
| Parameter |
| Name |
Description |
index |
int
|
getSecondaryImageAssetsOrBuilderList()
public List<? extends CreativeAssetOrBuilder> getSecondaryImageAssetsOrBuilderList()
Secondary image assets associated with this creative. This
attribute is optional.
Secondary image assets can be used to store different resolution versions
of the primary asset for use on non-standard density screens.
repeated .google.ads.admanager.v1.CreativeAsset secondary_image_assets = 7;
| Returns |
| Type |
Description |
List<? extends com.google.ads.admanager.v1.CreativeAssetOrBuilder> |
|
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 = 3 [(.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 = 3 [(.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 = 3 [(.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 = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ProtocolStringList |
A list containing the thirdPartyImpressionTrackingUrls.
|
hasAltText()
public boolean hasAltText()
Alternative text to be rendered along with the creative used mainly for
accessibility. This field has a maximum length of 500
characters.
optional string alt_text = 1;
| Returns |
| Type |
Description |
boolean |
Whether the altText field is set.
|
hasAmpDestinationUrl()
public boolean hasAmpDestinationUrl()
Optional. The AMP destination URL for this creative. This must be a valid
URL, including the http:// or https:// scheme.
optional string amp_destination_url = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the ampDestinationUrl 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 = 8 [(.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 = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the destinationUrlType 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 = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the lockedOrientation field is set.
|
hasOverrideSize()
public boolean hasOverrideSize()
Optional. Allows the creative size to differ from the actual image asset
size.
optional bool override_size = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the overrideSize field is set.
|
hasPrimaryImageAsset()
public boolean hasPrimaryImageAsset()
The primary image asset associated with this creative. This attribute is
required.
.google.ads.admanager.v1.CreativeAsset primary_image_asset = 6;
| Returns |
| Type |
Description |
boolean |
Whether the primaryImageAsset field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ImageCreativeDetails.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected ImageCreativeDetails.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public ImageCreativeDetails.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides