Class VastRedirectCreativeDetails (0.62.0)

public final class VastRedirectCreativeDetails extends GeneratedMessage implements VastRedirectCreativeDetailsOrBuilder

A Creative that points to an externally hosted VAST ad and is served via VAST XML as a VAST Wrapper.

Protobuf type google.ads.admanager.v1.VastRedirectCreativeDetails

Static Fields

AUDIO_FIELD_NUMBER

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

DURATION_FIELD_NUMBER

public static final int DURATION_FIELD_NUMBER
Field Value
Type Description
int

PROGRAMMATIC_DEMAND_SOURCE_FIELD_NUMBER

public static final int PROGRAMMATIC_DEMAND_SOURCE_FIELD_NUMBER
Field Value
Type Description
int

SERVER_SIDE_UNWRAPPING_DISABLED_FIELD_NUMBER

public static final int SERVER_SIDE_UNWRAPPING_DISABLED_FIELD_NUMBER
Field Value
Type Description
int

TRACKING_URLS_FIELD_NUMBER

public static final int TRACKING_URLS_FIELD_NUMBER
Field Value
Type Description
int

VAST_PREVIEW_URL_FIELD_NUMBER

public static final int VAST_PREVIEW_URL_FIELD_NUMBER
Field Value
Type Description
int

VAST_PRICING_ENABLED_FIELD_NUMBER

public static final int VAST_PRICING_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

VAST_REDIRECT_TYPE_FIELD_NUMBER

public static final int VAST_REDIRECT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

VAST_XML_URL_FIELD_NUMBER

public static final int VAST_XML_URL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static VastRedirectCreativeDetails getDefaultInstance()
Returns
Type Description
VastRedirectCreativeDetails

getDescriptor()

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

newBuilder()

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

newBuilder(VastRedirectCreativeDetails prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAudio()

public boolean getAudio()

Optional. Whether the 3rd party VAST XML points to an audio ad. When true, size will always be 1x1.

optional bool audio = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The audio.

getDefaultInstanceForType()

public VastRedirectCreativeDetails getDefaultInstanceForType()
Returns
Type Description
VastRedirectCreativeDetails

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

Returns
Type Description
int

The enum numeric value on the wire for destinationUrlType.

getDuration()

public Duration getDuration()

Required. The duration of the VAST ad.

.google.protobuf.Duration duration = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Duration

The duration.

getDurationOrBuilder()

public DurationOrBuilder getDurationOrBuilder()

Required. The duration of the VAST ad.

.google.protobuf.Duration duration = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DurationOrBuilder

getParserForType()

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

getProgrammaticDemandSource()

public boolean getProgrammaticDemandSource()

Optional. Whether this is a redirect to a programmatic demand source.

optional bool programmatic_demand_source = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The programmaticDemandSource.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServerSideUnwrappingDisabled()

public boolean getServerSideUnwrappingDisabled()

Optional. Whether server-side unwrapping is disabled.

optional bool server_side_unwrapping_disabled = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The serverSideUnwrappingDisabled.

getTrackingUrls(int index)

public VideoTrackingUrl getTrackingUrls(int index)

Optional. URLs that will be pinged when conversion events happen.

repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
VideoTrackingUrl

getTrackingUrlsCount()

public int getTrackingUrlsCount()

Optional. URLs that will be pinged when conversion events happen.

repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getTrackingUrlsList()

public List<VideoTrackingUrl> getTrackingUrlsList()

Optional. URLs that will be pinged when conversion events happen.

repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<VideoTrackingUrl>

getTrackingUrlsOrBuilder(int index)

public VideoTrackingUrlOrBuilder getTrackingUrlsOrBuilder(int index)

Optional. URLs that will be pinged when conversion events happen.

repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
VideoTrackingUrlOrBuilder

getTrackingUrlsOrBuilderList()

public List<? extends VideoTrackingUrlOrBuilder> getTrackingUrlsOrBuilderList()

Optional. URLs that will be pinged when conversion events happen.

repeated .google.ads.admanager.v1.VideoTrackingUrl tracking_urls = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.ads.admanager.v1.VideoTrackingUrlOrBuilder>

getVastPreviewUrl()

public String getVastPreviewUrl()

Output only. An ad tag URL that will return a preview of the VAST XML response specific to this creative.

optional string vast_preview_url = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The vastPreviewUrl.

getVastPreviewUrlBytes()

public ByteString getVastPreviewUrlBytes()

Output only. An ad tag URL that will return a preview of the VAST XML response specific to this creative.

optional string vast_preview_url = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for vastPreviewUrl.

getVastPricingEnabled()

public boolean getVastPricingEnabled()

Optional. Whether pricing information from the VAST response will be used during ad selection.

optional bool vast_pricing_enabled = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The vastPricingEnabled.

getVastRedirectType()

public VastRedirectTypeEnum.VastRedirectType getVastRedirectType()

Required. The type of VAST ad that this redirects to.

optional .google.ads.admanager.v1.VastRedirectTypeEnum.VastRedirectType vast_redirect_type = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
VastRedirectTypeEnum.VastRedirectType

The vastRedirectType.

getVastRedirectTypeValue()

public int getVastRedirectTypeValue()

Required. The type of VAST ad that this redirects to.

optional .google.ads.admanager.v1.VastRedirectTypeEnum.VastRedirectType vast_redirect_type = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for vastRedirectType.

getVastXmlUrl()

public String getVastXmlUrl()

Required. The URL where the 3rd party VAST XML is hosted.

optional string vast_xml_url = 22 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The vastXmlUrl.

getVastXmlUrlBytes()

public ByteString getVastXmlUrlBytes()

Required. The URL where the 3rd party VAST XML is hosted.

optional string vast_xml_url = 22 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for vastXmlUrl.

hasAudio()

public boolean hasAudio()

Optional. Whether the 3rd party VAST XML points to an audio ad. When true, size will always be 1x1.

optional bool audio = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the audio 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 = 2 [(.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 = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the destinationUrlType field is set.

hasDuration()

public boolean hasDuration()

Required. The duration of the VAST ad.

.google.protobuf.Duration duration = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the duration field is set.

hasProgrammaticDemandSource()

public boolean hasProgrammaticDemandSource()

Optional. Whether this is a redirect to a programmatic demand source.

optional bool programmatic_demand_source = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the programmaticDemandSource field is set.

hasServerSideUnwrappingDisabled()

public boolean hasServerSideUnwrappingDisabled()

Optional. Whether server-side unwrapping is disabled.

optional bool server_side_unwrapping_disabled = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the serverSideUnwrappingDisabled field is set.

hasVastPreviewUrl()

public boolean hasVastPreviewUrl()

Output only. An ad tag URL that will return a preview of the VAST XML response specific to this creative.

optional string vast_preview_url = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the vastPreviewUrl field is set.

hasVastPricingEnabled()

public boolean hasVastPricingEnabled()

Optional. Whether pricing information from the VAST response will be used during ad selection.

optional bool vast_pricing_enabled = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the vastPricingEnabled field is set.

hasVastRedirectType()

public boolean hasVastRedirectType()

Required. The type of VAST ad that this redirects to.

optional .google.ads.admanager.v1.VastRedirectTypeEnum.VastRedirectType vast_redirect_type = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the vastRedirectType field is set.

hasVastXmlUrl()

public boolean hasVastXmlUrl()

Required. The URL where the 3rd party VAST XML is hosted.

optional string vast_xml_url = 22 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the vastXmlUrl 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 VastRedirectCreativeDetails.Builder newBuilderForType()
Returns
Type Description
VastRedirectCreativeDetails.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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