Google Ads Ad Manager V1 Client - Class VastRedirectCreativeDetails (0.15.0)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class VastRedirectCreativeDetails.

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

Generated from protobuf message google.ads.admanager.v1.VastRedirectCreativeDetails

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ vast_xml_url string

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

Required. The type of VAST ad that this redirects to.
↳ duration Google\Protobuf\Duration

Required. The duration of the VAST ad.
↳ vast_pricing_enabled bool

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

Optional. Whether this is a redirect to a programmatic demand source.
↳ server_side_unwrapping_disabled bool

Optional. Whether server-side unwrapping is disabled.
↳ tracking_urls array<VideoTrackingUrl>

Optional. URLs that will be pinged when conversion events happen.
↳ vast_preview_url string

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

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

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.
↳ destination_url_type int

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

getVastXmlUrl

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

Returns
Type Description
string

hasVastXmlUrl

clearVastXmlUrl

setVastXmlUrl

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

Parameter
Name Description
var string
Returns
Type Description
$this

getVastRedirectType

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

Returns
Type Description
int

hasVastRedirectType

clearVastRedirectType

setVastRedirectType

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

Parameter
Name Description
var int
Returns
Type Description
$this

getDuration

Required. The duration of the VAST ad.

Returns
Type Description
Google\Protobuf\Duration|null

hasDuration

clearDuration

setDuration

Required. The duration of the VAST ad.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getVastPricingEnabled

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

Returns
Type Description
bool

hasVastPricingEnabled

clearVastPricingEnabled

setVastPricingEnabled

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

Parameter
Name Description
var bool
Returns
Type Description
$this

getProgrammaticDemandSource

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

Returns
Type Description
bool

hasProgrammaticDemandSource

clearProgrammaticDemandSource

setProgrammaticDemandSource

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

Parameter
Name Description
var bool
Returns
Type Description
$this

getServerSideUnwrappingDisabled

Optional. Whether server-side unwrapping is disabled.

Returns
Type Description
bool

hasServerSideUnwrappingDisabled

clearServerSideUnwrappingDisabled

setServerSideUnwrappingDisabled

Optional. Whether server-side unwrapping is disabled.

Parameter
Name Description
var bool
Returns
Type Description
$this

getTrackingUrls

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

Returns
Type Description
Google\Protobuf\RepeatedField<VideoTrackingUrl>

setTrackingUrls

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

Parameter
Name Description
var array<VideoTrackingUrl>
Returns
Type Description
$this

getVastPreviewUrl

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

Returns
Type Description
string

hasVastPreviewUrl

clearVastPreviewUrl

setVastPreviewUrl

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

Parameter
Name Description
var string
Returns
Type Description
$this

getAudio

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

Returns
Type Description
bool

hasAudio

clearAudio

setAudio

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

Parameter
Name Description
var bool
Returns
Type Description
$this

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.

Returns
Type Description
string

hasDestinationUrl

clearDestinationUrl

setDestinationUrl

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getDestinationUrlType

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

Returns
Type Description
int

hasDestinationUrlType

clearDestinationUrlType

setDestinationUrlType

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

Parameter
Name Description
var int
Returns
Type Description
$this