abstract type BaseRichMediaStudioCreative (v202502)

  • The RichMediaStudioCreative object is a creative type created by Rich Media Studio, inheriting from Creative and BaseDynamicAllocationCreative.

  • This creative type includes fields for managing advertiser information, creative identification, size, preview URLs, policy violations, labels, modification times, custom fields, and third-party data declarations.

  • Specific fields for RichMediaStudioCreative detail Rich Media Studio's internal creative ID, format (e.g., IN_PAGE, EXPANDING), artwork type (e.g., FLASH, HTML5), file size, ad tag keys, custom key values, and various tracking URLs.

  • Additional properties include the creative's duration, billing attribute, child asset properties, and SSL compatibility information with a manual override option.
Service
CreativeService
Inheritance
Creative
▼
BaseDynamicAllocationCreative BaseRichMediaStudioCreative ClickTrackingCreative HasDestinationUrlCreative Html5Creative InternalRedirectCreative LegacyDfpCreative ProgrammaticCreative TemplateCreative ThirdPartyCreative UnsupportedCreative VastRedirectCreative
▼
RichMediaStudioCreative

A Creative that is created by a Rich Media Studio.

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

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.
BaseRichMediaStudioCreative

studioCreativeId

xsd:long

The creative ID as known by Rich Media Studio creative. This attribute is readonly.

creativeFormat

RichMediaStudioCreativeFormat

The creative format of the Rich Media Studio creative. This attribute is readonly.

Enumerations
IN_PAGE
In-page creatives are served into an ad slot on publishers page. In-page implies that they maintain a static size, e.g, 468x60 and do not break out of these dimensions.
EXPANDING
Expanding creatives expand/collapse on user interaction such as mouse over. It consists of an initial, or collapsed and an expanded creative area.
IM_EXPANDING
Creatives that are served in an instant messenger application such as AOL Instant Messanger or Yahoo! Messenger. This can also be used in desktop applications such as weatherbug.
FLOATING
Floating creatives float on top of publishers page and can be closed with a close button.
PEEL_DOWN
Peel-down creatives show a glimpse of your ad in the corner of a web page. When the user interacts, the rest of the ad peels down to reveal the full message.
IN_PAGE_WITH_FLOATING
An In-Page with Floating creative is a dual-asset creative consisting of an in-page asset and a floating asset. This creative type lets you deliver a static primary ad to a webpage, while inviting a user to find out more through a floating asset delivered when the user interacts with the creative.
FLASH_IN_FLASH
A Flash ad that renders in a Flash environment. The adserver will serve this using VAST, but it is not a proper VAST XML ad. It's an amalgamation of the proprietary InStream protocol, rendered inside VAST so that we can capture some standard behavior such as companions.
FLASH_IN_FLASH_EXPANDING
An expanding flash ad that renders in a Flash environment. The adserver will serve this using VAST, but it is not a proper VAST XML ad. It's an amalgamation of the proprietary InStream protocol, rendered inside VAST so that we can capture some standard behavior such as companions.
IN_APP
In-app creatives are served into an ad slot within a publisher's app. In-app implies that they maintain a static size, e.g, 468x60 and do not break out of these dimensions.
UNKNOWN
The creative format is unknown or not supported in the API version in use.

artworkType

RichMediaStudioCreativeArtw...

The type of artwork used in this creative. This attribute is readonly.

Enumerations
FLASH
The creative is a Flash creative.
HTML5
The creative is HTML5.
MIXED
The creative is Flash if available, and HTML5 otherwise.

totalFileSize

xsd:long

The total size of all assets in bytes. This attribute is readonly.

adTagKeys

xsd:string[]

Ad tag keys. This attribute is optional and updatable.

customKeyValues

xsd:string[]

Custom key values. This attribute is optional and updatable.

surveyUrl

xsd:string

The survey URL for this creative. This attribute is optional and updatable.

allImpressionsUrl

xsd:string

The tracking URL to be triggered when an ad starts to play, whether Rich Media or backup content is displayed. Behaves like the /imp URL that DART used to track impressions. This URL can't exceed 1024 characters and must start with http:// or https://. This attribute is optional and updatable.

richMediaImpressionsUrl

xsd:string

The tracking URL to be triggered when any rich media artwork is displayed in an ad. Behaves like the /imp URL that DART used to track impressions. This URL can't exceed 1024 characters and must start with http:// or https://. This attribute is optional and updatable.

backupImageImpressionsUrl

xsd:string

The tracking URL to be triggered when the Rich Media backup image is served. This attribute is optional and updatable.

overrideCss

xsd:string

The override CSS. You can put custom CSS code here to repair creative styling; e.g. tr td { background-color:#FBB;}. This attribute is optional and updatable.

requiredFlashPluginVersion

xsd:string

The Flash plugin version required to view this creative; e.g. Flash 10.2/AS 3. This attribute is read only.

duration

xsd:int

The duration of the creative in milliseconds. This attribute is optional and updatable.

billingAttribute

RichMediaStudioCreativeBill...

The billing attribute associated with this creative. This attribute is read only.

Enumerations
IN_PAGE
Applies to any RichMediaStudioCreativeFormat.IN_PAGE, without Video.
FLOATING_EXPANDING
Applies to any of these following RichMediaStudioCreativeFormat, without Video: RichMediaStudioCreativeFormat.EXPANDING, RichMediaStudioCreativeFormat.IM_EXPANDING, RichMediaStudioCreativeFormat.FLOATING, RichMediaStudioCreativeFormat.PEEL_DOWN, RichMediaStudioCreativeFormat.IN_PAGE_WITH_FLOATING
VIDEO
Applies to any creatives that includes a video.
FLASH_IN_FLASH
Applies to any RichMediaStudioCreativeFormat.FLASH_IN_FLASH, without Video.

richMediaStudioChildAssetProperties

RichMediaStudioChildAssetPr...[]

The list of child assets associated with this creative. This attribute is read only.

sslScanResult

SslScanResult

The SSL compatibility scan result of 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