type CrmBasedUserList (v201809)

Service

AdwordsUserListService

Inheritance

UserList

▼

BasicUserList CrmBasedUserList LogicalUserList RuleBasedUserList SimilarUserList

UserList of CRM users provided by the advertiser.

---

Namespace

https://adwords.google.com/api/adwords/rm/v201809

Field
UserList (inherited)
id	xsd:long Id of this user list. This field can be selected using the value "Id". This field can be filtered on. This field is required and should not be null when it is contained within Operators : SET.
isReadOnly	xsd:boolean A 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 can be selected using the value "IsReadOnly". This field is read only and will be ignored when sent to the API.
name	xsd:string Name of this user list. Depending on its AccessReason, the user list name may not be unique (e.g. if AccessReason=SHARED). This field can be selected using the value "Name". This field can be filtered on.
description	xsd:string Description of this user list. This field can be selected using the value "Description".
status	UserListMembershipStatus 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. Enumerations OPEN Open status - list is accruing members and can be targeted to. CLOSED Closed status - No new members being added. Can not be used for targeting. This field can be selected using the value "Status". This field can be filtered on.
integrationCode	xsd:string An Id from external system. It is used by user list sellers to correlate ids on their systems. This field can be selected using the value "IntegrationCode". This field can be filtered on.
accessReason	AccessReason Indicates the reason this account has been granted access to the list. The reason can be Shared, Owned, Licensed or Subscribed. Enumerations OWNED The entity is owned by the user. SHARED The entity is shared to the user. LICENSED The entity is licensed to the user. SUBSCRIBED The user subscribed to the entity. This field can be selected using the value "AccessReason". This field can be filtered on. This field is read only and will be ignored when sent to the API.
accountUserListStatus	AccountUserListStatus Indicates if this share is still active. When a UserList is shared with the user this field is set to Active. Later the userList owner can decide to revoke the share and make it Inactive. The default value of this field is set to Active. Enumerations ACTIVE INACTIVE This field can be selected using the value "AccountUserListStatus". This field can be filtered on.
membershipLifeSpan	xsd:long 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 LogicalUserList. This field can be selected using the value "MembershipLifeSpan". This field can be filtered on.
size	xsd:long 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 can be selected using the value "Size". This field can be filtered on. This field is read only and will be ignored when sent to the API.
sizeRange	SizeRange Size range in terms of number of users of the UserList. Enumerations LESS_THAN_FIVE_HUNDRED LESS_THAN_ONE_THOUSAND ONE_THOUSAND_TO_TEN_THOUSAND TEN_THOUSAND_TO_FIFTY_THOUSAND FIFTY_THOUSAND_TO_ONE_HUNDRED_THOUSAND ONE_HUNDRED_THOUSAND_TO_THREE_HUNDRED_THOUSAND THREE_HUNDRED_THOUSAND_TO_FIVE_HUNDRED_THOUSAND FIVE_HUNDRED_THOUSAND_TO_ONE_MILLION ONE_MILLION_TO_TWO_MILLION TWO_MILLION_TO_THREE_MILLION THREE_MILLION_TO_FIVE_MILLION FIVE_MILLION_TO_TEN_MILLION TEN_MILLION_TO_TWENTY_MILLION TWENTY_MILLION_TO_THIRTY_MILLION THIRTY_MILLION_TO_FIFTY_MILLION OVER_FIFTY_MILLION This field can be selected using the value "SizeRange". This field is read only and will be ignored when sent to the API.
sizeForSearch	xsd:long 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 can be selected using the value "SizeForSearch". This field can be filtered on. This field is read only and will be ignored when sent to the API.
sizeRangeForSearch	SizeRange Size range in terms of number of users of the UserList, for Search ads. Enumerations LESS_THAN_FIVE_HUNDRED LESS_THAN_ONE_THOUSAND ONE_THOUSAND_TO_TEN_THOUSAND TEN_THOUSAND_TO_FIFTY_THOUSAND FIFTY_THOUSAND_TO_ONE_HUNDRED_THOUSAND ONE_HUNDRED_THOUSAND_TO_THREE_HUNDRED_THOUSAND THREE_HUNDRED_THOUSAND_TO_FIVE_HUNDRED_THOUSAND FIVE_HUNDRED_THOUSAND_TO_ONE_MILLION ONE_MILLION_TO_TWO_MILLION TWO_MILLION_TO_THREE_MILLION THREE_MILLION_TO_FIVE_MILLION FIVE_MILLION_TO_TEN_MILLION TEN_MILLION_TO_TWENTY_MILLION TWENTY_MILLION_TO_THIRTY_MILLION THIRTY_MILLION_TO_FIFTY_MILLION OVER_FIFTY_MILLION This field can be selected using the value "SizeRangeForSearch". This field is read only and will be ignored when sent to the API.
listType	UserListType Type of this list: remarketing/logical/external remarketing. Enumerations UNKNOWN UNKNOWN value can not be passed as input. REMARKETING UserList represented as a collection of conversion types. LOGICAL UserList represented as a combination of other user lists/interests. EXTERNAL_REMARKETING UserList created in the DoubleClick platform. RULE_BASED UserList associated with a rule. SIMILAR UserList with users similar to users of another UserList. CRM_BASED UserList of first party CRM data provided by advertiser in the form of emails or other formats. This field can be selected using the value "ListType". This field can be filtered on. This field is read only and will be ignored when sent to the API.
isEligibleForSearch	xsd:boolean A flag that indicates this user list is eligible for Google Search Network. This field can be selected using the value "IsEligibleForSearch". This field can be filtered on.
isEligibleForDisplay	xsd:boolean A flag that indicates this user list is eligible for Display Network. This field can be selected using the value "IsEligibleForDisplay". This field can be filtered on. This field is read only and will be ignored when sent to the API.
closingReason	UserListClosingReason 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. Enumerations UNKNOWN UNUSED_LIST The userlist was closed because of not being used for over one year. This field can be selected using the value "ClosingReason". This field can be filtered on.
UserList.Type	xsd:string Indicates that this instance is a subtype of UserList. Although this field is returned in the response, it is ignored on input and cannot be selected. Specify xsi:type instead.
CrmBasedUserList
appId	xsd:string A string that uniquely identifies a mobile application from which the data was collected to AdWords 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. This field can be selected using the value "AppId".
uploadKeyType	CustomerMatchUploadKeyType Matching key type of the list. This field is read only and set on the first upload by API. Mixed data types are not allowed on the same list. From v201802, this field will be required for an ADD operation. Enumerations UNKNOWN CONTACT_INFO Members are matched from customer info such as email address, phone number or physical address. CRM_ID Members are matched from advertiser generated and assigned user id. MOBILE_ADVERTISING_ID Members are matched from mobile advertising ids. This field can be selected using the value "UploadKeyType". This field is read only and will be ignored when sent to the API for the following Operators: SET.
dataSourceType	CrmDataSourceType Data source of the list. Default value is FIRST_PARTY. Only whitelisted customers can create third party sourced crm lists. Enumerations UNKNOWN FIRST_PARTY The uploaded data is first party data. THIRD_PARTY_CREDIT_BUREAU The uploaded data is from third party credit bureau. THIRD_PARTY_VOTER_FILE The uploaded data is from third party voter file. This field can be selected using the value "DataSourceType". This field can be filtered on. This field is read only and will be ignored when sent to the API for the following Operators: SET.
dataUploadResult	DataUploadResult This field can be selected using the value "DataUploadResult". This field is read only and will be ignored when sent to the API for the following Operators: ADD.