CustomBiddingAlgorithmsListOptions

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

Additional options for DisplayVideo#customBiddingAlgorithmsList.

interface CustomBiddingAlgorithmsListOptions {

advertiserId?: bigint;

filter?: string;

orderBy?: string;

pageSize?: number;

pageToken?: string;

partnerId?: bigint;

}

§Properties

advertiserId?: bigint

[src]

The ID of the DV360 advertiser that has access to the custom bidding algorithm.

filter?: string

[src]

Allows filtering by custom bidding algorithm fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND. A sequence of restrictions implicitly uses AND.

A restriction has the form of {field} {operator} {value}. * The customBiddingAlgorithmType field must use the EQUALS (=) operator. * The displayName field must use the HAS (:) operator. Supported fields:
customBiddingAlgorithmType * displayName Examples: * All custom bidding algorithms for which the display name contains "politics": displayName:"politics". * All custom bidding algorithms for which the type is "SCRIPT_BASED": customBiddingAlgorithmType=SCRIPT_BASED 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: * displayName (default) 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 ListCustomBiddingAlgorithms method. If not specified, the first page of results will be returned.

partnerId?: bigint

[src]

The ID of the DV360 partner that has access to the custom bidding algorithm.