Method: buyers.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all buyer account information the calling buyer user or service account is permissioned to manage.
HTTP request
GET https://realtimebidding.googleapis.com/v1/buyers
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
pageSize |
integer
The maximum number of buyers to return. If unspecified, at most 100 buyers 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 buyers.list call in ListBuyersResponse.nextPageToken.
|
Request body
The request body must be empty.
Response body
A response containing buyer account information.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"buyers": [
{
object (Buyer)
}
],
"nextPageToken": string
} |
| Fields |
buyers[] |
object (Buyer)
List of buyers.
|
nextPageToken |
string
A token which can be passed to a subsequent call to the buyers.list method to retrieve the next page of results in ListBuyersRequest.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 buyer account information for the calling buyer user or service account based on permissions.\u003c/p\u003e\n"],["\u003cp\u003eEnables retrieval of buyer information using pagination with \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e parameters.\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"],["\u003cp\u003eProvides a response containing a list of buyers and a token for retrieving subsequent pages.\u003c/p\u003e\n"],["\u003cp\u003eUses a GET request to the endpoint \u003ccode\u003ehttps://realtimebidding.googleapis.com/v1/buyers\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: buyers.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.ListBuyersResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all buyer account information the calling buyer user or service account is permissioned to manage.\n\n### HTTP request\n\n`GET https://realtimebidding.googleapis.com/v1/buyers`\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 buyers to return. If unspecified, at most 100 buyers 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 `buyers.list` call in [ListBuyersResponse.nextPageToken](/authorized-buyers/apis/realtimebidding/reference/rest/v1/buyers/list#body.ListBuyersResponse.FIELDS.next_page_token). |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA response containing buyer account information.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"buyers\": [ { object (/authorized-buyers/apis/realtimebidding/reference/rest/v1/buyers#Buyer) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `buyers[]` | `object (`[Buyer](/authorized-buyers/apis/realtimebidding/reference/rest/v1/buyers#Buyer)`)` List of buyers. |\n| `nextPageToken` | `string` A token which can be passed to a subsequent call to the `buyers.list` method to retrieve the next page of results in [ListBuyersRequest.pageToken](/authorized-buyers/apis/realtimebidding/reference/rest/v1/buyers/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`"]]
