Method: customBiddingAlgorithms.rules.get

  • Display & Video 360 API v3 has sunset and users should use v4 instead.

  • This page describes how to retrieve a rules resource using an HTTP GET request.

  • The request requires specifying the custom bidding algorithm ID and the custom bidding algorithm rules ID as path parameters.

  • The request also requires identifying the owning entity of the parent custom bidding algorithm using either a partnerId or advertiserId query parameter.

  • A successful response body contains an instance of CustomBiddingAlgorithmRules and requires the https://www.googleapis.com/auth/display-video OAuth scope for authorization.

Retrieves a rules resource.

HTTP request

GET https://displayvideo.googleapis.com/v3/customBiddingAlgorithms/{customBiddingAlgorithmId}/rules/{customBiddingAlgorithmRulesId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customBiddingAlgorithmId

string (int64 format)

Required. The ID of the custom bidding algorithm that owns the rules resource.
customBiddingAlgorithmRulesId

string (int64 format)

Required. The ID of the rules resource to fetch.

Query parameters

Parameters
Union parameter accessor. Required. Identifies the DV360 entity that owns the parent custom bidding algorithm. It can be either a partner or an advertiser. accessor can be only one of the following:
partnerId

string (int64 format)

The ID of the partner that owns the parent custom bidding algorithm.
advertiserId

string (int64 format)

The ID of the advertiser that owns the parent custom bidding algorithm.

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.