Method: buyers.userLists.get
Stay organized with collections
Save and categorize content based on your preferences.
Gets a user list by its name.
HTTP request
GET https://realtimebidding.googleapis.com/v1/{name=buyers/*/userLists/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The name of the user list to be retrieved. See UserList.name.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of UserList.
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 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eRetrieves a user list using its name with an HTTP GET request.\u003c/p\u003e\n"],["\u003cp\u003eRequires providing the user list name as a path parameter in the URL.\u003c/p\u003e\n"],["\u003cp\u003eAn empty request body is necessary, and the response returns a UserList object upon success.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is required using the \u003ccode\u003ehttps://www.googleapis.com/auth/realtime-bidding\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document outlines retrieving a user list by name using a GET request. The `name` path parameter, a string, is required and specifies the target user list. The HTTP request uses gRPC Transcoding syntax with a specific URL. The request body must be empty. A successful response returns a `UserList` instance. This action requires authorization with the `https://www.googleapis.com/auth/realtime-bidding` OAuth scope.\n"],null,["# Method: buyers.userLists.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nGets a user list by its name.\n\n### HTTP request\n\n`GET https://realtimebidding.googleapis.com/v1/{name=buyers/*/userLists/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The name of the user list to be retrieved. See [UserList.name](/authorized-buyers/apis/realtimebidding/reference/rest/v1/buyers.userLists#UserList.FIELDS.name). |\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 [UserList](/authorized-buyers/apis/realtimebidding/reference/rest/v1/buyers.userLists#UserList).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/realtime-bidding`"]]
