Starting
September 8, 2025, every new line item will need to declare whether or not they will serve Eurpoean Union (EU) political ads. Display & Video 360 API and SDF uploads that don't provide declarations will fail. See our
deprecations page for more details on how to update your integration to make this declaration.
Method: customBiddingAlgorithms.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful.
Requests updating a custom bidding algorithm assigned to a line item will return an error.
HTTP request
PATCH https://displayvideo.googleapis.com/v4/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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-03 UTC.
[null,null,["Last updated 2025-04-03 UTC."],[],["The Display & Video 360 API v4 (beta) allows updating custom bidding algorithms via a PATCH request. The request URL uses gRPC Transcoding syntax, and requires specifying the algorithm's unique ID as a path parameter. The `updateMask` query parameter is mandatory for controlling which fields to update. The request body contains the `CustomBiddingAlgorithm` instance, and upon success, the response returns the updated `CustomBiddingAlgorithm`. Updates to algorithms assigned to line items will be deprecated starting April 1, 2025. Authorization requires the `https://www.googleapis.com/auth/display-video` scope.\n"],null,["# Method: customBiddingAlgorithms.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful.\n\nRequests updating a custom bidding algorithm assigned to a line item will return an error.\n\n### HTTP request\n\n`PATCH https://displayvideo.googleapis.com/v4/customBiddingAlgorithms/{customBiddingAlgorithm.customBiddingAlgorithmId}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customBiddingAlgorithm.customBiddingAlgorithmId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Output only. The unique ID of the custom bidding algorithm. Assigned by the system. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` 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\"`. |\n\n### Request body\n\nThe request body contains an instance of [CustomBiddingAlgorithm](/display-video/api/reference/rest/v4/customBiddingAlgorithms#CustomBiddingAlgorithm).\n\n### Response body\n\nIf successful, the response body contains an instance of [CustomBiddingAlgorithm](/display-video/api/reference/rest/v4/customBiddingAlgorithms#CustomBiddingAlgorithm).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/display-video`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
