Class InternalRedirectCreativeDetails (0.62.0)

public final class InternalRedirectCreativeDetails extends GeneratedMessage 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > InternalRedirectCreativeDetails

Static Fields

ASSET_SIZE_FIELD_NUMBER

public static final int ASSET_SIZE_FIELD_NUMBER
Field Value
Type Description
int

INTERNAL_REDIRECT_URL_FIELD_NUMBER

public static final int INTERNAL_REDIRECT_URL_FIELD_NUMBER
Field Value
Type Description
int

INTERSTITIAL_FIELD_NUMBER

public static final int INTERSTITIAL_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

SSL_MANUAL_OVERRIDE_FIELD_NUMBER

public static final int SSL_MANUAL_OVERRIDE_FIELD_NUMBER
Field Value
Type Description
int

SSL_SCAN_RESULT_FIELD_NUMBER

public static final int SSL_SCAN_RESULT_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 InternalRedirectCreativeDetails getDefaultInstance()
Returns
Type Description
InternalRedirectCreativeDetails

getDescriptor()

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

newBuilder()

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

newBuilder(InternalRedirectCreativeDetails prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

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.

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

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.

getParserForType()

public Parser<InternalRedirectCreativeDetails> getParserForType()
Returns
Type Description
Parser<InternalRedirectCreativeDetails>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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 InternalRedirectCreativeDetails.Builder newBuilderForType()
Returns
Type Description
InternalRedirectCreativeDetails.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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