Learn more about migrating to the Google Ads API by watching our latest webinar

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

string

Name of this user list. Depending on its access_reason, the user list name may not be unique (e.g. if access_reason=SHARED)

description

string

Description of this user list.

integration_code

string

An ID from external system. It is used by user list sellers to correlate IDs on their systems.

membership_life_span

int64

Number of days a user's cookie stays on your list since its most recent addition to the list. This field must be between 0 and 540 inclusive. However, for CRM based userlists, this field can be set to 10000 which means no expiration.

It'll be ignored for logical_user_list.

size_for_display

int64

Output only. Estimated number of users in this user list, on the Google Display Network. This value is null if the number of users has not yet been determined.

This field is read-only.

eligible_for_display

bool

Output only. Indicates this user list is eligible for Google Display Network.

This field is read-only.

match_rate_percentage

int32

Output only. Indicates match rate for Customer Match lists. The range of this field is [0-100]. This will be null for other list types or when it's not possible to calculate the match rate.

This field is read-only.

user_list

Union field user_list. The user list.

user_list. The user list.

Exactly one must be set. user_list can be only one of the following:

user_list can be only one of the following:

crm_based_user_list

CrmBasedUserListInfo

User list of CRM users provided by the advertiser.

similar_user_list

SimilarUserListInfo

Output only. User list which are similar to users from another UserList. These lists are readonly and automatically created by google.

rule_based_user_list

RuleBasedUserListInfo

User list generated by a rule.

logical_user_list

LogicalUserListInfo

User list that is a custom combination of user lists and user interests.

basic_user_list

BasicUserListInfo

User list targeting as a collection of conversion or remarketing actions.