Interface VastRedirectCreativeDetailsOrBuilder (0.62.0)

public interface VastRedirectCreativeDetailsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAudio()

public abstract 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.

getDestinationUrl()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract DurationOrBuilder getDurationOrBuilder()

Required. The duration of the VAST ad.

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

Returns
Type Description
DurationOrBuilder

getProgrammaticDemandSource()

public abstract 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.

getServerSideUnwrappingDisabled()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.