CreativesListOptions
import type { CreativesListOptions } from "https://googleapis.deno.dev/v1/dfareporting:v4.ts";
Additional options for dfareporting#creativesList.
interface CreativesListOptions {
active?: boolean;
advertiserId?: bigint;
archived?: boolean;
campaignId?: bigint;
companionCreativeIds?: bigint;
creativeFieldIds?: bigint;
ids?: bigint;
maxResults?: number;
pageToken?: string;
renderingIds?: bigint;
searchString?: string;
sizeIds?: bigint;
sortField?: "ID" | "NAME";
sortOrder?: "ASCENDING" | "DESCENDING";
studioCreativeId?: bigint;
types?:
} | "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";
§Properties
§
active?: boolean
[src]Select only active creatives. Leave blank to select active and inactive creatives.
§
archived?: boolean
[src]Select only archived creatives. Leave blank to select archived and unarchived creatives.
§
searchString?: string
[src]Allows searching for objects by name or ID. Wildcards () are allowed. For example, "creative2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative".
§
types?: "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"
[src]Select only creatives with these creative types.