Share your feedback about the Google Ads (AdWords) API. Take the 2021 AdWords API and Google Ads API Annual Survey.

UserList

A user list. This is a list of users a customer may target.

Fields

resource_name

string

Immutable. The resource name of the user list. User list resource names have the form:

customers/{customer_id}/userLists/{user_list_id}

membership_status

UserListMembershipStatus

Membership status of this user list. Indicates whether a user list is open or active. Only open user lists can accumulate more users and can be targeted to.

size_range_for_display

UserListSizeRange

Output only. Size range in terms of number of users of the UserList, on the Google Display Network.

This field is read-only.

type

UserListType

Output only. Type of this list.

This field is read-only.

closing_reason

UserListClosingReason

Indicating the reason why this user list membership status is closed. It is only populated on lists that were automatically closed due to inactivity, and will be cleared once the list membership status becomes open.

access_reason

AccessReason

Output only. Indicates the reason this account has been granted access to the list. The reason can be SHARED, OWNED, LICENSED or SUBSCRIBED.

This field is read-only.

account_user_list_status

UserListAccessStatus

Indicates if this share is still enabled. When a UserList is shared with the user this field is set to ENABLED. Later the userList owner can decide to revoke the share and make it DISABLED. The default value of this field is set to ENABLED.

id

int64

Output only. Id of the user list.

read_only

bool

Output only. A flag that indicates if a user may edit a list. Depends on the list ownership and list type. For example, external remarketing user lists are not editable.

This field is read-only.

name