user_list

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

Attributed resources
customer

Fields from the above resources may be selected along with this resource in your SELECT and WHERE clauses. These fields will not segment metrics in your SELECT clause.

user_list.access_reason

Field descriptionOutput 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.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v17.enums.AccessReasonEnum.AccessReason
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.account_user_list_status

Field descriptionIndicates 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.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v17.enums.UserListAccessStatusEnum.UserListAccessStatus
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.basic_user_list.actions

Field descriptionActions associated with this user list.
CategoryATTRIBUTE
Data TypeMESSAGE
Type URLgoogle.ads.googleads.v17.common.UserListActionInfo
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

user_list.closing_reason

Field descriptionIndicating 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.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v17.enums.UserListClosingReasonEnum.UserListClosingReason
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.crm_based_user_list.app_id

Field descriptionA string that uniquely identifies a mobile application from which the data was collected. For iOS, the ID string is the 9 digit string that appears at the end of an App Store URL (for example, "476943146" for "Flood-It! 2" whose App Store link is http://itunes.apple.com/us/app/flood-it!-2/id476943146). For Android, the ID string is the application's package name (for example, "com.labpixies.colordrips" for "Color Drips" given Google Play link https://play.google.com/store/apps/details?id=com.labpixies.colordrips). Required when creating CrmBasedUserList for uploading mobile advertising IDs.
CategoryATTRIBUTE
Data TypeSTRING
Type URLN/A
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.crm_based_user_list.data_source_type

Field descriptionData source of the list. Default value is FIRST_PARTY. Only customers on the allow-list can create third-party sourced CRM lists.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v17.enums.UserListCrmDataSourceTypeEnum.UserListCrmDataSourceType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.crm_based_user_list.upload_key_type

Field descriptionMatching key type of the list. Mixed data types are not allowed on the same list. This field is required for an ADD operation.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v17.enums.CustomerMatchUploadKeyTypeEnum.CustomerMatchUploadKeyType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.description

Field descriptionDescription of this user list.
CategoryATTRIBUTE
Data TypeSTRING
Type URLN/A
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.eligible_for_display

Field descriptionOutput only. Indicates this user list is eligible for Google Display Network. This field is read-only.
CategoryATTRIBUTE
Data TypeBOOLEAN
Type URLN/A
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse
Field descriptionIndicates if this user list is eligible for Google Search Network.
CategoryATTRIBUTE
Data TypeBOOLEAN
Type URLN/A
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.id

Field descriptionOutput only. Id of the user list.
CategoryATTRIBUTE
Data TypeINT64
Type URLN/A
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.integration_code

Field descriptionAn ID from external system. It is used by user list sellers to correlate IDs on their systems.
CategoryATTRIBUTE
Data TypeSTRING
Type URLN/A
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.logical_user_list.rules

Field descriptionLogical list rules that define this user list. The rules are defined as a logical operator (ALL/ANY/NONE) and a list of user lists. All the rules are ANDed when they are evaluated. Required for creating a logical user list.
CategoryATTRIBUTE
Data TypeMESSAGE
Type URLgoogle.ads.googleads.v17.common.UserListLogicalRuleInfo
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

user_list.lookalike_user_list.country_codes

Field descriptionCountries targeted by the Lookalike. Two-letter country code as defined by ISO-3166
CategoryATTRIBUTE
Data TypeSTRING
Type URLN/A
FilterableTrue
SelectableTrue
SortableFalse
RepeatedTrue

user_list.lookalike_user_list.expansion_level

Field descriptionExpansion level, reflecting the size of the lookalike audience
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v17.enums.LookalikeExpansionLevelEnum.LookalikeExpansionLevel
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.lookalike_user_list.seed_user_list_ids

Field descriptionSeed UserList ID from which this list is derived, provided by user.
CategoryATTRIBUTE
Data TypeINT64
Type URLN/A
FilterableTrue
SelectableTrue
SortableFalse
RepeatedTrue

user_list.match_rate_percentage

Field descriptionOutput 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.
CategoryATTRIBUTE
Data TypeINT32
Type URLN/A
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.membership_life_span

Field descriptionNumber 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. This field is ignored for logical_user_list and rule_based_user_list types. Membership to lists of these types depends on the rules defined by the lists.
CategoryATTRIBUTE
Data TypeINT64
Type URLN/A
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.membership_status

Field descriptionMembership 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.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v17.enums.UserListMembershipStatusEnum.UserListMembershipStatus
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.name

Field descriptionName of this user list. Depending on its access_reason, the user list name may not be unique (for example, if access_reason=SHARED)
CategoryATTRIBUTE
Data TypeSTRING
Type URLN/A
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.read_only

Field descriptionOutput only. An option 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.
CategoryATTRIBUTE
Data TypeBOOLEAN
Type URLN/A
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.resource_name

Field descriptionImmutable. The resource name of the user list. User list resource names have the form: customers/{customer_id}/userLists/{user_list_id}
CategoryATTRIBUTE
Data TypeRESOURCE_NAME
Type URLN/A
FilterableTrue
SelectableTrue
SortableFalse
RepeatedFalse

user_list.rule_based_user_list.flexible_rule_user_list.exclusive_operands

Field descriptionRules representing users that should be excluded from the user list. These are located on the right side of the AND_NOT operator, and joined together by OR.
CategoryATTRIBUTE
Data TypeMESSAGE
Type URLgoogle.ads.googleads.v17.common.FlexibleRuleOperandInfo
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

user_list.rule_based_user_list.flexible_rule_user_list.inclusive_operands

Field descriptionRules representing users that should be included in the user list. These are located on the left side of the AND_NOT operator, and joined together by either AND/OR as specified by the inclusive_rule_operator.
CategoryATTRIBUTE
Data TypeMESSAGE
Type URLgoogle.ads.googleads.v17.common.FlexibleRuleOperandInfo
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

user_list.rule_based_user_list.flexible_rule_user_list.inclusive_rule_operator

Field descriptionOperator that defines how the inclusive operands are combined.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v17.enums.UserListFlexibleRuleOperatorEnum.UserListFlexibleRuleOperator
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.rule_based_user_list.prepopulation_status

Field descriptionThe status of pre-population. The field is default to NONE if not set which means the previous users will not be considered. If set to REQUESTED, past site visitors or app users who match the list definition will be included in the list (works on the Display Network only). This will only add past users from within the last 30 days, depending on the list's membership duration and the date when the remarketing tag is added. The status will be updated to FINISHED once request is processed, or FAILED if the request fails.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v17.enums.UserListPrepopulationStatusEnum.UserListPrepopulationStatus
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.similar_user_list.seed_user_list

Field descriptionSeed UserList from which this list is derived.
CategoryATTRIBUTE
Data TypeRESOURCE_NAME
Type URLN/A
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.size_for_display

Field descriptionOutput 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.
CategoryATTRIBUTE
Data TypeINT64
Type URLN/A
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse
Field descriptionOutput only. Estimated number of users in this user list in the google.com domain. These are the users available for targeting in Search campaigns. This value is null if the number of users has not yet been determined. This field is read-only.
CategoryATTRIBUTE
Data TypeINT64
Type URLN/A
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.size_range_for_display

Field descriptionOutput only. Size range in terms of number of users of the UserList, on the Google Display Network. This field is read-only.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v17.enums.UserListSizeRangeEnum.UserListSizeRange
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse
Field descriptionOutput only. Size range in terms of number of users of the UserList, for Search ads. This field is read-only.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v17.enums.UserListSizeRangeEnum.UserListSizeRange
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.type

Field descriptionOutput only. Type of this list. This field is read-only.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v17.enums.UserListTypeEnum.UserListType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse