Class Html5CreativeDetails (0.62.0)

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

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()
Returns
Type Description
Html5CreativeDetails

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Html5CreativeDetails.Builder newBuilder()
Returns
Type Description
Html5CreativeDetails.Builder

newBuilder(Html5CreativeDetails prototype)

public static Html5CreativeDetails.Builder newBuilder(Html5CreativeDetails prototype)
Parameter
Name Description
prototype Html5CreativeDetails
Returns
Type Description
Html5CreativeDetails.Builder

parseDelimitedFrom(InputStream input)

public static Html5CreativeDetails parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Html5CreativeDetails
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Html5CreativeDetails parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Html5CreativeDetails
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Html5CreativeDetails parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Html5CreativeDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Html5CreativeDetails parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Html5CreativeDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Html5CreativeDetails parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Html5CreativeDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Html5CreativeDetails parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Html5CreativeDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Html5CreativeDetails parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Html5CreativeDetails
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Html5CreativeDetails parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Html5CreativeDetails
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Html5CreativeDetails parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Html5CreativeDetails
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Html5CreativeDetails parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Html5CreativeDetails
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Html5CreativeDetails parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Html5CreativeDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Html5CreativeDetails parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Html5CreativeDetails
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Html5CreativeDetails> parser()
Returns
Type Description
Parser<Html5CreativeDetails>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Html5CreativeDetails getDefaultInstanceForType()
Returns
Type Description
Html5CreativeDetails

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];

Returns
Type Description
CreativeAsset

The html5Asset.

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];

Returns
Type Description
CreativeAssetOrBuilder

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];

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 = 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()
Returns
Type Description
Parser<Html5CreativeDetails>
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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Html5CreativeDetails.Builder newBuilderForType()
Returns
Type Description
Html5CreativeDetails.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Html5CreativeDetails.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Html5CreativeDetails.Builder
Overrides

toBuilder()

public Html5CreativeDetails.Builder toBuilder()
Returns
Type Description
Html5CreativeDetails.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException