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.rules.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists rules resources that belong to the given algorithm.
The order is defined by the orderBy parameter.
HTTP request
GET https://displayvideo.googleapis.com/v4/customBiddingAlgorithms/{customBiddingAlgorithmId}/rules
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 |
pageSize |
integer
Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.
|
pageToken |
string
A token identifying a page of results the server should return. Typically, this is the value of nextPageToken returned from the previous call to rules.list method. If not specified, the first page of results will be returned.
|
orderBy |
string
Field by which to sort the list. Acceptable values are:
createTime desc (default) The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: createTime.
|
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 data with the following structure:
| Fields |
customBiddingRules[] |
object (CustomBiddingAlgorithmRules)
The list of CustomBiddingAlgorithmRules resources. This list will be absent if empty.
|
nextPageToken |
string
A token to retrieve the next page of results. Pass this value in the pageToken field in the subsequent call to ListCustomBiddingAlgorithmRulesRequest method to retrieve the next page of results. If this field is null, it means this is the last page.
|
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."],[],[],null,["# Method: customBiddingAlgorithms.rules.list\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 - [JSON representation](#body.ListCustomBiddingAlgorithmRulesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists rules resources that belong to the given algorithm.\n\nThe order is defined by the [orderBy](/display-video/api/reference/rest/v4/customBiddingAlgorithms.rules/list#body.QUERY_PARAMETERS.order_by) parameter.\n\n### HTTP request\n\n`GET https://displayvideo.googleapis.com/v4/customBiddingAlgorithms/{customBiddingAlgorithmId}/rules`\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| `pageSize` | `integer` Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |\n| `pageToken` | `string` A token identifying a page of results the server should return. Typically, this is the value of [nextPageToken](/display-video/api/reference/rest/v4/customBiddingAlgorithms.rules/list#body.ListCustomBiddingAlgorithmRulesResponse.FIELDS.next_page_token) returned from the previous call to `rules.list` method. If not specified, the first page of results will be returned. |\n| `orderBy` | `string` Field by which to sort the list. Acceptable values are: - `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix \"desc\" should be removed. Example: `createTime`. |\n| 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: ||\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 data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"customBiddingRules\": [ { object (/display-video/api/reference/rest/v4/customBiddingAlgorithms.rules#CustomBiddingAlgorithmRules) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customBiddingRules[]` | `object (`[CustomBiddingAlgorithmRules](/display-video/api/reference/rest/v4/customBiddingAlgorithms.rules#CustomBiddingAlgorithmRules)`)` The list of CustomBiddingAlgorithmRules resources. This list will be absent if empty. |\n| `nextPageToken` | `string` A token to retrieve the next page of results. Pass this value in the [pageToken](/display-video/api/reference/rest/v4/customBiddingAlgorithms.rules/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to `ListCustomBiddingAlgorithmRulesRequest` method to retrieve the next page of results. If this field is null, it means this is the last page. |\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)."]]
