Skip to main content

user_lists

Overview

Nameuser_lists
TypeResource
Idgoogleads.realtimebidding.user_lists

Fields

NameDatatypeDescription
namestringOutput 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.
descriptionstringThe description for the user list.
statusstringOutput only. The status of the user list. A new user list starts out as open.
urlRestrictionobjectRepresents the URL restriction (for the URL captured by the pixel callback) for a user list.
displayNamestringRequired. Display name of the user list. This must be unique across all user lists for a given account.
membershipDurationDaysstringRequired. The number of days a user's cookie stays on the user list. The field must be between 0 and 540 inclusive.

Methods

NameAccessible byRequired ParamsDescription
buyers_userLists_getSELECTbuyersId, userListsIdGets a user list by its name.
buyers_userLists_listSELECTbuyersIdLists the user lists visible to the current user.
buyers_userLists_createINSERTbuyersIdCreate a new user list.
buyers_userLists_closeEXECbuyersId, userListsIdChange the status of a user list to CLOSED. This prevents new users from being added to the user list.
buyers_userLists_openEXECbuyersId, userListsIdChange the status of a user list to OPEN. This allows new users to be added to the user list.
buyers_userLists_updateEXECbuyersId, userListsIdUpdate the given user list. Only user lists with URLRestrictions can be updated.