user_list.access_reason |
| Field description | 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. |
| Category | ATTRIBUTE |
| Data Type |
ENUM
AFFILIATED
LICENSED
OWNED
SHARED
SUBSCRIBED
UNKNOWN
UNSPECIFIED
|
| Type URL | google.ads.googleads.v26.enums.AccessReasonEnum.AccessReason |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.account_user_list_status |
| Field description | 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. |
| Category | ATTRIBUTE |
| Data Type |
ENUM
DISABLED
ENABLED
UNKNOWN
UNSPECIFIED
|
| Type URL | google.ads.googleads.v26.enums.UserListAccessStatusEnum.UserListAccessStatus |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.basic_user_list.actions |
| Field description | Actions associated with this user list. |
| Category | ATTRIBUTE |
| Data Type | MESSAGE |
| Type URL | google.ads.googleads.v26.common.UserListActionInfo |
| Filterable | False |
| Selectable | True |
| Sortable | False |
| Repeated | True |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.closing_reason |
| Field description | 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. |
| Category | ATTRIBUTE |
| Data Type |
ENUM
UNKNOWN
UNSPECIFIED
UNUSED
|
| Type URL | google.ads.googleads.v26.enums.UserListClosingReasonEnum.UserListClosingReason |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.crm_based_user_list.app_id |
| Field description | 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. |
| Category | ATTRIBUTE |
| Data Type | STRING |
| Type URL | N/A |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.crm_based_user_list.data_source_type |
| Field description | Data source of the list. Default value is FIRST_PARTY.
Only customers on the allow-list can create third-party sourced CRM lists. |
| Category | ATTRIBUTE |
| Data Type |
ENUM
FIRST_PARTY
THIRD_PARTY_CREDIT_BUREAU
THIRD_PARTY_PARTNER_DATA
THIRD_PARTY_VOTER_FILE
UNKNOWN
UNSPECIFIED
|
| Type URL | google.ads.googleads.v26.enums.UserListCrmDataSourceTypeEnum.UserListCrmDataSourceType |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.crm_based_user_list.upload_key_type |
| Field description | Matching key type of the list.
Mixed data types are not allowed on the same list.
This field is required for an ADD operation. |
| Category | ATTRIBUTE |
| Data Type |
ENUM
CONTACT_INFO
CRM_ID
MOBILE_ADVERTISING_ID
UNKNOWN
UNSPECIFIED
|
| Type URL | google.ads.googleads.v26.enums.CustomerMatchUploadKeyTypeEnum.CustomerMatchUploadKeyType |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.description |
| Field description | Description of this user list. |
| Category | ATTRIBUTE |
| Data Type | STRING |
| Type URL | N/A |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.eligible_for_display |
| Field description | Output only. Indicates this user list is eligible for Google Display
Network.
This field is read-only. |
| Category | ATTRIBUTE |
| Data Type | BOOLEAN |
| Type URL | N/A |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.eligible_for_search |
| Field description | Indicates if this user list is eligible for Google Search Network. |
| Category | ATTRIBUTE |
| Data Type | BOOLEAN |
| Type URL | N/A |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.id |
| Field description | Output only. Id of the user list. |
| Category | ATTRIBUTE |
| Data Type | INT64 |
| Type URL | N/A |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.integration_code |
| Field description | An ID from external system. It is used by user list sellers to correlate
IDs on their systems. |
| Category | ATTRIBUTE |
| Data Type | STRING |
| Type URL | N/A |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.logical_user_list.rules |
| Field description | 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. |
| Category | ATTRIBUTE |
| Data Type | MESSAGE |
| Type URL | google.ads.googleads.v26.common.UserListLogicalRuleInfo |
| Filterable | False |
| Selectable | True |
| Sortable | False |
| Repeated | True |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.lookalike_user_list.country_codes |
| Field description | Countries targeted by the Lookalike. Two-letter country code as defined by
ISO-3166 |
| Category | ATTRIBUTE |
| Data Type | STRING |
| Type URL | N/A |
| Filterable | True |
| Selectable | True |
| Sortable | False |
| Repeated | True |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.lookalike_user_list.expansion_level |
| Field description | Expansion level, reflecting the size of the lookalike audience |
| Category | ATTRIBUTE |
| Data Type |
ENUM
BALANCED
BROAD
NARROW
UNKNOWN
UNSPECIFIED
|
| Type URL | google.ads.googleads.v26.enums.LookalikeExpansionLevelEnum.LookalikeExpansionLevel |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.lookalike_user_list.seed_user_list_ids |
| Field description | Seed UserList ID from which this list is derived, provided by user. |
| Category | ATTRIBUTE |
| Data Type | INT64 |
| Type URL | N/A |
| Filterable | True |
| Selectable | True |
| Sortable | False |
| Repeated | True |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.match_rate_percentage |
| Field description | 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. |
| Category | ATTRIBUTE |
| Data Type | INT32 |
| Type URL | N/A |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.membership_life_span |
| Field description | 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.
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. |
| Category | ATTRIBUTE |
| Data Type | INT64 |
| Type URL | N/A |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.membership_status |
| Field description | 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. |
| Category | ATTRIBUTE |
| Data Type |
ENUM
CLOSED
OPEN
UNKNOWN
UNSPECIFIED
|
| Type URL | google.ads.googleads.v26.enums.UserListMembershipStatusEnum.UserListMembershipStatus |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.name |
| Field description | Name of this user list.
Unique per user list, except in some cases where a user list of the same
name has access_reason set to SHARED. |
| Category | ATTRIBUTE |
| Data Type | STRING |
| Type URL | N/A |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.read_only |
| Field description | 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. |
| Category | ATTRIBUTE |
| Data Type | BOOLEAN |
| Type URL | N/A |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.resource_name |
| Field description | Immutable. The resource name of the user list.
User list resource names have the form:
customers/{customer_id}/userLists/{user_list_id}
|
| Category | ATTRIBUTE |
| Data Type | RESOURCE_NAME |
| Type URL | N/A |
| Filterable | True |
| Selectable | True |
| Sortable | False |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.rule_based_user_list.flexible_rule_user_list.exclusive_operands |
| Field description | Rules 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. |
| Category | ATTRIBUTE |
| Data Type | MESSAGE |
| Type URL | google.ads.googleads.v26.common.FlexibleRuleOperandInfo |
| Filterable | False |
| Selectable | True |
| Sortable | False |
| Repeated | True |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.rule_based_user_list.flexible_rule_user_list.inclusive_operands |
| Field description | Rules 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. |
| Category | ATTRIBUTE |
| Data Type | MESSAGE |
| Type URL | google.ads.googleads.v26.common.FlexibleRuleOperandInfo |
| Filterable | False |
| Selectable | True |
| Sortable | False |
| Repeated | True |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
|
|
user_list.rule_based_user_list.prepopulation_status |
| Field description | 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. |
| Category | ATTRIBUTE |
| Data Type |
ENUM
FAILED
FINISHED
REQUESTED
UNKNOWN
UNSPECIFIED
|
| Type URL | google.ads.googleads.v26.enums.UserListPrepopulationStatusEnum.UserListPrepopulationStatus |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.similar_user_list.seed_user_list |
| Field description | Seed UserList from which this list is derived. |
| Category | ATTRIBUTE |
| Data Type | RESOURCE_NAME |
| Type URL | N/A |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.size_for_display |
| Field description | 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. |
| Category | ATTRIBUTE |
| Data Type | INT64 |
| Type URL | N/A |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.size_for_search |
| Field description | 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. |
| Category | ATTRIBUTE |
| Data Type | INT64 |
| Type URL | N/A |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.size_range_for_display |
| Field description | Output only. Size range in terms of number of users of the UserList, on the
Google Display Network.
This field is read-only. |
| Category | ATTRIBUTE |
| Data Type |
ENUM
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
|
| Type URL | google.ads.googleads.v26.enums.UserListSizeRangeEnum.UserListSizeRange |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.size_range_for_search |
| Field description | Output only. Size range in terms of number of users of the UserList, for
Search ads.
This field is read-only. |
| Category | ATTRIBUTE |
| Data Type |
ENUM
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
|
| Type URL | google.ads.googleads.v26.enums.UserListSizeRangeEnum.UserListSizeRange |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
user_list.type |
| Field description | Output only. Type of this list.
This field is read-only. |
| Category | ATTRIBUTE |
| Data Type |
ENUM
CRM_BASED
EXTERNAL_REMARKETING
LOGICAL
LOOKALIKE
REMARKETING
RULE_BASED
SIMILAR
UNKNOWN
UNSPECIFIED
|
| Type URL | google.ads.googleads.v26.enums.UserListTypeEnum.UserListType |
| Filterable | True |
| Selectable | True |
| Sortable | True |
| Repeated | False |
| Selectable with |
The following fields/resources can be selected with this field:
|
|
