CombinedAudiencesListOptions

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

Additional options for DisplayVideo#combinedAudiencesList.

interface CombinedAudiencesListOptions {

advertiserId?: bigint;

filter?: string;

orderBy?: string;

pageSize?: number;

pageToken?: string;

partnerId?: bigint;

}

§Properties

advertiserId?: bigint

[src]

The ID of the advertiser that has access to the fetched combined audiences.

filter?: string

[src]

Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences can only contain at most one restriction. * A restriction has the form of {field} {operator} {value}.

All fields must use the HAS (:) operator. Supported fields: * displayName Examples: * All combined audiences for which the display name contains "Google": displayName : "Google". The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

orderBy?: string

[src]

Field by which to sort the list. Acceptable values are: * combinedAudienceId (default) * displayName The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

pageSize?: number

[src]

Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

pageToken?: string

[src]

A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListCombinedAudiences method. If not specified, the first page of results will be returned.

partnerId?: bigint

[src]

The ID of the partner that has access to the fetched combined audiences.