UserList
A user list. This is a list of users a customer may target.
Columns
| Name | Type | Behavior | Description |
| CustomerId | Long | ATTRIBUTE | Output only. The ID of the customer. |
| UserListAccessReason | String | ATTRIBUTE | 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.
The allowed values are AFFILIATED, LICENSED, OWNED, SHARED, SUBSCRIBED, UNKNOWN, UNSPECIFIED. |
| UserListAccountUserListStatus | String | ATTRIBUTE | 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.
The allowed values are DISABLED, ENABLED, UNKNOWN, UNSPECIFIED. |
| UserListBasicUserListActions | String | ATTRIBUTE | Actions associated with this user list. |
| UserListClosingReason | String | ATTRIBUTE | 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.
The allowed values are UNKNOWN, UNSPECIFIED, UNUSED. |
| UserListCrmBasedUserListAppId | String | ATTRIBUTE | A 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. |
| UserListCrmBasedUserListDataSourceType | String | ATTRIBUTE | Data source of the list. Default value is FIRST_PARTY. Only customers on the allow-list can create third-party sourced CRM lists.
The allowed values are FIRST_PARTY, THIRD_PARTY_CREDIT_BUREAU, THIRD_PARTY_VOTER_FILE, UNKNOWN, UNSPECIFIED. |
| UserListCrmBasedUserListUploadKeyType | String | ATTRIBUTE | Matching key type of the list. Mixed data types are not allowed on the same list. This field is required for an ADD operation.
The allowed values are CONTACT_INFO, CRM_ID, MOBILE_ADVERTISING_ID, UNKNOWN, UNSPECIFIED. |
| UserListDescription | String | ATTRIBUTE | Description of this user list. |
| UserListEligibleForDisplay | Bool | ATTRIBUTE | Output only. Indicates this user list is eligible for Google Display Network. This field is read-only. |
| UserListEligibleForSearch | Bool | ATTRIBUTE | Indicates if this user list is eligible for Google Search Network. |
| UserListId | Long | ATTRIBUTE | Output only. Id of the user list. |
| UserListIntegrationCode | String | ATTRIBUTE | An ID from external system. It is used by user list sellers to correlate IDs on their systems. |
| UserListLogicalUserListRules | String | ATTRIBUTE | Logical 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. |
| UserListMatchRatePercentage | Int | ATTRIBUTE | 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. |
| UserListMembershipLifeSpan | Long | ATTRIBUTE | 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. |
| UserListMembershipStatus | String | ATTRIBUTE | 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.
The allowed values are CLOSED, OPEN, UNKNOWN, UNSPECIFIED. |
| UserListName | String | ATTRIBUTE | Name of this user list. Depending on its access_reason, the user list name may not be unique (for example, if access_reason=SHARED) |
| UserListReadOnly | Bool | ATTRIBUTE | Output 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. |
| UserListResourceName | String | ATTRIBUTE | Immutable. The resource name of the user list. User list resource names have the form: customers/{customer_id}/userLists/{user_list_id} |
| UserListRuleBasedUserListCombinedRuleUserListLeftOperandRuleItemGroups | String | ATTRIBUTE | List of rule item groups that defines this rule. Rule item groups are grouped together based on rule_type. |
| UserListRuleBasedUserListCombinedRuleUserListLeftOperandRuleType | String | ATTRIBUTE | Rule 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.
The allowed values are AND_OF_ORS, OR_OF_ANDS, UNKNOWN, UNSPECIFIED. |
| UserListRuleBasedUserListCombinedRuleUserListRightOperandRuleItemGroups | String | ATTRIBUTE | List of rule item groups that defines this rule. Rule item groups are grouped together based on rule_type. |
| UserListRuleBasedUserListCombinedRuleUserListRightOperandRuleType | String | ATTRIBUTE | Rule 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.
The allowed values are AND_OF_ORS, OR_OF_ANDS, UNKNOWN, UNSPECIFIED. |
| UserListRuleBasedUserListCombinedRuleUserListRuleOperator | String | ATTRIBUTE | Operator to connect the two operands. Required for creating a combined rule user list.
The allowed values are AND, AND_NOT, UNKNOWN, UNSPECIFIED. |
| UserListRuleBasedUserListExpressionRuleUserListRuleRuleItemGroups | String | ATTRIBUTE | List of rule item groups that defines this rule. Rule item groups are grouped together based on rule_type. |
| UserListRuleBasedUserListExpressionRuleUserListRuleRuleType | String | ATTRIBUTE | Rule 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.
The allowed values are AND_OF_ORS, OR_OF_ANDS, UNKNOWN, UNSPECIFIED. |
| UserListRuleBasedUserListFlexibleRuleUserListExclusiveOperands | String | ATTRIBUTE | Actions that are located on the exclusive side. These are joined together with OR. |
| UserListRuleBasedUserListFlexibleRuleUserListInclusiveOperands | String | ATTRIBUTE | Actions that are located on the inclusive side. These are joined together by either AND/OR as specified by the inclusive_rule_operator. |
| UserListRuleBasedUserListFlexibleRuleUserListInclusiveRuleOperator | String | ATTRIBUTE | Operator that defines how the inclusive operands are combined.
The allowed values are AND, OR, UNKNOWN, UNSPECIFIED. |
| UserListRuleBasedUserListPrepopulationStatus | String | ATTRIBUTE | The 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.
The allowed values are FAILED, FINISHED, REQUESTED, UNKNOWN, UNSPECIFIED. |
| UserListSimilarUserListSeedUserList | String | ATTRIBUTE | Seed UserList from which this list is derived. |
| UserListSizeForDisplay | Long | ATTRIBUTE | 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. |
| UserListSizeForSearch | Long | ATTRIBUTE | Output 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. |
| UserListSizeRangeForDisplay | String | ATTRIBUTE | Output only. Size range in terms of number of users of the UserList, on the Google Display Network. This field is read-only.
The allowed values are FIFTY_THOUSAND_TO_ONE_HUNDRED_THOUSAND, FIVE_HUNDRED_THOUSAND_TO_ONE_MILLION, FIVE_MILLION_TO_TEN_MILLION, LESS_THAN_FIVE_HUNDRED, LESS_THAN_ONE_THOUSAND, ONE_HUNDRED_THOUSAND_TO_THREE_HUNDRED_THOUSAND, ONE_MILLION_TO_TWO_MILLION, ONE_THOUSAND_TO_TEN_THOUSAND, OVER_FIFTY_MILLION, TEN_MILLION_TO_TWENTY_MILLION, TEN_THOUSAND_TO_FIFTY_THOUSAND, THIRTY_MILLION_TO_FIFTY_MILLION, THREE_HUNDRED_THOUSAND_TO_FIVE_HUNDRED_THOUSAND, THREE_MILLION_TO_FIVE_MILLION, TWENTY_MILLION_TO_THIRTY_MILLION, TWO_MILLION_TO_THREE_MILLION, UNKNOWN, UNSPECIFIED. |
| UserListSizeRangeForSearch | String | ATTRIBUTE | Output only. Size range in terms of number of users of the UserList, for Search ads. This field is read-only.
The allowed values are FIFTY_THOUSAND_TO_ONE_HUNDRED_THOUSAND, FIVE_HUNDRED_THOUSAND_TO_ONE_MILLION, FIVE_MILLION_TO_TEN_MILLION, LESS_THAN_FIVE_HUNDRED, LESS_THAN_ONE_THOUSAND, ONE_HUNDRED_THOUSAND_TO_THREE_HUNDRED_THOUSAND, ONE_MILLION_TO_TWO_MILLION, ONE_THOUSAND_TO_TEN_THOUSAND, OVER_FIFTY_MILLION, TEN_MILLION_TO_TWENTY_MILLION, TEN_THOUSAND_TO_FIFTY_THOUSAND, THIRTY_MILLION_TO_FIFTY_MILLION, THREE_HUNDRED_THOUSAND_TO_FIVE_HUNDRED_THOUSAND, THREE_MILLION_TO_FIVE_MILLION, TWENTY_MILLION_TO_THIRTY_MILLION, TWO_MILLION_TO_THREE_MILLION, UNKNOWN, UNSPECIFIED. |
| UserListType | String | ATTRIBUTE | Output only. Type of this list. This field is read-only.
The allowed values are CRM_BASED, EXTERNAL_REMARKETING, LOGICAL, REMARKETING, RULE_BASED, SIMILAR, UNKNOWN, UNSPECIFIED. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| ManagerId | Long | Id of the manager account on behalf of which you are requesting customer data. |