Interface Html5CreativeDetailsOrBuilder (0.62.0)

public interface Html5CreativeDetailsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getHtml5Asset()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getSafeFrameCompatible()

public abstract 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.

getThirdPartyClickTrackingUrl()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>

A list containing the thirdPartyImpressionTrackingUrls.

hasHtml5Asset()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.