Method: customBiddingAlgorithms.patch

  • This document outlines the process for updating an existing custom bidding algorithm using the Display & Video 360 API.

  • The update is executed through a PATCH request to a specific endpoint, with the algorithm ID provided as a path parameter.

  • A request body containing the desired algorithm changes is required, along with a query parameter specifying which fields should be updated.

  • Upon successful execution, the API will return the updated custom bidding algorithm object in the response body.

  • Proper authorization with the 'https://www.googleapis.com/auth/display-video' scope is necessary to use this functionality.

Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customBiddingAlgorithm.customBiddingAlgorithmId

string (int64 format)

Output only. The unique ID of the custom bidding algorithm. Assigned by the system.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The mask to control which fields to update.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of CustomBiddingAlgorithm.

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.