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.uploadRules
Stay organized with collections
Save and categorize content based on your preferences.
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.
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-03-27 UTC.
[null,null,["Last updated 2025-03-27 UTC."],[],["The Display & Video 360 API v4, in beta, allows creating a rules reference object for an AlgorithmRules file. This is achieved via a `GET` HTTP request to a specified URL, requiring the `customBiddingAlgorithmId`, and either `partnerId` or `advertiserId` as path and query parameters. The request body should be empty. A successful response provides a CustomBiddingAlgorithmRulesRef instance, indicating the resource path for uploading the AlgorithmRules file, required when creating a CustomBiddingAlgorithmRules resource. The required OAuth scope is `https://www.googleapis.com/auth/display-video`.\n"],null,["# Method: customBiddingAlgorithms.uploadRules\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\nCreates a rules reference object for an [AlgorithmRules](/display-video/api/reference/rest/v4/AlgorithmRules) file.\n\nThe resulting reference object provides a resource path where the [AlgorithmRules](/display-video/api/reference/rest/v4/AlgorithmRules) file should be uploaded. This reference object should be included when creating a new [CustomBiddingAlgorithmRules](/display-video/api/reference/rest/v4/customBiddingAlgorithms.rules#CustomBiddingAlgorithmRules) resource.\n\n### HTTP request\n\n`GET https://displayvideo.googleapis.com/v4/customBiddingAlgorithms/{customBiddingAlgorithmId}:uploadRules`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customBiddingAlgorithmId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The ID of the custom bidding algorithm that owns the rules resource. |\n\n### Query parameters\n\n| Parameters ||\n|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 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: ||\n| `partnerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the partner that owns the parent custom bidding algorithm. |\n| `advertiserId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the advertiser that owns the parent custom bidding algorithm. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [CustomBiddingAlgorithmRulesRef](/display-video/api/reference/rest/v4/customBiddingAlgorithms.rules#CustomBiddingAlgorithmRulesRef).\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)."]]
