Class ThirdPartyCreativeDetails (0.62.0)

public final class ThirdPartyCreativeDetails extends GeneratedMessage implements ThirdPartyCreativeDetailsOrBuilder

A Creative that is served by a 3rd-party vendor.

Protobuf type google.ads.admanager.v1.ThirdPartyCreativeDetails

Static Fields

AMP_REDIRECT_URL_FIELD_NUMBER

public static final int AMP_REDIRECT_URL_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_URL_FIELD_NUMBER

public static final int DESTINATION_URL_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_URL_TYPE_FIELD_NUMBER

public static final int DESTINATION_URL_TYPE_FIELD_NUMBER
Field Value
Type Description
int

EXPANDED_SNIPPET_FIELD_NUMBER

public static final int EXPANDED_SNIPPET_FIELD_NUMBER
Field Value
Type Description
int

LOCKED_ORIENTATION_FIELD_NUMBER

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

SNIPPET_FIELD_NUMBER

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

getDescriptor()

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

newBuilder()

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

newBuilder(ThirdPartyCreativeDetails prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAmpRedirectUrl()

public String getAmpRedirectUrl()

Optional. The URL of the AMP creative.

optional string amp_redirect_url = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The ampRedirectUrl.

getAmpRedirectUrlBytes()

public ByteString getAmpRedirectUrlBytes()

Optional. The URL of the AMP creative.

optional string amp_redirect_url = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for ampRedirectUrl.

getDefaultInstanceForType()

public ThirdPartyCreativeDetails getDefaultInstanceForType()
Returns
Type Description
ThirdPartyCreativeDetails

getDestinationUrl()

public String getDestinationUrl()

Optional. The URL that the user is directed to if they click on the creative. This attribute is required unless the destinationUrlType is NONE, and has a maximum length of 1024 characters.

optional string destination_url = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The destinationUrl.

getDestinationUrlBytes()

public ByteString getDestinationUrlBytes()

Optional. The URL that the user is directed to if they click on the creative. This attribute is required unless the destinationUrlType is NONE, and has a maximum length of 1024 characters.

optional string destination_url = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for destinationUrl.

getDestinationUrlType()

public CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType getDestinationUrlType()

Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to CLICK_TO_WEB.

optional .google.ads.admanager.v1.CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType destination_url_type = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType

The destinationUrlType.

getDestinationUrlTypeValue()

public int getDestinationUrlTypeValue()

Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to CLICK_TO_WEB.

optional .google.ads.admanager.v1.CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType destination_url_type = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for destinationUrlType.

getExpandedSnippet()

public String getExpandedSnippet()

Output only. The HTML snippet that this creative delivers with macros expanded.

optional string expanded_snippet = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The expandedSnippet.

getExpandedSnippetBytes()

public ByteString getExpandedSnippetBytes()

Output only. The HTML snippet that this creative delivers with macros expanded.

optional string expanded_snippet = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for expandedSnippet.

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.

getParserForType()

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

getSafeFrameCompatible()

public boolean getSafeFrameCompatible()

Optional. Whether the Creative is compatible for SafeFrame rendering.

optional bool safe_frame_compatible = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The safeFrameCompatible.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSnippet()

public String getSnippet()

The HTML snippet that this creative delivers.

optional string snippet = 4;

Returns
Type Description
String

The snippet.

getSnippetBytes()

public ByteString getSnippetBytes()

The HTML snippet that this creative delivers.

optional string snippet = 4;

Returns
Type Description
ByteString

The bytes for snippet.

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 = 3 [(.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 = 3 [(.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 = 2 [(.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 = 2 [(.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. A list of impression tracking URLs to ping when this creative is displayed.

repeated string third_party_impression_tracking_urls = 7 [(.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. A list of impression tracking URLs to ping when this creative is displayed.

repeated string third_party_impression_tracking_urls = 7 [(.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. A list of impression tracking URLs to ping when this creative is displayed.

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

Returns
Type Description
int

The count of thirdPartyImpressionTrackingUrls.

getThirdPartyImpressionTrackingUrlsList()

public ProtocolStringList getThirdPartyImpressionTrackingUrlsList()

Optional. A list of impression tracking URLs to ping when this creative is displayed.

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

Returns
Type Description
ProtocolStringList

A list containing the thirdPartyImpressionTrackingUrls.

hasAmpRedirectUrl()

public boolean hasAmpRedirectUrl()

Optional. The URL of the AMP creative.

optional string amp_redirect_url = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the ampRedirectUrl field is set.

hasDestinationUrl()

public boolean hasDestinationUrl()

Optional. The URL that the user is directed to if they click on the creative. This attribute is required unless the destinationUrlType is NONE, and has a maximum length of 1024 characters.

optional string destination_url = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the destinationUrl field is set.

hasDestinationUrlType()

public boolean hasDestinationUrlType()

Optional. The action that should be performed if the user clicks on the creative. This attribute defaults to CLICK_TO_WEB.

optional .google.ads.admanager.v1.CreativeDestinationUrlTypeEnum.CreativeDestinationUrlType destination_url_type = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the destinationUrlType field is set.

hasExpandedSnippet()

public boolean hasExpandedSnippet()

Output only. The HTML snippet that this creative delivers with macros expanded.

optional string expanded_snippet = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the expandedSnippet 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.

hasSafeFrameCompatible()

public boolean hasSafeFrameCompatible()

Optional. Whether the Creative is compatible for SafeFrame rendering.

optional bool safe_frame_compatible = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the safeFrameCompatible field is set.

hasSnippet()

public boolean hasSnippet()

The HTML snippet that this creative delivers.

optional string snippet = 4;

Returns
Type Description
boolean

Whether the snippet 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 = 3 [(.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 = 2 [(.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 ThirdPartyCreativeDetails.Builder newBuilderForType()
Returns
Type Description
ThirdPartyCreativeDetails.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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