AdwordsUserListField (Google Ads APIs Client Library for Java parent 4.17.0 API)

java.lang.Object
- java.lang.Enum<AdwordsUserListField>
- - com.google.api.ads.adwords.lib.selectorfields.v201809.cm.AdwordsUserListField

All Implemented Interfaces:

EntityField, Serializable, Comparable<AdwordsUserListField>
```
public enum AdwordsUserListField
extends Enum<AdwordsUserListField>
implements EntityField
```
A Enum to facilitate the selection of fields for AdwordsUserList.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AccessReason` Indicates the reason this account has been granted access to the list.
`AccountUserListStatus` Indicates if this share is still active.
`AppId` A string that uniquely identifies a mobile application from which the data was collected to AdWords API.
`ClosingReason` Indicating the reason why this user list membership status is closed.
`ConversionTypes` Conversion types associated with this user list.
`DataSourceType` Data source of the list.
`DataUploadResult`
`DateSpecificListEndDate` End date of users visit.
`DateSpecificListRule` Boolean rule that defines visitor of a page.
`DateSpecificListStartDate` Start date of users visit.
`Description` Description of this user list.
`ExpressionListRule` Boolean rule that defines this user list.
`Id` Id of this user list.
`IntegrationCode` An Id from external system.
`IsEligibleForDisplay` A flag that indicates this user list is eligible for Display Network.
`IsEligibleForSearch` A flag that indicates this user list is eligible for Google Search Network.
`IsReadOnly` A flag that indicates if a user may edit a list.
`ListType` Type of this list: remarketing/logical/external remarketing.
`MembershipLifeSpan` Number of days a user's cookie stays on your list since its most recent addition to the list.
`Name` Name of this user list.
`PrepopulationStatus` Status of pre-population.
`Rules` Logical list rules that define this user list.
`SeedListSize` Estimated number of users in this seed user list.
`SeedUserListDescription` Description of this seed user list.
`SeedUserListId` Seed UserListId from which this list is derived.
`SeedUserListName` Name of the seed user list.
`SeedUserListStatus` Membership status of this seed user list.
`Size` Estimated number of users in this user list, on the Google Display Network.
`SizeForSearch` Estimated number of users in this user list in the google.com domain.
`SizeRange` Size range in terms of number of users of the UserList.
`SizeRangeForSearch` Size range in terms of number of users of the UserList, for Search ads.
`Status` Membership status of this user list.
`UploadKeyType` Matching key type of the list.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`isFilterable()` If the field is filterable.
`static AdwordsUserListField`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static AdwordsUserListField[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.api.ads.adwords.lib.selectorfields.EntityField
name

- Enum Constant Detail
  - AccessReason
```
public static final AdwordsUserListField AccessReason
```
    Indicates the reason this account has been granted access to the list. The reason can be Shared, Owned, Licensed or Subscribed.
  - AccountUserListStatus
```
public static final AdwordsUserListField 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.
  - AppId
```
public static final AdwordsUserListField AppId
```
    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.
  - ClosingReason
```
public static final AdwordsUserListField ClosingReason
```
    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.
  - ConversionTypes
```
public static final AdwordsUserListField ConversionTypes
```
    Conversion types associated with this user list.
  - DataSourceType
```
public static final AdwordsUserListField DataSourceType
```
    Data source of the list. Default value is FIRST_PARTY. Only whitelisted customers can create third party sourced crm lists.
  - DataUploadResult
```
public static final AdwordsUserListField DataUploadResult
```
  - DateSpecificListEndDate
```
public static final AdwordsUserListField DateSpecificListEndDate
```
    End date of users visit. If set to 20371230, then includes all users after startDate. The date's format should be YYYYMMDD. This field is selected by default.
  - DateSpecificListRule
```
public static final AdwordsUserListField DateSpecificListRule
```
    Boolean rule that defines visitor of a page. This field is selected by default.
  - DateSpecificListStartDate
```
public static final AdwordsUserListField DateSpecificListStartDate
```
    Start date of users visit. If set to 20000101, then includes all users before endDate. The date's format should be YYYYMMDD. This field is selected by default.
  - Description
```
public static final AdwordsUserListField Description
```
    Description of this user list.
  - ExpressionListRule
```
public static final AdwordsUserListField ExpressionListRule
```
    Boolean rule that defines this user list. The rule consists of a list of rule item groups and each rule item group consists of a list of rule items. All the rule item groups are ORed together for evaluation before version V201705. Starting from version V201705, the group operator is based on Rule#getRuleType(). This field is selected by default.
  - Id
```
public static final AdwordsUserListField Id
```
    Id of this user list.
  - IntegrationCode
```
public static final AdwordsUserListField IntegrationCode
```
    An Id from external system. It is used by user list sellers to correlate ids on their systems.
  - IsEligibleForDisplay
```
public static final AdwordsUserListField IsEligibleForDisplay
```
    A flag that indicates this user list is eligible for Display Network.
  - IsEligibleForSearch
```
public static final AdwordsUserListField IsEligibleForSearch
```
    A flag that indicates this user list is eligible for Google Search Network.
  - IsReadOnly
```
public static final AdwordsUserListField IsReadOnly
```
    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.
  - ListType
```
public static final AdwordsUserListField ListType
```
    Type of this list: remarketing/logical/external remarketing.
  - MembershipLifeSpan
```
public static final AdwordsUserListField MembershipLifeSpan
```
    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.
  - Name
```
public static final AdwordsUserListField Name
```
    Name of this user list. Depending on its AccessReason, the user list name may not be unique (e.g. if AccessReason=SHARED).
  - PrepopulationStatus
```
public static final AdwordsUserListField PrepopulationStatus
```
    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 pre-populate past users within up to 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.
  - Rules
```
public static final AdwordsUserListField Rules
```
    Logical list rules that define this user list. The rules are defined as logical operator (ALL/ANY/NONE) and a list of user lists. All the rules are anded for the evaluation. Required for ADD operation.
  - SeedListSize
```
public static final AdwordsUserListField SeedListSize
```
    Estimated number of users in this seed user list. This value is null if the number of users has not yet been determined.
  - SeedUserListDescription
```
public static final AdwordsUserListField SeedUserListDescription
```
    Description of this seed user list.
  - SeedUserListId
```
public static final AdwordsUserListField SeedUserListId
```
    Seed UserListId from which this list is derived.
  - SeedUserListName
```
public static final AdwordsUserListField SeedUserListName
```
    Name of the seed user list.
  - SeedUserListStatus
```
public static final AdwordsUserListField SeedUserListStatus
```
    Membership status of this seed user list.
  - Size
```
public static final AdwordsUserListField Size
```
    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.
  - SizeForSearch
```
public static final AdwordsUserListField SizeForSearch
```
    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.
  - SizeRange
```
public static final AdwordsUserListField SizeRange
```
    Size range in terms of number of users of the UserList.
  - SizeRangeForSearch
```
public static final AdwordsUserListField SizeRangeForSearch
```
    Size range in terms of number of users of the UserList, for Search ads.
  - Status
```
public static final AdwordsUserListField Status
```
    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.
  - UploadKeyType
```
public static final AdwordsUserListField UploadKeyType
```
    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.
- Method Detail
  - values
```
public static AdwordsUserListField[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (AdwordsUserListField c : AdwordsUserListField.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AdwordsUserListField valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - isFilterable
```
public boolean isFilterable()
```
    Description copied from interface: EntityField
    
    If the field is filterable.
    
    Specified by:
    
    isFilterable in interface EntityField
    
    Returns:
    
    true for a filterable field, false otherwise.

Enum AdwordsUserListField

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.api.ads.adwords.lib.selectorfields.EntityField

Enum Constant Detail

AccessReason

AccountUserListStatus

AppId

ClosingReason

ConversionTypes

DataSourceType

DataUploadResult

DateSpecificListEndDate

DateSpecificListRule

DateSpecificListStartDate

Description

ExpressionListRule

Id

IntegrationCode

IsEligibleForDisplay

IsEligibleForSearch

IsReadOnly

ListType

MembershipLifeSpan

Name

PrepopulationStatus

Rules

SeedListSize

SeedUserListDescription

SeedUserListId

SeedUserListName

SeedUserListStatus

Size

SizeForSearch

SizeRange

SizeRangeForSearch

Status

UploadKeyType

Method Detail

values

valueOf

isFilterable