Method: customBiddingAlgorithms.list

Stay organized with collections Save and categorize content based on your preferences.

Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies.

The order is defined by the orderBy parameter.

HTTP request

GET https://displayvideo.googleapis.com/v1/customBiddingAlgorithms

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
pageSize

integer

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

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

string

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.
filter

string

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 operator must be CONTAINS (:) or EQUALS (=).
  • The operator must be CONTAINS (:) for the following field:
    • displayName
  • The operator must be EQUALS (=) for the following field:
    • customBiddingAlgorithmType
    • customBiddingAlgorithmState
  • For displayName, the value is a string. We return all custom bidding algorithms whose displayName contains such string.
  • For customBiddingAlgorithmType, the value is a string. We return all algorithms whose customBiddingAlgorithmType is equal to the given type.
  • For customBiddingAlgorithmState, the value is a string. We return all algorithms whose customBiddingAlgorithmState is equal to the given type.

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
  • All custom bidding algorithms for which the state is "ENABLED": customBiddingAlgorithmState=ENABLED

The length of this field should be no more than 500 characters.
Union parameter accessor. Required. Identifies which DV360 entity the request is being made within. The LIST request will only return custom bidding algortihm entities that are accessible to the DV360 entity identified within the accessor. To perform LIST request, user needs to have permission to the accessor entity. accessor can be only one of the following:
partnerId

string (int64 format)

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

string (int64 format)

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

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation 
{
  "customBiddingAlgorithms": [
    {
      object (CustomBiddingAlgorithm)
    }
  ],
  "nextPageToken": string
}
Fields
customBiddingAlgorithms[]

object (CustomBiddingAlgorithm)

The list of custom bidding algorithms.

This list will be absent if empty.
nextPageToken

string

A token to retrieve the next page of results. Pass this value in the pageToken field in the subsequent call to ListCustomBiddingAlgorithmsRequest method to retrieve the next page of results. If this field is null, it means this is the last page.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/display-video

For more information, see the OAuth 2.0 Overview.