Method: buyers.userLists.close

  • The close method changes a user list's status to CLOSED, preventing new users from being added.

  • The HTTP request uses a POST method with a URL following gRPC Transcoding syntax.

  • The only required path parameter is name, which specifies the user list to close.

  • The request body for this method must be empty.

  • A successful response will contain an instance of UserList.

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