Method: buyers.userLists.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists the user lists visible to the current user.
HTTP request
GET https://realtimebidding.googleapis.com/v1/{parent=buyers/*}/userLists
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The name of the parent buyer for the user lists to be returned that must follow the pattern buyers/{buyerAccountId}, where {buyerAccountId} represents the account ID of the buyer who owns user lists. For a bidder accessing user lists on behalf of a child seat buyer , {buyerAccountId} should represent the account ID of the child seat buyer.
|
Query parameters
| Parameters |
pageSize |
integer
The number of results to return per page.
|
pageToken |
string
Continuation page token as received from a previous response.
|
Request body
The request body must be empty.
Response body
The list user list response.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"userLists": [
{
object (UserList)
}
],
"nextPageToken": string
} |
| Fields |
userLists[] |
object (UserList)
List of user lists from the search.
|
nextPageToken |
string
The continuation page token to send back to the server in a subsequent request. Due to a currently known issue, it is recommended that the caller keep invoking the list method until the time a next page token is not returned, even if the result set is empty.
|
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\u003eRetrieves a list of user lists visible to the current user, including those owned by the parent buyer or a child seat buyer.\u003c/p\u003e\n"],["\u003cp\u003eThe request can be customized with pagination parameters such as \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe response body includes an array of user lists and a \u003ccode\u003enextPageToken\u003c/code\u003e for retrieving additional results.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/realtime-bidding\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document details how to retrieve a list of user lists. It uses a `GET` request to `https://realtimebidding.googleapis.com/v1/{parent=buyers/*}/userLists`. The `parent` path parameter, a string, specifies the buyer's account ID. Query parameters `pageSize` and `pageToken` manage pagination. The request body is empty. The successful response body includes an array of `userLists` objects and a `nextPageToken` string for further pagination. This operation requires the `https://www.googleapis.com/auth/realtime-bidding` authorization scope.\n"],null,["# Method: buyers.userLists.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.ListUserListsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists the user lists visible to the current user.\n\n### HTTP request\n\n`GET https://realtimebidding.googleapis.com/v1/{parent=buyers/*}/userLists`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The name of the parent buyer for the user lists to be returned that must follow the pattern `buyers/{buyerAccountId}`, where `{buyerAccountId}` represents the account ID of the buyer who owns user lists. For a bidder accessing user lists on behalf of a child seat buyer , `{buyerAccountId}` should represent the account ID of the child seat buyer. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------|\n| `pageSize` | `integer` The number of results to return per page. |\n| `pageToken` | `string` Continuation page token as received from a previous response. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe list user list response.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"userLists\": [ { object (/authorized-buyers/apis/realtimebidding/reference/rest/v1/buyers.userLists#UserList) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `userLists[]` | `object (`[UserList](/authorized-buyers/apis/realtimebidding/reference/rest/v1/buyers.userLists#UserList)`)` List of user lists from the search. |\n| `nextPageToken` | `string` The continuation page token to send back to the server in a subsequent request. Due to a currently known issue, it is recommended that the caller keep invoking the list method until the time a next page token is not returned, even if the result set is empty. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/realtime-bidding`"]]
