public final class Html5CreativeDetails extends GeneratedMessage implements Html5CreativeDetailsOrBuilder
A Creative that contains a zipped HTML5 bundle asset, a list of third party
impression trackers, and a third party click tracker.
Protobuf type google.ads.admanager.v1.Html5CreativeDetails
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
HTML5_ASSET_FIELD_NUMBER
public static final int HTML5_ASSET_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 |
|
SAFE_FRAME_COMPATIBLE_FIELD_NUMBER
public static final int SAFE_FRAME_COMPATIBLE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
THIRD_PARTY_CLICK_TRACKING_URL_FIELD_NUMBER
public static final int THIRD_PARTY_CLICK_TRACKING_URL_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 Html5CreativeDetails getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Html5CreativeDetails.Builder newBuilder()
newBuilder(Html5CreativeDetails prototype)
public static Html5CreativeDetails.Builder newBuilder(Html5CreativeDetails prototype)
public static Html5CreativeDetails parseDelimitedFrom(InputStream input)
public static Html5CreativeDetails parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Html5CreativeDetails parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Html5CreativeDetails parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Html5CreativeDetails parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Html5CreativeDetails parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Html5CreativeDetails parseFrom(CodedInputStream input)
public static Html5CreativeDetails parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Html5CreativeDetails parseFrom(InputStream input)
public static Html5CreativeDetails parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Html5CreativeDetails parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Html5CreativeDetails parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Html5CreativeDetails> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public Html5CreativeDetails getDefaultInstanceForType()
getHtml5Asset()
public CreativeAsset getHtml5Asset()
Required. The HTML5 asset. To preview the HTML5 asset, use the
CreativeAsset.asset_url. In this field, the
CreativeAsset.asset_byte_array must be a zip bundle and the
CreativeAsset.file_name must have a zip extension.
optional .google.ads.admanager.v1.CreativeAsset html5_asset = 8 [(.google.api.field_behavior) = REQUIRED];
getHtml5AssetOrBuilder()
public CreativeAssetOrBuilder getHtml5AssetOrBuilder()
Required. The HTML5 asset. To preview the HTML5 asset, use the
CreativeAsset.asset_url. In this field, the
CreativeAsset.asset_byte_array must be a zip bundle and the
CreativeAsset.file_name must have a zip extension.
optional .google.ads.admanager.v1.CreativeAsset html5_asset = 8 [(.google.api.field_behavior) = REQUIRED];
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 = 1 [(.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 = 1 [(.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 HTML5 asset
size.
optional bool override_size = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The overrideSize.
|
getParserForType()
public Parser<Html5CreativeDetails> getParserForType()
Overrides
getSafeFrameCompatible()
public boolean getSafeFrameCompatible()
Optional. Whether the creative is compatible for SafeFrame rendering.
optional bool safe_frame_compatible = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The safeFrameCompatible.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getThirdPartyClickTrackingUrl()
public String getThirdPartyClickTrackingUrl()
Optional. A click tracking URL to ping when this creative is clicked.
optional string third_party_click_tracking_url = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The thirdPartyClickTrackingUrl.
|
getThirdPartyClickTrackingUrlBytes()
public ByteString getThirdPartyClickTrackingUrlBytes()
Optional. A click tracking URL to ping when this creative is clicked.
optional string third_party_click_tracking_url = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for thirdPartyClickTrackingUrl.
|
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.
|
hasHtml5Asset()
public boolean hasHtml5Asset()
Required. The HTML5 asset. To preview the HTML5 asset, use the
CreativeAsset.asset_url. In this field, the
CreativeAsset.asset_byte_array must be a zip bundle and the
CreativeAsset.file_name must have a zip extension.
optional .google.ads.admanager.v1.CreativeAsset html5_asset = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the html5Asset 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 = 1 [(.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 HTML5 asset
size.
optional bool override_size = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the overrideSize field is set.
|
hasSafeFrameCompatible()
public boolean hasSafeFrameCompatible()
Optional. Whether the creative is compatible for SafeFrame rendering.
optional bool safe_frame_compatible = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the safeFrameCompatible field is set.
|
hasThirdPartyClickTrackingUrl()
public boolean hasThirdPartyClickTrackingUrl()
Optional. A click tracking URL to ping when this creative is clicked.
optional string third_party_click_tracking_url = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the thirdPartyClickTrackingUrl field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Html5CreativeDetails.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected Html5CreativeDetails.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public Html5CreativeDetails.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides