Creative

import type { Creative } from "https://googleapis.deno.dev/v1/dfareporting:v4.ts";

Contains properties of a Creative.

interface Creative {

accountId?: bigint;

active?: boolean;

additionalSizes?: Size[];

adParameters?: string;

adTagKeys?: string[];

advertiserId?: bigint;

allowScriptAccess?: boolean;

archived?: boolean;

artworkType?:

| "ARTWORK_TYPE_FLASH"

| "ARTWORK_TYPE_HTML5"

| "ARTWORK_TYPE_MIXED"

| "ARTWORK_TYPE_IMAGE";

authoringSource?:

| "CREATIVE_AUTHORING_SOURCE_DCM"

| "CREATIVE_AUTHORING_SOURCE_DBM"

| "CREATIVE_AUTHORING_SOURCE_STUDIO"

| "CREATIVE_AUTHORING_SOURCE_GWD"

| "CREATIVE_AUTHORING_SOURCE_ACS";

authoringTool?: "NINJA" | "SWIFFY";

autoAdvanceImages?: boolean;

backgroundColor?: string;

backupImageClickThroughUrl?: CreativeClickThroughUrl;

backupImageFeatures?:

| "CSS_FONT_FACE"

| "CSS_BACKGROUND_SIZE"

| "CSS_BORDER_IMAGE"

| "CSS_BORDER_RADIUS"

| "CSS_BOX_SHADOW"

| "CSS_FLEX_BOX"

| "CSS_HSLA"

| "CSS_MULTIPLE_BGS"

| "CSS_OPACITY"

| "CSS_RGBA"

| "CSS_TEXT_SHADOW"

| "CSS_ANIMATIONS"

| "CSS_COLUMNS"

| "CSS_GENERATED_CONTENT"

| "CSS_GRADIENTS"

| "CSS_REFLECTIONS"

| "CSS_TRANSFORMS"

| "CSS_TRANSFORMS3D"

| "CSS_TRANSITIONS"

| "APPLICATION_CACHE"

| "CANVAS"

| "CANVAS_TEXT"

| "DRAG_AND_DROP"

| "HASH_CHANGE"

| "HISTORY"

| "AUDIO"

| "VIDEO"

| "INDEXED_DB"

| "INPUT_ATTR_AUTOCOMPLETE"

| "INPUT_ATTR_AUTOFOCUS"

| "INPUT_ATTR_LIST"

| "INPUT_ATTR_PLACEHOLDER"

| "INPUT_ATTR_MAX"

| "INPUT_ATTR_MIN"

| "INPUT_ATTR_MULTIPLE"

| "INPUT_ATTR_PATTERN"

| "INPUT_ATTR_REQUIRED"

| "INPUT_ATTR_STEP"

| "INPUT_TYPE_SEARCH"

| "INPUT_TYPE_TEL"

| "INPUT_TYPE_URL"

| "INPUT_TYPE_EMAIL"

| "INPUT_TYPE_DATETIME"

| "INPUT_TYPE_DATE"

| "INPUT_TYPE_MONTH"

| "INPUT_TYPE_WEEK"

| "INPUT_TYPE_TIME"

| "INPUT_TYPE_DATETIME_LOCAL"

| "INPUT_TYPE_NUMBER"

| "INPUT_TYPE_RANGE"

| "INPUT_TYPE_COLOR"

| "LOCAL_STORAGE"

| "POST_MESSAGE"

| "SESSION_STORAGE"

| "WEB_SOCKETS"

| "WEB_SQL_DATABASE"

| "WEB_WORKERS"

| "GEO_LOCATION"

| "INLINE_SVG"

| "SMIL"

| "SVG_HREF"

| "SVG_CLIP_PATHS"

| "TOUCH"

| "WEBGL"

| "SVG_FILTERS"

| "SVG_FE_IMAGE"[];

backupImageReportingLabel?: string;

backupImageTargetWindow?: TargetWindow;

clickTags?: ClickTag[];

commercialId?: string;

companionCreatives?: bigint[];

compatibility?:

| "DISPLAY"

| "DISPLAY_INTERSTITIAL"

| "APP"

| "APP_INTERSTITIAL"

| "IN_STREAM_VIDEO"

| "IN_STREAM_AUDIO"[];

convertFlashToHtml5?: boolean;

counterCustomEvents?: CreativeCustomEvent[];

creativeAssets?: CreativeAsset[];

creativeAssetSelection?: CreativeAssetSelection;

creativeFieldAssignments?: CreativeFieldAssignment[];

customKeyValues?: string[];

dynamicAssetSelection?: boolean;

exitCustomEvents?: CreativeCustomEvent[];

fsCommand?: FsCommand;

htmlCode?: string;

htmlCodeLocked?: boolean;

id?: bigint;

idDimensionValue?: DimensionValue;

kind?: string;

lastModifiedInfo?: LastModifiedInfo;

latestTraffickedCreativeId?: bigint;

mediaDescription?: string;

mediaDuration?: number;

name?: string;

obaIcon?: ObaIcon;

overrideCss?: string;

progressOffset?: VideoOffset;

redirectUrl?: string;

renderingId?: bigint;

renderingIdDimensionValue?: DimensionValue;

requiredFlashPluginVersion?: string;

requiredFlashVersion?: number;

size?: Size;

skipOffset?: VideoOffset;

skippable?: boolean;

sslCompliant?: boolean;

sslOverride?: boolean;

studioAdvertiserId?: bigint;

studioCreativeId?: bigint;

studioTraffickedCreativeId?: bigint;

subaccountId?: bigint;

thirdPartyBackupImageImpressionsUrl?: string;

thirdPartyRichMediaImpressionsUrl?: string;

thirdPartyUrls?: ThirdPartyTrackingUrl[];

timerCustomEvents?: CreativeCustomEvent[];

totalFileSize?: bigint;

type?:

| "IMAGE"

| "DISPLAY_REDIRECT"

| "CUSTOM_DISPLAY"

| "INTERNAL_REDIRECT"

| "CUSTOM_DISPLAY_INTERSTITIAL"

| "INTERSTITIAL_INTERNAL_REDIRECT"

| "TRACKING_TEXT"

| "RICH_MEDIA_DISPLAY_BANNER"

| "RICH_MEDIA_INPAGE_FLOATING"

| "RICH_MEDIA_IM_EXPAND"

| "RICH_MEDIA_DISPLAY_EXPANDING"

| "RICH_MEDIA_DISPLAY_INTERSTITIAL"

| "RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL"

| "RICH_MEDIA_MOBILE_IN_APP"

| "FLASH_INPAGE"

| "INSTREAM_VIDEO"

| "VPAID_LINEAR_VIDEO"

| "VPAID_NON_LINEAR_VIDEO"

| "INSTREAM_VIDEO_REDIRECT"

| "RICH_MEDIA_PEEL_DOWN"

| "HTML5_BANNER"

| "DISPLAY"

| "DISPLAY_IMAGE_GALLERY"

| "BRAND_SAFE_DEFAULT_INSTREAM_VIDEO"

| "INSTREAM_AUDIO";

universalAdId?: UniversalAdId;

version?: number;

}

§Properties

accountId?: bigint

[src]

Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.

active?: boolean

[src]

Whether the creative is active. Applicable to all creative types.

additionalSizes?: Size[]

[src]

Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE.

adParameters?: string

[src]

Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.

adTagKeys?: string[]

[src]

Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

advertiserId?: bigint

[src]

Required. Advertiser ID of this creative. This is a required field. Applicable to all creative types.

allowScriptAccess?: boolean

[src]

Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.

archived?: boolean

[src]

Whether the creative is archived. Applicable to all creative types.

artworkType?: "ARTWORK_TYPE_FLASH" | "ARTWORK_TYPE_HTML5" | "ARTWORK_TYPE_MIXED" | "ARTWORK_TYPE_IMAGE"

[src]

Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

authoringSource?: "CREATIVE_AUTHORING_SOURCE_DCM" | "CREATIVE_AUTHORING_SOURCE_DBM" | "CREATIVE_AUTHORING_SOURCE_STUDIO" | "CREATIVE_AUTHORING_SOURCE_GWD" | "CREATIVE_AUTHORING_SOURCE_ACS"

[src]

Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.

authoringTool?: "NINJA" | "SWIFFY"

[src]

Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.

autoAdvanceImages?: boolean

[src]

Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.

backgroundColor?: string

[src]

The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.

backupImageClickThroughUrl?: CreativeClickThroughUrl

[src]

Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.

[src]

List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.

backupImageReportingLabel?: string

[src]

Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.

backupImageTargetWindow?: TargetWindow

[src]

Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.

clickTags?: ClickTag[]

[src]

Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.

commercialId?: string

[src]

Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives.

companionCreatives?: bigint[]

[src]

List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false.

[src]

Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP" - "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - "IN_STREAM_AUDIO" - "DISPLAY" - "DISPLAY_INTERSTITIAL"

convertFlashToHtml5?: boolean

[src]

Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.

counterCustomEvents?: CreativeCustomEvent[]

[src]

List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.

creativeAssets?: CreativeAsset[]

[src]

Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT

creativeAssetSelection?: CreativeAssetSelection

[src]

Required if dynamicAssetSelection is true.

creativeFieldAssignments?: CreativeFieldAssignment[]

[src]

Creative field assignments for this creative. Applicable to all creative types.

customKeyValues?: string[]

[src]

Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

dynamicAssetSelection?: boolean

[src]

Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.

exitCustomEvents?: CreativeCustomEvent[]

[src]

List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.

fsCommand?: FsCommand

[src]

OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.

htmlCode?: string

[src]

HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.

htmlCodeLocked?: boolean

[src]

Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.

id?: bigint

[src]

ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.

idDimensionValue?: DimensionValue

[src]

Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.

kind?: string

[src]

Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".

lastModifiedInfo?: LastModifiedInfo

[src]

Creative last modification information. This is a read-only field. Applicable to all creative types.

latestTraffickedCreativeId?: bigint

[src]

Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

mediaDescription?: string

[src]

Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID.

mediaDuration?: number

[src]

Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID.

name?: string

[src]

Required. Name of the creative. This must be less than 256 characters long. Applicable to all creative types.

obaIcon?: ObaIcon

[src]

Online behavioral advertising icon to be added to the creative. Applicable to the following creative types: all INSTREAM_VIDEO.

overrideCss?: string

[src]

Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.

progressOffset?: VideoOffset

[src]

Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO.

redirectUrl?: string

[src]

URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT

renderingId?: bigint

[src]

ID of current rendering version. This is a read-only field. Applicable to all creative types.

renderingIdDimensionValue?: DimensionValue

[src]

Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.

requiredFlashPluginVersion?: string

[src]

The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

requiredFlashVersion?: number

[src]

The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.

size?: Size

[src]

Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.

skipOffset?: VideoOffset

[src]

Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO.

skippable?: boolean

[src]

Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.

sslCompliant?: boolean

[src]

Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.

sslOverride?: boolean

[src]

Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.

studioAdvertiserId?: bigint

[src]

Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

studioCreativeId?: bigint

[src]

Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

studioTraffickedCreativeId?: bigint

[src]

Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

subaccountId?: bigint

[src]

Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.

thirdPartyBackupImageImpressionsUrl?: string

[src]

Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.

thirdPartyRichMediaImpressionsUrl?: string

[src]

Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.

thirdPartyUrls?: ThirdPartyTrackingUrl[]

[src]

Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID.

timerCustomEvents?: CreativeCustomEvent[]

[src]

List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.

totalFileSize?: bigint

[src]

Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

[src]

Required. Type of this creative. Applicable to all creative types. Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.

universalAdId?: UniversalAdId

[src]

A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID.

version?: number

[src]

The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.