Google Ads API is returning to beta status. Please read our blog post for more details.

user_list

The user list referenced in the query.


Attributed resources

Fields from the following resources may be selected along with this resource in your select and where clauses. These fields will not segment metrics.

user_list.access_reason

Field descriptionIndicates 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.v1.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.v1.enums.UserListAccessStatusEnum.UserListAccessStatus
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.basic_user_list.actions

Field descriptionActions associated with this user list.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.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.v1.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 to the Google Ads API. For iOS, the ID string is the 9 digit string that appears at the end of an App Store URL (e.g., "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 (e.g., "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 Type STRING
Type URLgoogle.protobuf.StringValue
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 whitelisted customers can create third-party sourced CRM lists.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.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.v1.enums.CustomerMatchUploadKeyTypeEnum.CustomerMatchUploadKeyType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.description

Field descriptionDescription of this user list.
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.eligible_for_display

Field descriptionIndicates this user list is eligible for Google Display Network. This field is read-only.
CategoryATTRIBUTE
Data Type BOOLEAN
Type URLgoogle.protobuf.BoolValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.eligible_for_search

Field descriptionIndicates if this user list is eligible for Google Search Network.
CategoryATTRIBUTE
Data Type BOOLEAN
Type URLgoogle.protobuf.BoolValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.id

Field descriptionId of the user list.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
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 Type STRING
Type URLgoogle.protobuf.StringValue
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 Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.UserListLogicalRuleInfo
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

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. It'll be ignored for logical_user_list.
CategoryATTRIBUTE
Data Type INT64
Type URLgoogle.protobuf.Int64Value
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.v1.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 (e.g. if access_reason=SHARED)
CategoryATTRIBUTE
Data Type STRING
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.read_only

Field descriptionA 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.
CategoryATTRIBUTE
Data Type BOOLEAN
Type URLgoogle.protobuf.BoolValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.resource_name

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

user_list.rule_based_user_list.combined_rule_user_list.left_operand.rule_item_groups

Field descriptionList of rule item groups that defines this rule. Rule item groups are grouped together based on rule_type.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.UserListRuleItemGroupInfo
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

user_list.rule_based_user_list.combined_rule_user_list.left_operand.rule_type

Field descriptionRule type is used to determine how to group rule items. The default is OR of ANDs (disjunctive normal form). That is, rule items will be ANDed together within rule item groups and the groups themselves will be ORed together. Currently AND of ORs (conjunctive normal form) is only supported for ExpressionRuleUserList.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.UserListRuleTypeEnum.UserListRuleType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.rule_based_user_list.combined_rule_user_list.right_operand.rule_item_groups

Field descriptionList of rule item groups that defines this rule. Rule item groups are grouped together based on rule_type.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.UserListRuleItemGroupInfo
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

user_list.rule_based_user_list.combined_rule_user_list.right_operand.rule_type

Field descriptionRule type is used to determine how to group rule items. The default is OR of ANDs (disjunctive normal form). That is, rule items will be ANDed together within rule item groups and the groups themselves will be ORed together. Currently AND of ORs (conjunctive normal form) is only supported for ExpressionRuleUserList.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.UserListRuleTypeEnum.UserListRuleType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.rule_based_user_list.combined_rule_user_list.rule_operator

Field descriptionOperator to connect the two operands. Required for creating a combined rule user list.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.UserListCombinedRuleOperatorEnum.UserListCombinedRuleOperator
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.rule_based_user_list.date_specific_rule_user_list.end_date

Field descriptionEnd date of users visit. If set to 2037-12-30, then the list includes all users after start_date. The date's format should be YYYY-MM-DD. Required for creating a data specific rule user list.
CategoryATTRIBUTE
Data Type DATE
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.rule_based_user_list.date_specific_rule_user_list.rule.rule_item_groups

Field descriptionList of rule item groups that defines this rule. Rule item groups are grouped together based on rule_type.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.UserListRuleItemGroupInfo
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

user_list.rule_based_user_list.date_specific_rule_user_list.rule.rule_type

Field descriptionRule type is used to determine how to group rule items. The default is OR of ANDs (disjunctive normal form). That is, rule items will be ANDed together within rule item groups and the groups themselves will be ORed together. Currently AND of ORs (conjunctive normal form) is only supported for ExpressionRuleUserList.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.UserListRuleTypeEnum.UserListRuleType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.rule_based_user_list.date_specific_rule_user_list.start_date

Field descriptionStart date of users visit. If set to 2000-01-01, then the list includes all users before end_date. The date's format should be YYYY-MM-DD. Required for creating a data specific rule user list.
CategoryATTRIBUTE
Data Type DATE
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.rule_based_user_list.expression_rule_user_list.rule.rule_item_groups

Field descriptionList of rule item groups that defines this rule. Rule item groups are grouped together based on rule_type.
CategoryATTRIBUTE
Data Type MESSAGE
Type URLgoogle.ads.googleads.v1.common.UserListRuleItemGroupInfo
FilterableFalse
SelectableTrue
SortableFalse
RepeatedTrue

user_list.rule_based_user_list.expression_rule_user_list.rule.rule_type

Field descriptionRule type is used to determine how to group rule items. The default is OR of ANDs (disjunctive normal form). That is, rule items will be ANDed together within rule item groups and the groups themselves will be ORed together. Currently AND of ORs (conjunctive normal form) is only supported for ExpressionRuleUserList.
CategoryATTRIBUTE
Data Type
Type URLgoogle.ads.googleads.v1.enums.UserListRuleTypeEnum.UserListRuleType
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.v1.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 Type RESOURCE_NAME
Type URLgoogle.protobuf.StringValue
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.size_for_display

Field descriptionEstimated 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 Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.size_for_search

Field descriptionEstimated 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 Type INT64
Type URLgoogle.protobuf.Int64Value
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.size_range_for_display

Field descriptionSize 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.v1.enums.UserListSizeRangeEnum.UserListSizeRange
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.size_range_for_search

Field descriptionSize 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.v1.enums.UserListSizeRangeEnum.UserListSizeRange
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

user_list.type

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

Skicka feedback om ...

Google Ads API Beta
Google Ads API Beta
Behöver du hjälp? Besök vår supportsida.