PlacementsListOptions

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

Additional options for dfareporting#placementsList.

interface PlacementsListOptions {

activeStatus?:

| "PLACEMENT_STATUS_UNKNOWN"

| "PLACEMENT_STATUS_ACTIVE"

| "PLACEMENT_STATUS_INACTIVE"

| "PLACEMENT_STATUS_ARCHIVED"

| "PLACEMENT_STATUS_PERMANENTLY_ARCHIVED";

advertiserIds?: bigint;

campaignIds?: bigint;

compatibilities?:

| "DISPLAY"

| "DISPLAY_INTERSTITIAL"

| "APP"

| "APP_INTERSTITIAL"

| "IN_STREAM_VIDEO"

| "IN_STREAM_AUDIO";

contentCategoryIds?: bigint;

directorySiteIds?: bigint;

groupIds?: bigint;

ids?: bigint;

maxEndDate?: string;

maxResults?: number;

maxStartDate?: string;

minEndDate?: string;

minStartDate?: string;

pageToken?: string;

paymentSource?: "PLACEMENT_AGENCY_PAID" | "PLACEMENT_PUBLISHER_PAID";

placementStrategyIds?: bigint;

pricingTypes?:

| "PRICING_TYPE_CPM"

| "PRICING_TYPE_CPC"

| "PRICING_TYPE_CPA"

| "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"

| "PRICING_TYPE_FLAT_RATE_CLICKS"

| "PRICING_TYPE_CPM_ACTIVEVIEW";

searchString?: string;

siteIds?: bigint;

sizeIds?: bigint;

sortField?: "ID" | "NAME";

sortOrder?: "ASCENDING" | "DESCENDING";

}

§Properties

activeStatus?: "PLACEMENT_STATUS_UNKNOWN" | "PLACEMENT_STATUS_ACTIVE" | "PLACEMENT_STATUS_INACTIVE" | "PLACEMENT_STATUS_ARCHIVED" | "PLACEMENT_STATUS_PERMANENTLY_ARCHIVED"

[src]

Select only placements with these active statuses.

advertiserIds?: bigint

[src]

Select only placements that belong to these advertisers.

campaignIds?: bigint

[src]

Select only placements that belong to these campaigns.

[src]

Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.

contentCategoryIds?: bigint

[src]

Select only placements that are associated with these content categories.

directorySiteIds?: bigint

[src]

Select only placements that are associated with these directory sites.

groupIds?: bigint

[src]

Select only placements that belong to these placement groups.

ids?: bigint

[src]

Select only placements with these IDs.

maxEndDate?: string

[src]

Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".

maxResults?: number

[src]

Maximum number of results to return.

maxStartDate?: string

[src]

Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".

minEndDate?: string

[src]

Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".

minStartDate?: string

[src]

Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".

pageToken?: string

[src]

Value of the nextPageToken from the previous result page.

paymentSource?: "PLACEMENT_AGENCY_PAID" | "PLACEMENT_PUBLISHER_PAID"

[src]

Select only placements with this payment source.

placementStrategyIds?: bigint

[src]

Select only placements that are associated with these placement strategies.

[src]

Select only placements with these pricing types.

searchString?: string

[src]

Allows searching for placements by name or ID. Wildcards () are allowed. For example, "placement2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 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 "placement" will match placements with name "my placement", "placement 2015", or simply "placement" .

siteIds?: bigint

[src]

Select only placements that are associated with these sites.

sizeIds?: bigint

[src]

Select only placements that are associated with these sizes.

sortField?: "ID" | "NAME"

[src]

Field by which to sort the list.

sortOrder?: "ASCENDING" | "DESCENDING"

[src]

Order of sorted results.