Method: customBiddingAlgorithms.get

  • This page documents how to get a custom bidding algorithm using the Display & Video 360 API.

  • The request requires specifying the customBiddingAlgorithmId as a path parameter.

  • It's mandatory to include a query parameter (partnerId or advertiserId) to identify the DV360 entity accessing the algorithm.

  • A successful response returns a CustomBiddingAlgorithm object containing the details of the requested algorithm.

  • Users need the https://www.googleapis.com/auth/display-video OAuth scope for authorization.

Gets a custom bidding algorithm.

HTTP request

GET https://displayvideo.googleapis.com/v2/customBiddingAlgorithms/{customBiddingAlgorithmId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customBiddingAlgorithmId

string (int64 format)

Required. The ID of the custom bidding algorithm to fetch.

Query parameters

Parameters
Union parameter accessor. Required. Identifies which DV360 entity the request is being made within. The Get request will only return a custom bidding algortihm entity that is accessible to the DV360 entity identified within the accessor. 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 partner that has access to the custom bidding algorithm.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of CustomBiddingAlgorithm.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.