AdvertisersListOptions

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

Additional options for DisplayVideo#advertisersList.

interface AdvertisersListOptions {

filter?: string;

orderBy?: string;

pageSize?: number;

pageToken?: string;

partnerId?: bigint;

}

§Properties

filter?: string

[src]

Allows filtering by advertiser fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. * A restriction has the form of {field} {operator} {value}. * The updateTime field must use the GREATER THAN OR EQUAL TO (>=) or LESS THAN OR EQUAL TO (<=) operators.

All other fields must use the EQUALS (=) operator. Supported fields: * advertiserId * displayName * entityStatus * updateTime (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) Examples: * All active advertisers under a partner: entityStatus="ENTITY_STATUS_ACTIVE" * All advertisers with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime<="2020-11-04T18:54:47Z" * All advertisers with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z" 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: * advertiserId (default) * displayName * entityStatus * updateTime The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc.

pageSize?: number

[src]

Requested page size. Must be between 1 and 200. If unspecified will default to 100.

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 ListAdvertisers method. If not specified, the first page of results will be returned.

partnerId?: bigint

[src]

Required. The ID of the partner that the fetched advertisers should all belong to. The system only supports listing advertisers for one partner at a time.