user_list

  • A user list is a list of users a customer may target for advertising.

  • User list data includes an ID, name, resource name and type.

  • User list resource names follow the format: customers/{customer_id}/userLists/{user_list_id}.

  • User list types include CRM-based, external remarketing, logical, remarketing, rule-based, and similar.

A user list. This is a list of users a customer may target. The unique key of a user list consists of the following fields: id. Note that the name must also be unique for user lists owned by a given customer, except in some cases where access_reason is set to SHARED. Violating the unique name constraint produces error: UserListError.INVALID_NAME.

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.

Fields/Segments/Metrics

This page shows all metrics and segments that can be put in the same SELECT clause as the fields of user_list. However, when you specify user_list in the FROM clause, some metrics and segments cannot be used. Use the following filter to show only the fields that can be used when user_list is specified in the FROM clause.

Is user_list specified in the FROM clause of your query?

 Resource fields
id
name
resource_name
type
 Segments
date
keyword.ad_group_criterion
keyword.info.match_type
keyword.info.text

user_list.id

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

user_list.name

Field descriptionName 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.
CategoryATTRIBUTE
Data TypeSTRING
Type URLN/A
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 TypeRESOURCE_NAME
Type URLN/A
FilterableTrue
SelectableTrue
SortableFalse
RepeatedFalse

user_list.type

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

segments.date

Field descriptionDate to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
CategorySEGMENT
Data TypeDATE
Type URLN/A
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.keyword.ad_group_criterion

Field descriptionThe AdGroupCriterion resource name.
CategorySEGMENT
Data TypeRESOURCE_NAME
Type URLN/A
FilterableTrue
SelectableTrue
SortableFalse
RepeatedFalse

segments.keyword.info.match_type

Field descriptionThe match type of the keyword.
CategorySEGMENT
Data Type
Type URLgoogle.ads.searchads360.v0.enums.KeywordMatchTypeEnum.KeywordMatchType
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse

segments.keyword.info.text

Field descriptionThe text of the keyword (at most 80 characters and 10 words).
CategorySEGMENT
Data TypeSTRING
Type URLN/A
FilterableTrue
SelectableTrue
SortableTrue
RepeatedFalse