buyers

POST /v1/buyers/{buyersId}/userLists/{userListsId}:open

Changes the status of a user list to OPEN. This allows new users to be added to the user list.

Request

Base URL
https://realtimebidding.googleapis.com
Auth
OAuth 2 and OAuth 2
Implicithttps://accounts.google.com/o/oauth2/auth
Scopeshttps://www.googleapis.com/auth/realtime-bidding
Authorization codehttps://accounts.google.com/o/oauth2/auth
Token URLhttps://accounts.google.com/o/oauth2/token
Scopeshttps://www.googleapis.com/auth/realtime-bidding
TypeScript
https://skmtc.dev/google/apis/realtimebidding/docs/v1/buyers/:buyersId/userLists/:userListsId:open/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

buyersIdstring required

userListsIdstring required

Request body

OpenUserListRequest required

A request to open a specified user list.

Response

Successful response

descriptionstring

The description for the user list.

displayNamestring

Required. Display name of the user list. This must be unique across all user lists for a given account.

membershipDurationDaysstring int64

Required. The number of days a user's cookie stays on the user list. The field must be between 0 and 540 inclusive.

namestring

Output only. Name of the user list that must follow the pattern buyers/{buyer}/userLists/{user_list}, where {buyer} represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, {buyer} represents the account ID of the child seat buyer. {user_list} is an int64 identifier assigned by Google to uniquely identify a user list.

status'STATUS_UNSPECIFIED' | 'OPEN' | 'CLOSED'

Output only. The status of the user list. A new user list starts out as open.

Changes

No recorded changes to this operation across all 5 revisions of this API.