Creative

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

A single Creative.

interface Creative {

additionalDimensions?: Dimensions[];

readonly advertiserId?: bigint;

appendedTag?: string;

assets?: AssetAssociation[];

readonly cmPlacementId?: bigint;

cmTrackingAd?: CmTrackingAd;

companionCreativeIds?: bigint[];

counterEvents?: CounterEvent[];

readonly createTime?: Date;

readonly creativeAttributes?:

| "CREATIVE_ATTRIBUTE_UNSPECIFIED"

| "CREATIVE_ATTRIBUTE_VAST"

| "CREATIVE_ATTRIBUTE_VPAID_LINEAR"

| "CREATIVE_ATTRIBUTE_VPAID_NON_LINEAR"[];

readonly creativeId?: bigint;

creativeType?:

| "CREATIVE_TYPE_UNSPECIFIED"

| "CREATIVE_TYPE_STANDARD"

| "CREATIVE_TYPE_EXPANDABLE"

| "CREATIVE_TYPE_VIDEO"

| "CREATIVE_TYPE_NATIVE"

| "CREATIVE_TYPE_TEMPLATED_APP_INSTALL"

| "CREATIVE_TYPE_NATIVE_SITE_SQUARE"

| "CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL"

| "CREATIVE_TYPE_LIGHTBOX"

| "CREATIVE_TYPE_NATIVE_APP_INSTALL"

| "CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE"

| "CREATIVE_TYPE_AUDIO"

| "CREATIVE_TYPE_PUBLISHER_HOSTED"

| "CREATIVE_TYPE_NATIVE_VIDEO"

| "CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO"

| "CREATIVE_TYPE_ASSET_BASED_CREATIVE";

dimensions?: Dimensions;

displayName?: string;

readonly dynamic?: boolean;

entityStatus?:

| "ENTITY_STATUS_UNSPECIFIED"

| "ENTITY_STATUS_ACTIVE"

| "ENTITY_STATUS_ARCHIVED"

| "ENTITY_STATUS_DRAFT"

| "ENTITY_STATUS_PAUSED"

| "ENTITY_STATUS_SCHEDULED_FOR_DELETION";

exitEvents?: ExitEvent[];

expandingDirection?:

| "EXPANDING_DIRECTION_UNSPECIFIED"

| "EXPANDING_DIRECTION_NONE"

| "EXPANDING_DIRECTION_UP"

| "EXPANDING_DIRECTION_DOWN"

| "EXPANDING_DIRECTION_LEFT"

| "EXPANDING_DIRECTION_RIGHT"

| "EXPANDING_DIRECTION_UP_AND_LEFT"

| "EXPANDING_DIRECTION_UP_AND_RIGHT"

| "EXPANDING_DIRECTION_DOWN_AND_LEFT"

| "EXPANDING_DIRECTION_DOWN_AND_RIGHT"

| "EXPANDING_DIRECTION_UP_OR_DOWN"

| "EXPANDING_DIRECTION_LEFT_OR_RIGHT"

| "EXPANDING_DIRECTION_ANY_DIAGONAL";

expandOnHover?: boolean;

hostingSource?:

| "HOSTING_SOURCE_UNSPECIFIED"

| "HOSTING_SOURCE_CM"

| "HOSTING_SOURCE_THIRD_PARTY"

| "HOSTING_SOURCE_HOSTED"

| "HOSTING_SOURCE_RICH_MEDIA";

readonly html5Video?: boolean;

iasCampaignMonitoring?: boolean;

integrationCode?: string;

jsTrackerUrl?: string;

readonly lineItemIds?: bigint[];

readonly mediaDuration?: number;

readonly mp3Audio?: boolean;

readonly name?: string;

notes?: string;

obaIcon?: ObaIcon;

readonly oggAudio?: boolean;

progressOffset?: AudioVideoOffset;

requireHtml5?: boolean;

requireMraid?: boolean;

requirePingForAttribution?: boolean;

readonly reviewStatus?: ReviewStatusInfo;

skipOffset?: AudioVideoOffset;

skippable?: boolean;

thirdPartyTag?: string;

thirdPartyUrls?: ThirdPartyUrl[];

timerEvents?: TimerEvent[];

trackerUrls?: string[];

readonly transcodes?: Transcode[];

universalAdId?: UniversalAdId;

readonly updateTime?: Date;

vastTagUrl?: string;

readonly vpaid?: boolean;

}

§Properties

additionalDimensions?: Dimensions[]

[src]

Optional. Additional dimensions. Applicable when creative_type is one of:

CREATIVE_TYPE_STANDARD * CREATIVE_TYPE_EXPANDABLE * CREATIVE_TYPE_NATIVE * CREATIVE_TYPE_NATIVE_SITE_SQUARE * CREATIVE_TYPE_LIGHTBOX * CREATIVE_TYPE_PUBLISHER_HOSTED If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0.

readonly advertiserId?: bigint

[src]

Output only. The unique ID of the advertiser the creative belongs to.

appendedTag?: string

[src]

Optional. Third-party HTML tracking tag to be appended to the creative tag.

assets?: AssetAssociation[]

[src]

Required. Assets associated to this creative.

readonly cmPlacementId?: bigint

[src]

Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager.

cmTrackingAd?: CmTrackingAd

[src]

Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving:

CREATIVE_TYPE_NATIVE * CREATIVE_TYPE_NATIVE_SITE_SQUARE Output only for other cases.

companionCreativeIds?: bigint[]

[src]

Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * CREATIVE_TYPE_AUDIO * CREATIVE_TYPE_VIDEO

counterEvents?: CounterEvent[]

[src]

Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only.

readonly createTime?: Date

[src]

Output only. The timestamp when the creative was created. Assigned by the system.

readonly creativeAttributes?: "CREATIVE_ATTRIBUTE_UNSPECIFIED" | "CREATIVE_ATTRIBUTE_VAST" | "CREATIVE_ATTRIBUTE_VPAID_LINEAR" | "CREATIVE_ATTRIBUTE_VPAID_NON_LINEAR"[]

[src]

Output only. A list of attributes of the creative that is generated by the system.

readonly creativeId?: bigint

[src]

Output only. The unique ID of the creative. Assigned by the system.

[src]

Required. Immutable. The type of the creative.

dimensions?: Dimensions

[src]

Required. Primary dimensions of the creative. Applicable to all creative types. The value of width_pixels and height_pixels defaults to 0 when creative_type is one of: * CREATIVE_TYPE_VIDEO * CREATIVE_TYPE_AUDIO * CREATIVE_TYPE_NATIVE_VIDEO

displayName?: string

[src]

Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes.

readonly dynamic?: boolean

[src]

Output only. Indicates whether the creative is dynamic.

[src]

Required. Controls whether or not the creative can serve. Accepted values are: * ENTITY_STATUS_ACTIVE * ENTITY_STATUS_ARCHIVED * ENTITY_STATUS_PAUSED

exitEvents?: ExitEvent[]

[src]

Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats.

[src]

Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_EXPANDABLE

expandOnHover?: boolean

[src]

Optional. Indicates the creative will automatically expand on hover. Optional and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_EXPANDABLE

hostingSource?: "HOSTING_SOURCE_UNSPECIFIED" | "HOSTING_SOURCE_CM" | "HOSTING_SOURCE_THIRD_PARTY" | "HOSTING_SOURCE_HOSTED" | "HOSTING_SOURCE_RICH_MEDIA"

[src]

Required. Indicates where the creative is hosted.

readonly html5Video?: boolean

[src]

Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_VIDEO

iasCampaignMonitoring?: boolean

[src]

Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.

integrationCode?: string

[src]

Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters.

jsTrackerUrl?: string

[src]

Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * CREATIVE_TYPE_NATIVE * CREATIVE_TYPE_NATIVE_SITE_SQUARE * CREATIVE_TYPE_NATIVE_VIDEO

readonly lineItemIds?: bigint[]

[src]

Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead.

readonly mediaDuration?: number

[src]

Output only. Media duration of the creative. Applicable when creative_type is one of: * CREATIVE_TYPE_VIDEO * CREATIVE_TYPE_AUDIO * CREATIVE_TYPE_NATIVE_VIDEO * CREATIVE_TYPE_PUBLISHER_HOSTED

readonly mp3Audio?: boolean

[src]

Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_AUDIO

readonly name?: string

[src]

Output only. The resource name of the creative.

notes?: string

[src]

Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.

obaIcon?: ObaIcon

[src]

Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * CREATIVE_TYPE_VIDEO

readonly oggAudio?: boolean

[src]

Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_AUDIO

progressOffset?: AudioVideoOffset

[src]

Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * CREATIVE_TYPE_VIDEO

requireHtml5?: boolean

[src]

Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_STANDARD * CREATIVE_TYPE_EXPANDABLE

requireMraid?: boolean

[src]

Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_STANDARD * CREATIVE_TYPE_EXPANDABLE

requirePingForAttribution?: boolean

[src]

Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager 360 tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_STANDARD * CREATIVE_TYPE_EXPANDABLE Third-party VAST tag creatives are creatives with following hosting_source:

HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_AUDIO * CREATIVE_TYPE_VIDEO

readonly reviewStatus?: ReviewStatusInfo

[src]

Output only. The current status of the creative review process.

skipOffset?: AudioVideoOffset

[src]

Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * CREATIVE_TYPE_VIDEO

skippable?: boolean

[src]

Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * CREATIVE_TYPE_VIDEO

thirdPartyTag?: string

[src]

Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_STANDARD * CREATIVE_TYPE_EXPANDABLE

thirdPartyUrls?: ThirdPartyUrl[]

[src]

Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * CREATIVE_TYPE_AUDIO * CREATIVE_TYPE_VIDEO * CREATIVE_TYPE_NATIVE_VIDEO

timerEvents?: TimerEvent[]

[src]

Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only.

trackerUrls?: string[]

[src]

Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https: (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * CREATIVE_TYPE_NATIVE * CREATIVE_TYPE_NATIVE_SITE_SQUARE * CREATIVE_TYPE_NATIVE_VIDEO

readonly transcodes?: Transcode[]

[src]

Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * CREATIVE_TYPE_VIDEO * CREATIVE_TYPE_NATIVE_VIDEO * CREATIVE_TYPE_AUDIO

universalAdId?: UniversalAdId

[src]

Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * CREATIVE_TYPE_VIDEO

readonly updateTime?: Date

[src]

Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system.

vastTagUrl?: string

[src]

Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_AUDIO * CREATIVE_TYPE_VIDEO

readonly vpaid?: boolean

[src]

Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video Player-Ad Interface). Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_VIDEO