public static final class Html5CreativeDetails.Builder extends GeneratedMessage.Builder<Html5CreativeDetails.Builder> implements Html5CreativeDetailsOrBuilderA 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
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > Html5CreativeDetails.BuilderImplements
Html5CreativeDetailsOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllThirdPartyImpressionTrackingUrls(Iterable<String> values)
public Html5CreativeDetails.Builder addAllThirdPartyImpressionTrackingUrls(Iterable<String> values)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 |
values |
Iterable<String>The thirdPartyImpressionTrackingUrls to add. |
| Returns | |
|---|---|
| Type | Description |
Html5CreativeDetails.Builder |
This builder for chaining. |
addThirdPartyImpressionTrackingUrls(String value)
public Html5CreativeDetails.Builder addThirdPartyImpressionTrackingUrls(String value)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 |
value |
StringThe thirdPartyImpressionTrackingUrls to add. |
| Returns | |
|---|---|
| Type | Description |
Html5CreativeDetails.Builder |
This builder for chaining. |
addThirdPartyImpressionTrackingUrlsBytes(ByteString value)
public Html5CreativeDetails.Builder addThirdPartyImpressionTrackingUrlsBytes(ByteString value)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 |
value |
ByteStringThe bytes of the thirdPartyImpressionTrackingUrls to add. |
| Returns | |
|---|---|
| Type | Description |
Html5CreativeDetails.Builder |
This builder for chaining. |
build()
public Html5CreativeDetails build()| Returns | |
|---|---|
| Type | Description |
Html5CreativeDetails |
|
buildPartial()
public Html5CreativeDetails buildPartial()| Returns | |
|---|---|
| Type | Description |
Html5CreativeDetails |
|
clear()
public Html5CreativeDetails.Builder clear()| Returns | |
|---|---|
| Type | Description |
Html5CreativeDetails.Builder |
|
clearHtml5Asset()
public Html5CreativeDetails.Builder clearHtml5Asset() 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 |
Html5CreativeDetails.Builder |
|
clearLockedOrientation()
public Html5CreativeDetails.Builder clearLockedOrientation()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 |
Html5CreativeDetails.Builder |
This builder for chaining. |
clearOverrideSize()
public Html5CreativeDetails.Builder clearOverrideSize()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 |
Html5CreativeDetails.Builder |
This builder for chaining. |
clearSafeFrameCompatible()
public Html5CreativeDetails.Builder clearSafeFrameCompatible()Optional. Whether the creative is compatible for SafeFrame rendering.
optional bool safe_frame_compatible = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Html5CreativeDetails.Builder |
This builder for chaining. |
clearThirdPartyClickTrackingUrl()
public Html5CreativeDetails.Builder clearThirdPartyClickTrackingUrl()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 |
Html5CreativeDetails.Builder |
This builder for chaining. |
clearThirdPartyImpressionTrackingUrls()
public Html5CreativeDetails.Builder clearThirdPartyImpressionTrackingUrls()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 |
Html5CreativeDetails.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public Html5CreativeDetails getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Html5CreativeDetails |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getHtml5AssetBuilder()
public CreativeAsset.Builder getHtml5AssetBuilder() 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.Builder |
|
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. |
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. |
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 |
intThe 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 |
intThe 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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(Html5CreativeDetails other)
public Html5CreativeDetails.Builder mergeFrom(Html5CreativeDetails other)| Parameter | |
|---|---|
| Name | Description |
other |
Html5CreativeDetails |
| Returns | |
|---|---|
| Type | Description |
Html5CreativeDetails.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Html5CreativeDetails.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Html5CreativeDetails.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Html5CreativeDetails.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Html5CreativeDetails.Builder |
|
mergeHtml5Asset(CreativeAsset value)
public Html5CreativeDetails.Builder mergeHtml5Asset(CreativeAsset value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
CreativeAsset |
| Returns | |
|---|---|
| Type | Description |
Html5CreativeDetails.Builder |
|
setHtml5Asset(CreativeAsset value)
public Html5CreativeDetails.Builder setHtml5Asset(CreativeAsset value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
CreativeAsset |
| Returns | |
|---|---|
| Type | Description |
Html5CreativeDetails.Builder |
|
setHtml5Asset(CreativeAsset.Builder builderForValue)
public Html5CreativeDetails.Builder setHtml5Asset(CreativeAsset.Builder builderForValue) 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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CreativeAsset.Builder |
| Returns | |
|---|---|
| Type | Description |
Html5CreativeDetails.Builder |
|
setLockedOrientation(CreativeLockedOrientationEnum.CreativeLockedOrientation value)
public Html5CreativeDetails.Builder setLockedOrientation(CreativeLockedOrientationEnum.CreativeLockedOrientation value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
CreativeLockedOrientationEnum.CreativeLockedOrientationThe lockedOrientation to set. |
| Returns | |
|---|---|
| Type | Description |
Html5CreativeDetails.Builder |
This builder for chaining. |
setLockedOrientationValue(int value)
public Html5CreativeDetails.Builder setLockedOrientationValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for lockedOrientation to set. |
| Returns | |
|---|---|
| Type | Description |
Html5CreativeDetails.Builder |
This builder for chaining. |
setOverrideSize(boolean value)
public Html5CreativeDetails.Builder setOverrideSize(boolean value)Optional. Allows the creative size to differ from the actual HTML5 asset size.
optional bool override_size = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe overrideSize to set. |
| Returns | |
|---|---|
| Type | Description |
Html5CreativeDetails.Builder |
This builder for chaining. |
setSafeFrameCompatible(boolean value)
public Html5CreativeDetails.Builder setSafeFrameCompatible(boolean value)Optional. Whether the creative is compatible for SafeFrame rendering.
optional bool safe_frame_compatible = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe safeFrameCompatible to set. |
| Returns | |
|---|---|
| Type | Description |
Html5CreativeDetails.Builder |
This builder for chaining. |
setThirdPartyClickTrackingUrl(String value)
public Html5CreativeDetails.Builder setThirdPartyClickTrackingUrl(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe thirdPartyClickTrackingUrl to set. |
| Returns | |
|---|---|
| Type | Description |
Html5CreativeDetails.Builder |
This builder for chaining. |
setThirdPartyClickTrackingUrlBytes(ByteString value)
public Html5CreativeDetails.Builder setThirdPartyClickTrackingUrlBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for thirdPartyClickTrackingUrl to set. |
| Returns | |
|---|---|
| Type | Description |
Html5CreativeDetails.Builder |
This builder for chaining. |
setThirdPartyImpressionTrackingUrls(int index, String value)
public Html5CreativeDetails.Builder setThirdPartyImpressionTrackingUrls(int index, String value)Optional. Impression tracking URLs to ping when this creative is displayed.
repeated string third_party_impression_tracking_urls = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe thirdPartyImpressionTrackingUrls to set. |
| Returns | |
|---|---|
| Type | Description |
Html5CreativeDetails.Builder |
This builder for chaining. |