type VastRedirectCreative (v202505)

  • VastRedirectCreative is a type of Creative used in the CreativeService that delivers externally hosted VAST ads as a VAST Wrapper via VAST XML.

  • Key attributes for a VastRedirectCreative include the URL of the VAST XML (vastXmlUrl), the type of VAST ad (vastRedirectType), the duration of the ad in milliseconds (duration), and optionally companion creative IDs (companionCreativeIds) and tracking URLs (trackingUrls).

  • Inherited attributes from the base Creative class include the advertiser ID (advertiserId), a unique creative ID (id), the name of the creative (name), its size (size), a preview URL (previewUrl), detected policy labels (policyLabels), applied labels (appliedLabels), the last modified date/time (lastModifiedDateTime), custom field values (customFieldValues), third-party data declarations (thirdPartyDataDeclaration), and whether ad badging is enabled (adBadgingEnabled).

  • Read-only attributes include the creative's unique ID, preview URL, policy labels, last modified date/time, a VAST preview URL, and SSL scan results.

  • Required attributes for creating or updating a VastRedirectCreative include advertiser ID, name, size, VAST XML URL, VAST redirect type, and duration.
Service
CreativeService
Inheritance
Creative
▼
BaseDynamicAllocationCreative BaseRichMediaStudioCreative ClickTrackingCreative HasDestinationUrlCreative Html5Creative InternalRedirectCreative LegacyDfpCreative ProgrammaticCreative TemplateCreative ThirdPartyCreative UnsupportedCreative VastRedirectCreative

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

Namespace
https://www.google.com/apis/ads/publisher/v202505

Field
Creative (inherited)

advertiserId

xsd:long

The ID of the advertiser that owns the creative. This attribute is required.

id

xsd:long

Uniquely identifies the Creative. This value is read-only and is assigned by Google when the creative is created. This attribute is required for updates.

name

xsd:string

The name of the creative. This attribute is required and has a maximum length of 255 characters.

size

Size

The Size of the creative. This attribute is required for creation and then is read-only.

previewUrl

xsd:string

The URL of the creative for previewing the media. This attribute is read-only and is assigned by Google when a creative is created.

policyLabels

CreativePolicyViolation[]

Set of policy labels detected for this creative. This attribute is read-only.

Enumerations
MALWARE_IN_CREATIVE
Malware was found in the creative.

For more information see here.

MALWARE_IN_LANDING_PAGE
Malware was found in the landing page.

For more information see here.

LEGALLY_BLOCKED_REDIRECT_URL
The redirect url contains legally objectionable content.
MISREPRESENTATION_OF_PRODUCT
The creative misrepresents the product or service being advertised.

For more information see here.

SELF_CLICKING_CREATIVE
The creative has been determined to be self clicking.
GAMING_GOOGLE_NETWORK
The creative has been determined as attempting to game the Google network.

For more information see here.

DYNAMIC_DNS
The landing page for the creative uses a dynamic DNS.

For more information see here.

CIRCUMVENTING_SYSTEMS
The creative has been determined as attempting to circumvent Google advertising systems.
PHISHING
Phishing found in creative or landing page.

For more information see here.

DOWNLOAD_PROMPT_IN_CREATIVE
The creative prompts the user to download a file.

For more information see here

UNAUTHORIZED_COOKIE_DETECTED
The creative sets an unauthorized cookie on a Google domain.

For more information see here

TEMPORARY_PAUSE_FOR_VENDOR_INVESTIGATION
The creative has been temporarily paused while we investigate.
ABUSIVE_EXPERIENCE
The landing page contains an abusive experience.

For more information see here.

TRICK_TO_CLICK
The creative is designed to mislead or trick the user into interacting with it.

For more information see here.

USE_OF_NON_ALLOWLISTED_OMID_VERIFICATION_SCRIPT
Non-allowlisted OMID verification script.

For more information see here.

MISUSE_OF_OMID_API
OMID sdk injected by creative. < p>For more information see here.
UNACCEPTABLE_HTML_AD
Unacceptable HTML5 ad.

For more information see here.

UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

appliedLabels

AppliedLabel[]

The set of labels applied to this creative.

lastModifiedDateTime

DateTime

The date and time this creative was last modified.

customFieldValues

  1. BaseCustomFieldValue[]
    1. CustomFieldValue
    2. DropDownCustomFieldValue

The values of the custom fields associated with this creative.

thirdPartyDataDeclaration

ThirdPartyDataDeclaration

The third party companies associated with this creative.

This is distinct from any associated companies that Google may detect programmatically.

adBadgingEnabled

xsd:boolean

Whether the creative has ad badging enabled.

Defaults to false for CreativeType.VAST_REDIRECT, CreativeType.THIRD_PARTY, CreativeType.AUDIO_VAST_REDIRECT, CreativeType.PROGRAMMATIC, CreativeType.DFP_MOBILE_CREATIVE, CreativeType.FLASH_OVERLAY, CreativeType.GRAPHICAL_INTERSTITIAL, CreativeType.LEGACY_DFP_CREATIVE, CreativeType.MOBILE_AD_NETWORK_BACKFILL, CreativeType.MOBILE_VIDEO_INTERSTITIAL, CreativeType.SDK_MEDIATION and CreativeType.STANDARD_FLASH creative types.

. Defaults to true for all other creative types.
VastRedirectCreative

vastXmlUrl

xsd:string

The URL where the 3rd party VAST XML is hosted. This attribute is required.

vastRedirectType

VastRedirectType

The type of VAST ad that this redirects to. This attribute is required.

Enumerations
LINEAR
The VAST XML contains only linear ads.
NON_LINEAR
The VAST XML contains only nonlinear ads.
LINEAR_AND_NON_LINEAR
The VAST XML contains both linear and nonlinear ads.

duration

xsd:int

The duration of the VAST ad in milliseconds. This attribute is required.

companionCreativeIds

xsd:long[]

The IDs of the companion creatives that are associated with this creative. This attribute is optional.

trackingUrls

ConversionEvent_TrackingUrl...[]

A map from ConversionEvent to a list of URLs that will be pinged when the event happens. This attribute is optional.

vastPreviewUrl

xsd:string

An ad tag URL that will return a preview of the VAST XML response specific to this creative. This attribute is read-only.

sslScanResult

SslScanResult

The SSL compatibility scan result for this creative.

This attribute is read-only and determined by Google.

Enumerations
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
UNSCANNED
SCANNED_SSL
SCANNED_NON_SSL

sslManualOverride

SslManualOverride

The manual override for the SSL compatibility of this creative.

This attribute is optional and defaults to SslManualOverride.NO_OVERRIDE.

Enumerations
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
NO_OVERRIDE
SSL_COMPATIBLE
NOT_SSL_COMPATIBLE

isAudio

xsd:boolean

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