Method: buyers.userLists.close
Stay organized with collections
Save and categorize content based on your preferences.
Changes the status of a user list to CLOSED. This prevents new users from being added to the user list.
HTTP request
POST https://realtimebidding.googleapis.com/v1/{name=buyers/*/userLists/*}:close
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The name of the user list to close. 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\u003eCloses a user list, preventing new users from being added.\u003c/p\u003e\n"],["\u003cp\u003eRequires a POST request to the specified endpoint with the user list name.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty, and a successful response returns the UserList object.\u003c/p\u003e\n"],["\u003cp\u003eNeeds authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/realtime-bidding\u003c/code\u003e scope.\u003c/p\u003e\n"]]],[],null,["# Method: buyers.userLists.close\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\nChanges the status of a user list to CLOSED. This prevents new users from being added to the user list.\n\n### HTTP request\n\n`POST https://realtimebidding.googleapis.com/v1/{name=buyers/*/userLists/*}:close`\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 close. 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`"]]
