v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13177414729.5 KB
customBiddingAlgorithms

Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter.

get/v4/customBiddingAlgorithms

Query parameters

advertiserIdstring

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

filterstring

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.

orderBystring

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.

pageSizeinteger

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.

pageTokenstring

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.

partnerIdstring

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

Response

Successful response