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

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

Fields common to Video Ad Serving Template (VAST) creatives.

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

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ duration Google\Protobuf\Duration

Optional. The expected duration of this creative.
↳ allow_duration_override bool

Optional. Allows the creative duration to differ from the actual asset durations.
↳ tracking_urls array<VideoTrackingUrl>

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

Optional. A comma separated key=value list of parameters that will be supplied to the creative, written into the VAST AdParameters node.
↳ ad_id string

Optional. The ad id associated with the video as defined by the adIdType registry. This field is required if adIdType is not NONE.
↳ ad_id_type int

Optional. The registry which the ad id of this creative belongs to. This field defaults to NONE.
↳ skippable_ad_type int

Optional. The type of skippable ad.
↳ vast_preview_url string

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

Output only. The display name of the creative set.
↳ creative_set string

Output only. The resource name of the creative set. Format: "networks/{network_code}/creativeSets/{creative_set_id}"
↳ 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.
↳ companion_creatives string[]

Optional. The companion creatives that are associated with this creative. Format: "networks/{network_code}/creatives/{creative_id}"

getDuration

Optional. The expected duration of this creative.

Returns
Type Description
Google\Protobuf\Duration|null

hasDuration

clearDuration

setDuration

Optional. The expected duration of this creative.

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

getAllowDurationOverride

Optional. Allows the creative duration to differ from the actual asset durations.

Returns
Type Description
bool

hasAllowDurationOverride

clearAllowDurationOverride

setAllowDurationOverride

Optional. Allows the creative duration to differ from the actual asset durations.

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

getCustomParameters

Optional. A comma separated key=value list of parameters that will be supplied to the creative, written into the VAST AdParameters node.

Returns
Type Description
string

hasCustomParameters

clearCustomParameters

setCustomParameters

Optional. A comma separated key=value list of parameters that will be supplied to the creative, written into the VAST AdParameters node.

Parameter
Name Description
var string
Returns
Type Description
$this

getAdId

Optional. The ad id associated with the video as defined by the adIdType registry. This field is required if adIdType is not NONE.

Returns
Type Description
string

hasAdId

clearAdId

setAdId

Optional. The ad id associated with the video as defined by the adIdType registry. This field is required if adIdType is not NONE.

Parameter
Name Description
var string
Returns
Type Description
$this

getAdIdType

Optional. The registry which the ad id of this creative belongs to. This field defaults to NONE.

Returns
Type Description
int

hasAdIdType

clearAdIdType

setAdIdType

Optional. The registry which the ad id of this creative belongs to. This field defaults to NONE.

Parameter
Name Description
var int
Returns
Type Description
$this

getSkippableAdType

Optional. The type of skippable ad.

Returns
Type Description
int

hasSkippableAdType

clearSkippableAdType

setSkippableAdType

Optional. The type of skippable ad.

Parameter
Name Description
var int
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

getCreativeSetDisplayName

Output only. The display name of the creative set.

Returns
Type Description
string

hasCreativeSetDisplayName

clearCreativeSetDisplayName

setCreativeSetDisplayName

Output only. The display name of the creative set.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreativeSet

Output only. The resource name of the creative set.

Format: "networks/{network_code}/creativeSets/{creative_set_id}"

Returns
Type Description
string

hasCreativeSet

clearCreativeSet

setCreativeSet

Output only. The resource name of the creative set.

Format: "networks/{network_code}/creativeSets/{creative_set_id}"

Parameter
Name Description
var string
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

getCompanionCreatives

Optional. The companion creatives that are associated with this creative.

Format: "networks/{network_code}/creatives/{creative_id}"

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setCompanionCreatives

Optional. The companion creatives that are associated with this creative.

Format: "networks/{network_code}/creatives/{creative_id}"

Parameter
Name Description
var string[]
Returns
Type Description
$this