Method: bidders.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all the bidder accounts that belong to the caller.
HTTP request
GET https://realtimebidding.googleapis.com/v1/bidders
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
pageSize |
integer
The maximum number of bidders to return. If unspecified, at most 100 bidders will be returned. The maximum value is 500; values above 500 will be coerced to 500.
|
pageToken |
string
A token identifying a page of results the server should return. This value is received from a previous bidders.list call in ListBiddersResponse.nextPageToken.
|
Request body
The request body must be empty.
Response body
A response containing bidders.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"bidders": [
{
object (Bidder)
}
],
"nextPageToken": string
} |
| Fields |
bidders[] |
object (Bidder)
List of bidders.
|
nextPageToken |
string
A token which can be passed to a subsequent call to the bidders.list method to retrieve the next page of results in ListBiddersRequest.pageToken.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/realtime-bidding
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-05-07 UTC.
[null,null,["Last updated 2025-05-07 UTC."],[[["\u003cp\u003eLists all the bidder accounts belonging to the caller, with a maximum of 100 bidders returned by default.\u003c/p\u003e\n"],["\u003cp\u003eAllows for pagination to retrieve large sets of bidders using \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe response body provides a list of bidders and a token for accessing the next page of results.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/realtime-bidding\u003c/code\u003e scope.\u003c/p\u003e\n"]]],[],null,["# Method: bidders.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListBiddersResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all the bidder accounts that belong to the caller.\n\n### HTTP request\n\n`GET https://realtimebidding.googleapis.com/v1/bidders`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of bidders to return. If unspecified, at most 100 bidders will be returned. The maximum value is 500; values above 500 will be coerced to 500. |\n| `pageToken` | `string` A token identifying a page of results the server should return. This value is received from a previous `bidders.list` call in [ListBiddersResponse.nextPageToken](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders/list#body.ListBiddersResponse.FIELDS.next_page_token). |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA response containing bidders.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"bidders\": [ { object (/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders#Bidder) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `bidders[]` | `object (`[Bidder](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders#Bidder)`)` List of bidders. |\n| `nextPageToken` | `string` A token which can be passed to a subsequent call to the `bidders.list` method to retrieve the next page of results in [ListBiddersRequest.pageToken](/authorized-buyers/apis/realtimebidding/reference/rest/v1/bidders/list#body.QUERY_PARAMETERS.page_token). |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/realtime-bidding`"]]
