Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdWords.v201809.CrmBasedUserList Class Reference

UserList of CRM users provided by the advertiser. More...

Inheritance diagram for Google.Api.Ads.AdWords.v201809.CrmBasedUserList:
Google.Api.Ads.AdWords.v201809.UserList

Classes

class  Fields
 List of all supported fields for the CrmBasedUserList class. More...
 
class  FilterableFields
 List of all supported filterable fields for the CrmBasedUserList class. More...
 
class  SelectableFields
 List of all supported selectable fields for the CrmBasedUserList class. More...
 

Properties

string appId [get, set]
 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". More...
 
CustomerMatchUploadKeyType uploadKeyType [get, set]
 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. 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. More...
 
bool uploadKeyTypeSpecified [get, set]
 
CrmDataSourceType dataSourceType [get, set]
 Data source of the list. Default value is FIRST_PARTY. Only whitelisted customers can create third party sourced crm lists. 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. More...
 
bool dataSourceTypeSpecified [get, set]
 
DataUploadResult dataUploadResult [get, set]
 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. More...
 
- Properties inherited from Google.Api.Ads.AdWords.v201809.UserList
long id [get, set]
 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 More...
 
bool idSpecified [get, set]
 
bool isReadOnly [get, set]
 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. More...
 
bool isReadOnlySpecified [get, set]
 
string name [get, set]
 Name of this user list. Depending on its AccessReason, the user list name may not be unique (e.g. if More...
 
string description [get, set]
 Description of this user list. This field can be selected using the value "Description". More...
 
UserListMembershipStatus status [get, set]
 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. This field can be selected using the value "Status".This field can be filtered on. More...
 
bool statusSpecified [get, set]
 
string integrationCode [get, set]
 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. More...
 
AccessReason accessReason [get, set]
 Indicates the reason this account has been granted access to the list. The reason can be Shared, Owned, Licensed or Subscribed. 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. More...
 
bool accessReasonSpecified [get, set]
 
AccountUserListStatus accountUserListStatus [get, set]
 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. This field can be selected using the value "AccountUserListStatus".This field can be filtered on. More...
 
bool accountUserListStatusSpecified [get, set]
 
long membershipLifeSpan [get, set]
 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. More...
 
bool membershipLifeSpanSpecified [get, set]
 
long size [get, set]
 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. More...
 
bool sizeSpecified [get, set]
 
SizeRange sizeRange [get, set]
 Size range in terms of number of users of the UserList. This field can be selected using the value "SizeRange". This field is read only and will be ignored when sent to the API. More...
 
bool sizeRangeSpecified [get, set]
 
long sizeForSearch [get, set]
 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. More...
 
bool sizeForSearchSpecified [get, set]
 
SizeRange sizeRangeForSearch [get, set]
 Size range in terms of number of users of the UserList, for Search ads. This field can be selected using the value "SizeRangeForSearch". This field is read only and will be ignored when sent to the API. More...
 
bool sizeRangeForSearchSpecified [get, set]
 
UserListType listType [get, set]
 Type of this list: remarketing/logical/external remarketing. 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. More...
 
bool listTypeSpecified [get, set]
 
bool isEligibleForSearch [get, set]
 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. More...
 
bool isEligibleForSearchSpecified [get, set]
 
bool isEligibleForDisplay [get, set]
 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. More...
 
bool isEligibleForDisplaySpecified [get, set]
 
UserListClosingReason closingReason [get, set]
 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. This field can be selected using the value "ClosingReason".This field can be filtered on. More...
 
bool closingReasonSpecified [get, set]
 
string UserListType [get, set]
 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. More...
 

Detailed Description

UserList of CRM users provided by the advertiser.

Property Documentation

string Google.Api.Ads.AdWords.v201809.CrmBasedUserList.appId
getset

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".

CrmDataSourceType Google.Api.Ads.AdWords.v201809.CrmBasedUserList.dataSourceType
getset

Data source of the list. Default value is FIRST_PARTY. Only whitelisted customers can create third party sourced crm lists. 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.

bool Google.Api.Ads.AdWords.v201809.CrmBasedUserList.dataSourceTypeSpecified
getset

true, if a value is specified for dataSourceType, false otherwise.

DataUploadResult Google.Api.Ads.AdWords.v201809.CrmBasedUserList.dataUploadResult
getset

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.

CustomerMatchUploadKeyType Google.Api.Ads.AdWords.v201809.CrmBasedUserList.uploadKeyType
getset

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. 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.

bool Google.Api.Ads.AdWords.v201809.CrmBasedUserList.uploadKeyTypeSpecified
getset

true, if a value is specified for uploadKeyType, false otherwise.


The documentation for this class was generated from the following file: