type ImageRedirectOverlayCreative (v202505)

  • ImageRedirectOverlayCreative is a read-only overlay creative served via VAST XML that loads an image asset from a specified URL and covers part of the video content it is displayed on top of.

  • This creative inherits attributes from Creative, HasDestinationUrlCreative, and BaseImageRedirectCreative.

  • Required attributes include the advertiser ID, a unique ID (for updates), the name, the size, and the image URL.

  • Optional attributes include asset size, duration, companion creative IDs, tracking URLs, and custom parameters.

  • Read-only attributes include the unique ID, preview URL, policy labels, last modified date/time, and vast preview URL.
Service
CreativeService
Inheritance
Creative
▼
HasDestinationUrlCreative
▼
BaseImageRedirectCreative
▼
ImageRedirectCreative ImageRedirectOverlayCreative

An overlay Creative that loads an image asset from a specified URL and is served via VAST XML. Overlays cover part of the video content they are displayed on top of. This creative is read only.

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.
HasDestinationUrlCreative (inherited)

destinationUrl

xsd:string

The URL that the user is directed to if they click on the creative. This attribute is required unless the destinationUrlType is DestinationUrlType.NONE, and has a maximum length of 1024 characters.

destinationUrlType

DestinationUrlType

The action that should be performed if the user clicks on the creative. This attribute is optional and defaults to DestinationUrlType.CLICK_TO_WEB.

Enumerations
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
CLICK_TO_WEB
Navigate to a web page. (a.k.a. "Click-through URL").
CLICK_TO_APP
Start an application.
CLICK_TO_CALL
Make a phone call.
NONE
Destination URL not present. Useful for video creatives where a landing page or a product isn't necessarily applicable.

BaseImageRedirectCreative (inherited)

imageUrl

xsd:string

The URL where the actual asset resides. This attribute is required and has a maximum length of 1024 characters.

ImageRedirectOverlayCreative

assetSize

Size

The size of the image asset. Note that this may differ from size if the asset is not expected to fill the entire video player. This attribute is optional.

duration

xsd:int

Minimum suggested duration in milliseconds. This attribute is optional.

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.

customParameters

xsd:string

A comma separated key=value list of parameters that will be supplied to the creative, written into the VAST AdParameters node. 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.