Class InternalRedirectCreativeDetails.Builder (0.62.0)

public static final class InternalRedirectCreativeDetails.Builder extends GeneratedMessage.Builder<InternalRedirectCreativeDetails.Builder> implements InternalRedirectCreativeDetailsOrBuilder

A Creative hosted by Campaign Manager 360.

Similar to third-party creatives, a Campaign Manager 360 tag is used to retrieve a creative asset. However, Campaign Manager 360 tags are not sent to the user's browser. Instead, they are processed internally within the Google Marketing Platform system.

Protobuf type google.ads.admanager.v1.InternalRedirectCreativeDetails

Static Methods

getDescriptor()

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

Methods

addAllThirdPartyImpressionTrackingUrls(Iterable<String> values)

public InternalRedirectCreativeDetails.Builder addAllThirdPartyImpressionTrackingUrls(Iterable<String> values)

Optional. Impression tracking URLs to ping when this creative is displayed.

repeated string third_party_impression_tracking_urls = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The thirdPartyImpressionTrackingUrls to add.

Returns
Type Description
InternalRedirectCreativeDetails.Builder

This builder for chaining.

addThirdPartyImpressionTrackingUrls(String value)

public InternalRedirectCreativeDetails.Builder addThirdPartyImpressionTrackingUrls(String value)

Optional. Impression tracking URLs to ping when this creative is displayed.

repeated string third_party_impression_tracking_urls = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The thirdPartyImpressionTrackingUrls to add.

Returns
Type Description
InternalRedirectCreativeDetails.Builder

This builder for chaining.

addThirdPartyImpressionTrackingUrlsBytes(ByteString value)

public InternalRedirectCreativeDetails.Builder addThirdPartyImpressionTrackingUrlsBytes(ByteString value)

Optional. Impression tracking URLs to ping when this creative is displayed.

repeated string third_party_impression_tracking_urls = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the thirdPartyImpressionTrackingUrls to add.

Returns
Type Description
InternalRedirectCreativeDetails.Builder

This builder for chaining.

build()

public InternalRedirectCreativeDetails build()
Returns
Type Description
InternalRedirectCreativeDetails

buildPartial()

public InternalRedirectCreativeDetails buildPartial()
Returns
Type Description
InternalRedirectCreativeDetails

clear()

public InternalRedirectCreativeDetails.Builder clear()
Returns
Type Description
InternalRedirectCreativeDetails.Builder
Overrides

clearAssetSize()

public InternalRedirectCreativeDetails.Builder clearAssetSize()

Output only. The asset size of an internal redirect creative. Note that this may differ from size if users set override_size to true.

optional .google.ads.admanager.v1.Size asset_size = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
InternalRedirectCreativeDetails.Builder

clearInternalRedirectUrl()

public InternalRedirectCreativeDetails.Builder clearInternalRedirectUrl()

Required. The internal redirect URL of the Campaign Manager 360 hosted creative. This attribute has a maximum length of 1024 characters.

optional string internal_redirect_url = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
InternalRedirectCreativeDetails.Builder

This builder for chaining.

clearInterstitial()

public InternalRedirectCreativeDetails.Builder clearInterstitial()

Optional. Whether this creative is interstitial.

optional bool interstitial = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
InternalRedirectCreativeDetails.Builder

This builder for chaining.

clearLockedOrientation()

public InternalRedirectCreativeDetails.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
InternalRedirectCreativeDetails.Builder

This builder for chaining.

clearOverrideSize()

public InternalRedirectCreativeDetails.Builder clearOverrideSize()

Optional. Allows the creative size to differ from the actual size specified in the internal redirect's url.

optional bool override_size = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
InternalRedirectCreativeDetails.Builder

This builder for chaining.

clearSslManualOverride()

public InternalRedirectCreativeDetails.Builder clearSslManualOverride()

Optional. The manual override for the SSL compatibility of this creative.

optional .google.ads.admanager.v1.CreativeSslOverrideEnum.CreativeSslOverride ssl_manual_override = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
InternalRedirectCreativeDetails.Builder

This builder for chaining.

clearSslScanResult()

public InternalRedirectCreativeDetails.Builder clearSslScanResult()

Output only. The SSL compatibility scan result of this creative.

optional .google.ads.admanager.v1.CreativeSslScanResultEnum.CreativeSslScanResult ssl_scan_result = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
InternalRedirectCreativeDetails.Builder

This builder for chaining.

clearThirdPartyImpressionTrackingUrls()

public InternalRedirectCreativeDetails.Builder clearThirdPartyImpressionTrackingUrls()

Optional. Impression tracking URLs to ping when this creative is displayed.

repeated string third_party_impression_tracking_urls = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
InternalRedirectCreativeDetails.Builder

This builder for chaining.

getAssetSize()

public Size getAssetSize()

Output only. The asset size of an internal redirect creative. Note that this may differ from size if users set override_size to true.

optional .google.ads.admanager.v1.Size asset_size = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Size

The assetSize.

getAssetSizeBuilder()

public Size.Builder getAssetSizeBuilder()

Output only. The asset size of an internal redirect creative. Note that this may differ from size if users set override_size to true.

optional .google.ads.admanager.v1.Size asset_size = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Size.Builder

getAssetSizeOrBuilder()

public SizeOrBuilder getAssetSizeOrBuilder()

Output only. The asset size of an internal redirect creative. Note that this may differ from size if users set override_size to true.

optional .google.ads.admanager.v1.Size asset_size = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SizeOrBuilder

getDefaultInstanceForType()

public InternalRedirectCreativeDetails getDefaultInstanceForType()
Returns
Type Description
InternalRedirectCreativeDetails

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getInternalRedirectUrl()

public String getInternalRedirectUrl()

Required. The internal redirect URL of the Campaign Manager 360 hosted creative. This attribute has a maximum length of 1024 characters.

optional string internal_redirect_url = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The internalRedirectUrl.

getInternalRedirectUrlBytes()

public ByteString getInternalRedirectUrlBytes()

Required. The internal redirect URL of the Campaign Manager 360 hosted creative. This attribute has a maximum length of 1024 characters.

optional string internal_redirect_url = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for internalRedirectUrl.

getInterstitial()

public boolean getInterstitial()

Optional. Whether this creative is interstitial.

optional bool interstitial = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The interstitial.

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 size specified in the internal redirect's url.

optional bool override_size = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The overrideSize.

getSslManualOverride()

public CreativeSslOverrideEnum.CreativeSslOverride getSslManualOverride()

Optional. The manual override for the SSL compatibility of this creative.

optional .google.ads.admanager.v1.CreativeSslOverrideEnum.CreativeSslOverride ssl_manual_override = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreativeSslOverrideEnum.CreativeSslOverride

The sslManualOverride.

getSslManualOverrideValue()

public int getSslManualOverrideValue()

Optional. The manual override for the SSL compatibility of this creative.

optional .google.ads.admanager.v1.CreativeSslOverrideEnum.CreativeSslOverride ssl_manual_override = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for sslManualOverride.

getSslScanResult()

public CreativeSslScanResultEnum.CreativeSslScanResult getSslScanResult()

Output only. The SSL compatibility scan result of this creative.

optional .google.ads.admanager.v1.CreativeSslScanResultEnum.CreativeSslScanResult ssl_scan_result = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CreativeSslScanResultEnum.CreativeSslScanResult

The sslScanResult.

getSslScanResultValue()

public int getSslScanResultValue()

Output only. The SSL compatibility scan result of this creative.

optional .google.ads.admanager.v1.CreativeSslScanResultEnum.CreativeSslScanResult ssl_scan_result = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for sslScanResult.

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 = 8 [(.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 = 8 [(.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 = 8 [(.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 = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the thirdPartyImpressionTrackingUrls.

hasAssetSize()

public boolean hasAssetSize()

Output only. The asset size of an internal redirect creative. Note that this may differ from size if users set override_size to true.

optional .google.ads.admanager.v1.Size asset_size = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the assetSize field is set.

hasInternalRedirectUrl()

public boolean hasInternalRedirectUrl()

Required. The internal redirect URL of the Campaign Manager 360 hosted creative. This attribute has a maximum length of 1024 characters.

optional string internal_redirect_url = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the internalRedirectUrl field is set.

hasInterstitial()

public boolean hasInterstitial()

Optional. Whether this creative is interstitial.

optional bool interstitial = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the interstitial 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 size specified in the internal redirect's url.

optional bool override_size = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the overrideSize field is set.

hasSslManualOverride()

public boolean hasSslManualOverride()

Optional. The manual override for the SSL compatibility of this creative.

optional .google.ads.admanager.v1.CreativeSslOverrideEnum.CreativeSslOverride ssl_manual_override = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the sslManualOverride field is set.

hasSslScanResult()

public boolean hasSslScanResult()

Output only. The SSL compatibility scan result of this creative.

optional .google.ads.admanager.v1.CreativeSslScanResultEnum.CreativeSslScanResult ssl_scan_result = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the sslScanResult field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAssetSize(Size value)

public InternalRedirectCreativeDetails.Builder mergeAssetSize(Size value)

Output only. The asset size of an internal redirect creative. Note that this may differ from size if users set override_size to true.

optional .google.ads.admanager.v1.Size asset_size = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Size
Returns
Type Description
InternalRedirectCreativeDetails.Builder

mergeFrom(InternalRedirectCreativeDetails other)

public InternalRedirectCreativeDetails.Builder mergeFrom(InternalRedirectCreativeDetails other)
Parameter
Name Description
other InternalRedirectCreativeDetails
Returns
Type Description
InternalRedirectCreativeDetails.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public InternalRedirectCreativeDetails.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
InternalRedirectCreativeDetails.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public InternalRedirectCreativeDetails.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
InternalRedirectCreativeDetails.Builder
Overrides

setAssetSize(Size value)

public InternalRedirectCreativeDetails.Builder setAssetSize(Size value)

Output only. The asset size of an internal redirect creative. Note that this may differ from size if users set override_size to true.

optional .google.ads.admanager.v1.Size asset_size = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Size
Returns
Type Description
InternalRedirectCreativeDetails.Builder

setAssetSize(Size.Builder builderForValue)

public InternalRedirectCreativeDetails.Builder setAssetSize(Size.Builder builderForValue)

Output only. The asset size of an internal redirect creative. Note that this may differ from size if users set override_size to true.

optional .google.ads.admanager.v1.Size asset_size = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Size.Builder
Returns
Type Description
InternalRedirectCreativeDetails.Builder

setInternalRedirectUrl(String value)

public InternalRedirectCreativeDetails.Builder setInternalRedirectUrl(String value)

Required. The internal redirect URL of the Campaign Manager 360 hosted creative. This attribute has a maximum length of 1024 characters.

optional string internal_redirect_url = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The internalRedirectUrl to set.

Returns
Type Description
InternalRedirectCreativeDetails.Builder

This builder for chaining.

setInternalRedirectUrlBytes(ByteString value)

public InternalRedirectCreativeDetails.Builder setInternalRedirectUrlBytes(ByteString value)

Required. The internal redirect URL of the Campaign Manager 360 hosted creative. This attribute has a maximum length of 1024 characters.

optional string internal_redirect_url = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for internalRedirectUrl to set.

Returns
Type Description
InternalRedirectCreativeDetails.Builder

This builder for chaining.

setInterstitial(boolean value)

public InternalRedirectCreativeDetails.Builder setInterstitial(boolean value)

Optional. Whether this creative is interstitial.

optional bool interstitial = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The interstitial to set.

Returns
Type Description
InternalRedirectCreativeDetails.Builder

This builder for chaining.

setLockedOrientation(CreativeLockedOrientationEnum.CreativeLockedOrientation value)

public InternalRedirectCreativeDetails.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.CreativeLockedOrientation

The lockedOrientation to set.

Returns
Type Description
InternalRedirectCreativeDetails.Builder

This builder for chaining.

setLockedOrientationValue(int value)

public InternalRedirectCreativeDetails.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 int

The enum numeric value on the wire for lockedOrientation to set.

Returns
Type Description
InternalRedirectCreativeDetails.Builder

This builder for chaining.

setOverrideSize(boolean value)

public InternalRedirectCreativeDetails.Builder setOverrideSize(boolean value)

Optional. Allows the creative size to differ from the actual size specified in the internal redirect's url.

optional bool override_size = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The overrideSize to set.

Returns
Type Description
InternalRedirectCreativeDetails.Builder

This builder for chaining.

setSslManualOverride(CreativeSslOverrideEnum.CreativeSslOverride value)

public InternalRedirectCreativeDetails.Builder setSslManualOverride(CreativeSslOverrideEnum.CreativeSslOverride value)

Optional. The manual override for the SSL compatibility of this creative.

optional .google.ads.admanager.v1.CreativeSslOverrideEnum.CreativeSslOverride ssl_manual_override = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value CreativeSslOverrideEnum.CreativeSslOverride

The sslManualOverride to set.

Returns
Type Description
InternalRedirectCreativeDetails.Builder

This builder for chaining.

setSslManualOverrideValue(int value)

public InternalRedirectCreativeDetails.Builder setSslManualOverrideValue(int value)

Optional. The manual override for the SSL compatibility of this creative.

optional .google.ads.admanager.v1.CreativeSslOverrideEnum.CreativeSslOverride ssl_manual_override = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for sslManualOverride to set.

Returns
Type Description
InternalRedirectCreativeDetails.Builder

This builder for chaining.

setSslScanResult(CreativeSslScanResultEnum.CreativeSslScanResult value)

public InternalRedirectCreativeDetails.Builder setSslScanResult(CreativeSslScanResultEnum.CreativeSslScanResult value)

Output only. The SSL compatibility scan result of this creative.

optional .google.ads.admanager.v1.CreativeSslScanResultEnum.CreativeSslScanResult ssl_scan_result = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value CreativeSslScanResultEnum.CreativeSslScanResult

The sslScanResult to set.

Returns
Type Description
InternalRedirectCreativeDetails.Builder

This builder for chaining.

setSslScanResultValue(int value)

public InternalRedirectCreativeDetails.Builder setSslScanResultValue(int value)

Output only. The SSL compatibility scan result of this creative.

optional .google.ads.admanager.v1.CreativeSslScanResultEnum.CreativeSslScanResult ssl_scan_result = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for sslScanResult to set.

Returns
Type Description
InternalRedirectCreativeDetails.Builder

This builder for chaining.

setThirdPartyImpressionTrackingUrls(int index, String value)

public InternalRedirectCreativeDetails.Builder setThirdPartyImpressionTrackingUrls(int index, String value)

Optional. Impression tracking URLs to ping when this creative is displayed.

repeated string third_party_impression_tracking_urls = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value String

The thirdPartyImpressionTrackingUrls to set.

Returns
Type Description
InternalRedirectCreativeDetails.Builder

This builder for chaining.