AdvertisersListOptions

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

Additional options for dfareporting#advertisersList.

interface AdvertisersListOptions {

advertiserGroupIds?: bigint;

floodlightConfigurationIds?: bigint;

ids?: bigint;

includeAdvertisersWithoutGroupsOnly?: boolean;

maxResults?: number;

onlyParent?: boolean;

pageToken?: string;

searchString?: string;

sortField?: "ID" | "NAME";

sortOrder?: "ASCENDING" | "DESCENDING";

status?: "APPROVED" | "ON_HOLD";

subaccountId?: bigint;

}

§Properties

advertiserGroupIds?: bigint

[src]

Select only advertisers with these advertiser group IDs.

floodlightConfigurationIds?: bigint

[src]

Select only advertisers with these floodlight configuration IDs.

ids?: bigint

[src]

Select only advertisers with these IDs.

includeAdvertisersWithoutGroupsOnly?: boolean

[src]

Select only advertisers which do not belong to any advertiser group.

maxResults?: number

[src]

Maximum number of results to return.

onlyParent?: boolean

[src]

Select only advertisers which use another advertiser's floodlight configuration.

pageToken?: string

[src]

Value of the nextPageToken from the previous result page.

searchString?: string

[src]

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

sortField?: "ID" | "NAME"

[src]

Field by which to sort the list.

sortOrder?: "ASCENDING" | "DESCENDING"

[src]

Order of sorted results.

status?: "APPROVED" | "ON_HOLD"

[src]

Select only advertisers with the specified status.

subaccountId?: bigint

[src]

Select only advertisers with these subaccount IDs.