CreativeAsset

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

Creative Asset.

interface CreativeAsset {

actionScript3?: boolean;

active?: boolean;

additionalSizes?: Size[];

alignment?:

| "ALIGNMENT_TOP"

| "ALIGNMENT_RIGHT"

| "ALIGNMENT_BOTTOM"

| "ALIGNMENT_LEFT";

artworkType?:

| "ARTWORK_TYPE_FLASH"

| "ARTWORK_TYPE_HTML5"

| "ARTWORK_TYPE_MIXED"

| "ARTWORK_TYPE_IMAGE";

assetIdentifier?: CreativeAssetId;

audioBitRate?: number;

audioSampleRate?: number;

backupImageExit?: CreativeCustomEvent;

bitRate?: number;

childAssetType?:

| "CHILD_ASSET_TYPE_FLASH"

| "CHILD_ASSET_TYPE_VIDEO"

| "CHILD_ASSET_TYPE_IMAGE"

| "CHILD_ASSET_TYPE_DATA";

collapsedSize?: Size;

companionCreativeIds?: bigint[];

customStartTimeValue?: number;

detectedFeatures?:

| "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"[];

displayType?:

| "ASSET_DISPLAY_TYPE_INPAGE"

| "ASSET_DISPLAY_TYPE_FLOATING"

| "ASSET_DISPLAY_TYPE_OVERLAY"

| "ASSET_DISPLAY_TYPE_EXPANDING"

| "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH"

| "ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING"

| "ASSET_DISPLAY_TYPE_PEEL_DOWN"

| "ASSET_DISPLAY_TYPE_VPAID_LINEAR"

| "ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR"

| "ASSET_DISPLAY_TYPE_BACKDROP";

duration?: number;

durationType?: "ASSET_DURATION_TYPE_AUTO" | "ASSET_DURATION_TYPE_NONE" | "ASSET_DURATION_TYPE_CUSTOM";

expandedDimension?: Size;

fileSize?: bigint;

flashVersion?: number;

frameRate?: number;

hideFlashObjects?: boolean;

hideSelectionBoxes?: boolean;

horizontallyLocked?: boolean;

id?: bigint;

idDimensionValue?: DimensionValue;

mediaDuration?: number;

mimeType?: string;

offset?: OffsetPosition;

orientation?: "LANDSCAPE" | "PORTRAIT" | "SQUARE";

originalBackup?: boolean;

politeLoad?: boolean;

position?: OffsetPosition;

positionLeftUnit?: "OFFSET_UNIT_PIXEL" | "OFFSET_UNIT_PERCENT" | "OFFSET_UNIT_PIXEL_FROM_CENTER";

positionTopUnit?: "OFFSET_UNIT_PIXEL" | "OFFSET_UNIT_PERCENT" | "OFFSET_UNIT_PIXEL_FROM_CENTER";

progressiveServingUrl?: string;

pushdown?: boolean;

pushdownDuration?: number;

role?:

| "PRIMARY"

| "BACKUP_IMAGE"

| "ADDITIONAL_IMAGE"

| "ADDITIONAL_FLASH"

| "PARENT_VIDEO"

| "TRANSCODED_VIDEO"

| "OTHER"

| "ALTERNATE_VIDEO"

| "PARENT_AUDIO"

| "TRANSCODED_AUDIO";

size?: Size;

sslCompliant?: boolean;

startTimeType?: "ASSET_START_TIME_TYPE_NONE" | "ASSET_START_TIME_TYPE_CUSTOM";

streamingServingUrl?: string;

transparency?: boolean;

verticallyLocked?: boolean;

windowMode?: "OPAQUE" | "WINDOW" | "TRANSPARENT";

zIndex?: number;

zipFilename?: string;

zipFilesize?: string;

}

§Properties

actionScript3?: boolean

[src]

Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.

active?: boolean

[src]

Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.

additionalSizes?: Size[]

[src]

Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render.

alignment?: "ALIGNMENT_TOP" | "ALIGNMENT_RIGHT" | "ALIGNMENT_BOTTOM" | "ALIGNMENT_LEFT"

[src]

Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL .

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

[src]

Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.

assetIdentifier?: CreativeAssetId

[src]

Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.

audioBitRate?: number

[src]

Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.

audioSampleRate?: number

[src]

Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.

backupImageExit?: CreativeCustomEvent

[src]

Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.

bitRate?: number

[src]

Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.

childAssetType?: "CHILD_ASSET_TYPE_FLASH" | "CHILD_ASSET_TYPE_VIDEO" | "CHILD_ASSET_TYPE_IMAGE" | "CHILD_ASSET_TYPE_DATA"

[src]

Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.

collapsedSize?: Size

[src]

Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.

companionCreativeIds?: bigint[]

[src]

List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.

customStartTimeValue?: number

[src]

Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0.

[src]

List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.

[src]

Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.

duration?: number

[src]

Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1.

durationType?: "ASSET_DURATION_TYPE_AUTO" | "ASSET_DURATION_TYPE_NONE" | "ASSET_DURATION_TYPE_CUSTOM"

[src]

Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.

expandedDimension?: Size

[src]

Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.

fileSize?: bigint

[src]

File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.

flashVersion?: number

[src]

Flash version of the asset. 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.

frameRate?: number

[src]

Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.

hideFlashObjects?: boolean

[src]

Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.

hideSelectionBoxes?: boolean

[src]

Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.

horizontallyLocked?: boolean

[src]

Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.

id?: bigint

[src]

Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.

idDimensionValue?: DimensionValue

[src]

Dimension value for the ID of the asset. This is a read-only, auto-generated field.

mediaDuration?: number

[src]

Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.

mimeType?: string

[src]

Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.

offset?: OffsetPosition

[src]

Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.

orientation?: "LANDSCAPE" | "PORTRAIT" | "SQUARE"

[src]

Orientation of video asset. This is a read-only, auto-generated field.

originalBackup?: boolean

[src]

Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA.

politeLoad?: boolean

[src]

Whether this asset is used as a polite load asset.

position?: OffsetPosition

[src]

Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.

positionLeftUnit?: "OFFSET_UNIT_PIXEL" | "OFFSET_UNIT_PERCENT" | "OFFSET_UNIT_PIXEL_FROM_CENTER"

[src]

Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.

positionTopUnit?: "OFFSET_UNIT_PIXEL" | "OFFSET_UNIT_PERCENT" | "OFFSET_UNIT_PIXEL_FROM_CENTER"

[src]

Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.

progressiveServingUrl?: string

[src]

Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.

pushdown?: boolean

[src]

Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.

pushdownDuration?: number

[src]

Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive.

[src]

Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives.

size?: Size

[src]

Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.

sslCompliant?: boolean

[src]

Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.

startTimeType?: "ASSET_START_TIME_TYPE_NONE" | "ASSET_START_TIME_TYPE_CUSTOM"

[src]

Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.

streamingServingUrl?: string

[src]

Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.

transparency?: boolean

[src]

Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.

verticallyLocked?: boolean

[src]

Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.

windowMode?: "OPAQUE" | "WINDOW" | "TRANSPARENT"

[src]

Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.

zIndex?: number

[src]

zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive.

zipFilename?: string

[src]

File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.

zipFilesize?: string

[src]

Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.