Creative

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

A creative and its classification data.

interface Creative {

accountId?: string;

adChoicesDestinationUrl?: string;

adTechnologyProviders?: AdTechnologyProviders;

advertiserName?: string;

agencyId?: bigint;

apiUpdateTime?: Date;

attributes?:

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

clickThroughUrls?: string[];

corrections?: Correction[];

creativeId?: string;

dealsStatus?:

| "STATUS_UNSPECIFIED"

| "NOT_CHECKED"

| "CONDITIONALLY_APPROVED"

| "APPROVED"

| "DISAPPROVED"

| "PENDING_REVIEW"

| "STATUS_TYPE_UNSPECIFIED";

declaredClickThroughUrls?: string[];

detectedAdvertiserIds?: bigint[];

detectedDomains?: string[];

detectedLanguages?: string[];

detectedProductCategories?: number[];

detectedSensitiveCategories?: number[];

html?: HtmlContent;

impressionTrackingUrls?: string[];

native?: NativeContent;

openAuctionStatus?:

| "STATUS_UNSPECIFIED"

| "NOT_CHECKED"

| "CONDITIONALLY_APPROVED"

| "APPROVED"

| "DISAPPROVED"

| "PENDING_REVIEW"

| "STATUS_TYPE_UNSPECIFIED";

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

servingRestrictions?: ServingRestriction[];

vendorIds?: number[];

version?: number;

video?: VideoContent;

}

§Properties

accountId?: string

[src]

The account that this creative belongs to. Can be used to filter the response of the creatives.list method.

adChoicesDestinationUrl?: string

[src]

The link to AdChoices destination page.

adTechnologyProviders?: AdTechnologyProviders

[src]

Output only. The detected ad technology providers.

advertiserName?: string

[src]

The name of the company being advertised in the creative.

agencyId?: bigint

[src]

The agency ID for this creative.

apiUpdateTime?: Date

[src]

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

[src]

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

clickThroughUrls?: string[]

[src]

The set of destination URLs for the creative.

corrections?: Correction[]

[src]

Output only. Shows any corrections that were applied to this creative.

creativeId?: string

[src]

The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.

[src]

Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.

declaredClickThroughUrls?: string[]

[src]

The set of declared destination URLs for the creative.

detectedAdvertiserIds?: bigint[]

[src]

Output only. Detected advertiser IDs, if any.

detectedDomains?: string[]

[src]

Output only. The detected domains for this creative.

detectedLanguages?: string[]

[src]

Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes.

detectedProductCategories?: number[]

[src]

Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs.

detectedSensitiveCategories?: number[]

[src]

Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.

html?: HtmlContent

[src]

An HTML creative.

impressionTrackingUrls?: string[]

[src]

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

native?: NativeContent

[src]

A native creative.

[src]

Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.

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

[src]

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

servingRestrictions?: ServingRestriction[]

[src]

Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS versus HTTP request, or the type of auction).

vendorIds?: number[]

[src]

All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values.

version?: number

[src]

Output only. The version of this creative.

video?: VideoContent

[src]

A video creative.