Method: customBiddingAlgorithms.uploadRules

  • This page describes how to create a rules reference object for an AlgorithmRules file which provides a resource path for uploading the file.

  • The resulting reference object should be included when creating a new CustomBiddingAlgorithmRules resource.

  • The HTTP request uses the GET method with a specific URL format including a customBiddingAlgorithmId path parameter and owner query parameter.

  • The request body must be empty and a successful response body contains an instance of CustomBiddingAlgorithmRulesRef.

  • The process requires the https://www.googleapis.com/auth/display-video OAuth scope for authorization.

Creates a rules reference object for an AlgorithmRules file.

The resulting reference object provides a resource path where the AlgorithmRules file should be uploaded. This reference object should be included when creating a new CustomBiddingAlgorithmRules resource.

HTTP request

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

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.

Query parameters

Parameters
Union parameter owner. Required. Identifies the DV360 entity that owns the parent custom bidding algorithm. It can be either a partner or an advertiser. owner 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 CustomBiddingAlgorithmRulesRef.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.