Creative

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

A creative and its classification data.

interface Creative {

readonly accountId?: bigint;

adChoicesDestinationUrl?: string;

advertiserName?: string;

agencyId?: bigint;

readonly apiUpdateTime?: Date;

readonly creativeFormat?:

| "CREATIVE_FORMAT_UNSPECIFIED"

| "HTML"

| "VIDEO"

| "NATIVE";

creativeId?: string;

readonly creativeServingDecision?: CreativeServingDecision;

readonly dealIds?: string[];

declaredAttributes?:

| "ATTRIBUTE_UNSPECIFIED"

| "IMAGE_RICH_MEDIA"

| "ADOBE_FLASH_FLV"

| "IS_TAGGED"

| "IS_COOKIE_TARGETED"

| "IS_USER_INTEREST_TARGETED"

| "EXPANDING_DIRECTION_NONE"

| "EXPANDING_DIRECTION_UP"

| "EXPANDING_DIRECTION_DOWN"

| "EXPANDING_DIRECTION_LEFT"

| "EXPANDING_DIRECTION_RIGHT"

| "EXPANDING_DIRECTION_UP_LEFT"

| "EXPANDING_DIRECTION_UP_RIGHT"

| "EXPANDING_DIRECTION_DOWN_LEFT"

| "EXPANDING_DIRECTION_DOWN_RIGHT"

| "CREATIVE_TYPE_HTML"

| "CREATIVE_TYPE_VAST_VIDEO"

| "EXPANDING_DIRECTION_UP_OR_DOWN"

| "EXPANDING_DIRECTION_LEFT_OR_RIGHT"

| "EXPANDING_DIRECTION_ANY_DIAGONAL"

| "EXPANDING_ACTION_ROLLOVER_TO_EXPAND"

| "INSTREAM_VAST_VIDEO_TYPE_VPAID_FLASH"

| "RICH_MEDIA_CAPABILITY_TYPE_MRAID"

| "RICH_MEDIA_CAPABILITY_TYPE_FLASH"

| "RICH_MEDIA_CAPABILITY_TYPE_HTML5"

| "SKIPPABLE_INSTREAM_VIDEO"

| "RICH_MEDIA_CAPABILITY_TYPE_SSL"

| "RICH_MEDIA_CAPABILITY_TYPE_NON_SSL"

| "RICH_MEDIA_CAPABILITY_TYPE_INTERSTITIAL"

| "NON_SKIPPABLE_INSTREAM_VIDEO"

| "NATIVE_ELIGIBILITY_ELIGIBLE"

| "NON_VPAID"

| "NATIVE_ELIGIBILITY_NOT_ELIGIBLE"

| "ANY_INTERSTITIAL"

| "NON_INTERSTITIAL"

| "IN_BANNER_VIDEO"

| "RENDERING_SIZELESS_ADX"

| "OMSDK_1_0"

| "RENDERING_PLAYABLE"[];

declaredClickThroughUrls?: string[];

declaredRestrictedCategories?: "RESTRICTED_CATEGORY_UNSPECIFIED" | "ALCOHOL"[];

declaredVendorIds?: number[];

html?: HtmlContent;

impressionTrackingUrls?: string[];

readonly name?: string;

native?: NativeContent;

renderUrl?: string;

restrictedCategories?: "RESTRICTED_CATEGORY_UNSPECIFIED" | "ALCOHOL"[];

readonly version?: number;

video?: VideoContent;

}

§Properties

readonly accountId?: bigint

[src]

Output only. ID of the buyer account that this creative is owned by. Can be used to filter the response of the creatives.list method with equality and inequality check.

adChoicesDestinationUrl?: string

[src]

The link to AdChoices destination page. This is only supported for native ads.

advertiserName?: string

[src]

The name of the company being advertised in the creative. Can be used to filter the response of the creatives.list method.

agencyId?: bigint

[src]

The agency ID for this creative.

readonly apiUpdateTime?: Date

[src]

Output only. The last update timestamp of the creative through the API.

readonly creativeFormat?: "CREATIVE_FORMAT_UNSPECIFIED" | "HTML" | "VIDEO" | "NATIVE"

[src]

Output only. The format of this creative. Can be used to filter the response of the creatives.list method.

creativeId?: string

[src]

Buyer-specific creative ID that references this creative in bid responses. This field is Ignored in update operations. Can be used to filter the response of the creatives.list method. The maximum length of the creative ID is 128 bytes.

readonly creativeServingDecision?: CreativeServingDecision

[src]

Output only. Top level status and detected attributes of a creative (for example domain, language, advertiser, product category, etc.) that affect whether (status) and where (context) a creative will be allowed to serve.

readonly dealIds?: string[]

[src]

Output only. IDs of all of the deals with which this creative has been used in bidding. Can be used to filter the response of the creatives.list method.

[src]

All declared attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. If the excluded_attribute field of a bid request contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction.

declaredClickThroughUrls?: string[]

[src]

The set of declared destination URLs for the creative. Can be used to filter the response of the creatives.list method.

declaredRestrictedCategories?: "RESTRICTED_CATEGORY_UNSPECIFIED" | "ALCOHOL"[]

[src]

All declared restricted categories for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.

declaredVendorIds?: number[]

[src]

IDs for the declared ad technology vendors that may be used by this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. Can be used to filter the response of the creatives.list method.

html?: HtmlContent

[src]

An HTML creative.

impressionTrackingUrls?: string[]

[src]

The set of URLs to be called to record an impression.

readonly name?: string

[src]

Output only. Name of the creative. Follows the pattern buyers/{buyer}/creatives/{creative}, where {buyer} represents the account ID of the buyer who owns the creative, and {creative} is the buyer-specific creative ID that references this creative in the bid response.

native?: NativeContent

[src]

A native creative.

renderUrl?: string

[src]

Experimental field that can be used during the FLEDGE Origin Trial. The URL to fetch an interest group ad used in TURTLEDOVE on-device auction. This should be unique among all creatives for a given accountId. This URL should be the same as the URL returned by generateBid().

restrictedCategories?: "RESTRICTED_CATEGORY_UNSPECIFIED" | "ALCOHOL"[]

[src]

All restricted categories for the ads that may be shown from this creative.

readonly version?: number

[src]

Output only. The version of the creative. Version for a new creative is 1 and it increments during subsequent creative updates.

video?: VideoContent

[src]

A video creative.