UserList (AdWords AppEngine components 4.21.0 API)

java.lang.Object
- com.google.api.ads.adwords.jaxws.v201809.rm.UserList

Direct Known Subclasses:: BasicUserList, CrmBasedUserList, LogicalUserList, RuleBasedUserList, SimilarUserList

public class UserList
extends Object

Represents a UserList object that is sent over the wire. This is a list of users an account may target.

Java class for UserList complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="UserList">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="id" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="isReadOnly" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="status" type="{https://adwords.google.com/api/adwords/rm/v201809}UserListMembershipStatus" minOccurs="0"/>
         <element name="integrationCode" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="accessReason" type="{https://adwords.google.com/api/adwords/rm/v201809}AccessReason" minOccurs="0"/>
         <element name="accountUserListStatus" type="{https://adwords.google.com/api/adwords/rm/v201809}AccountUserListStatus" minOccurs="0"/>
         <element name="membershipLifeSpan" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="size" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="sizeRange" type="{https://adwords.google.com/api/adwords/rm/v201809}SizeRange" minOccurs="0"/>
         <element name="sizeForSearch" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="sizeRangeForSearch" type="{https://adwords.google.com/api/adwords/rm/v201809}SizeRange" minOccurs="0"/>
         <element name="listType" type="{https://adwords.google.com/api/adwords/rm/v201809}UserListType" minOccurs="0"/>
         <element name="isEligibleForSearch" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="isEligibleForDisplay" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="closingReason" type="{https://adwords.google.com/api/adwords/rm/v201809}UserListClosingReason" minOccurs="0"/>
         <element name="UserList.Type" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected AccessReason`	`accessReason`
`protected AccountUserListStatus`	`accountUserListStatus`
`protected UserListClosingReason`	`closingReason`
`protected String`	`description`
`protected Long`	`id`
`protected String`	`integrationCode`
`protected Boolean`	`isEligibleForDisplay`
`protected Boolean`	`isEligibleForSearch`
`protected Boolean`	`isReadOnly`
`protected UserListType`	`listType`
`protected Long`	`membershipLifeSpan`
`protected String`	`name`
`protected Long`	`size`
`protected Long`	`sizeForSearch`
`protected SizeRange`	`sizeRange`
`protected SizeRange`	`sizeRangeForSearch`
`protected UserListMembershipStatus`	`status`
`protected String`	`userListType`

Constructor Summary

Constructors
Constructor and Description

UserList()

Constructors
Constructor and Description
`UserList()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccessReason`	`getAccessReason()` Gets the value of the accessReason property.
`AccountUserListStatus`	`getAccountUserListStatus()` Gets the value of the accountUserListStatus property.
`UserListClosingReason`	`getClosingReason()` Gets the value of the closingReason property.
`String`	`getDescription()` Gets the value of the description property.
`Long`	`getId()` Gets the value of the id property.
`String`	`getIntegrationCode()` Gets the value of the integrationCode property.
`UserListType`	`getListType()` Gets the value of the listType property.
`Long`	`getMembershipLifeSpan()` Gets the value of the membershipLifeSpan property.
`String`	`getName()` Gets the value of the name property.
`Long`	`getSize()` Gets the value of the size property.
`Long`	`getSizeForSearch()` Gets the value of the sizeForSearch property.
`SizeRange`	`getSizeRange()` Gets the value of the sizeRange property.
`SizeRange`	`getSizeRangeForSearch()` Gets the value of the sizeRangeForSearch property.
`UserListMembershipStatus`	`getStatus()` Gets the value of the status property.
`String`	`getUserListType()` Gets the value of the userListType property.
`Boolean`	`isIsEligibleForDisplay()` Gets the value of the isEligibleForDisplay property.
`Boolean`	`isIsEligibleForSearch()` Gets the value of the isEligibleForSearch property.
`Boolean`	`isIsReadOnly()` Gets the value of the isReadOnly property.
`void`	`setAccessReason(AccessReason value)` Sets the value of the accessReason property.
`void`	`setAccountUserListStatus(AccountUserListStatus value)` Sets the value of the accountUserListStatus property.
`void`	`setClosingReason(UserListClosingReason value)` Sets the value of the closingReason property.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setId(Long value)` Sets the value of the id property.
`void`	`setIntegrationCode(String value)` Sets the value of the integrationCode property.
`void`	`setIsEligibleForDisplay(Boolean value)` Sets the value of the isEligibleForDisplay property.
`void`	`setIsEligibleForSearch(Boolean value)` Sets the value of the isEligibleForSearch property.
`void`	`setIsReadOnly(Boolean value)` Sets the value of the isReadOnly property.
`void`	`setListType(UserListType value)` Sets the value of the listType property.
`void`	`setMembershipLifeSpan(Long value)` Sets the value of the membershipLifeSpan property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setSize(Long value)` Sets the value of the size property.
`void`	`setSizeForSearch(Long value)` Sets the value of the sizeForSearch property.
`void`	`setSizeRange(SizeRange value)` Sets the value of the sizeRange property.
`void`	`setSizeRangeForSearch(SizeRange value)` Sets the value of the sizeRangeForSearch property.
`void`	`setStatus(UserListMembershipStatus value)` Sets the value of the status property.
`void`	`setUserListType(String value)` Sets the value of the userListType property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - id
```
protected Long id
```
  - isReadOnly
```
protected Boolean isReadOnly
```
  - name
```
protected String name
```
  - description
```
protected String description
```
  - status
```
protected UserListMembershipStatus status
```
  - integrationCode
```
protected String integrationCode
```
  - accessReason
```
protected AccessReason accessReason
```
  - accountUserListStatus
```
protected AccountUserListStatus accountUserListStatus
```
  - membershipLifeSpan
```
protected Long membershipLifeSpan
```
  - size
```
protected Long size
```
  - sizeRange
```
protected SizeRange sizeRange
```
  - sizeForSearch
```
protected Long sizeForSearch
```
  - sizeRangeForSearch
```
protected SizeRange sizeRangeForSearch
```
  - listType
```
protected UserListType listType
```
  - isEligibleForSearch
```
protected Boolean isEligibleForSearch
```
  - isEligibleForDisplay
```
protected Boolean isEligibleForDisplay
```
  - closingReason
```
protected UserListClosingReason closingReason
```
  - userListType
```
protected String userListType
```
- Constructor Detail
  - UserList
```
public UserList()
```
- Method Detail
  - getId
```
public Long getId()
```
    Gets the value of the id property.
    
    Returns:
    
    possible object is Long
  - setId
```
public void setId(Long value)
```
    Sets the value of the id property.
    
    Parameters:
    
    value - allowed object is Long
  - isIsReadOnly
```
public Boolean isIsReadOnly()
```
    Gets the value of the isReadOnly property.
    
    Returns:
    
    possible object is Boolean
  - setIsReadOnly
```
public void setIsReadOnly(Boolean value)
```
    Sets the value of the isReadOnly property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Returns:
    
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is String
  - getDescription
```
public String getDescription()
```
    Gets the value of the description property.
    
    Returns:
    
    possible object is String
  - setDescription
```
public void setDescription(String value)
```
    Sets the value of the description property.
    
    Parameters:
    
    value - allowed object is String
  - getStatus
```
public UserListMembershipStatus getStatus()
```
    Gets the value of the status property.
    
    Returns:
    
    possible object is UserListMembershipStatus
  - setStatus
```
public void setStatus(UserListMembershipStatus value)
```
    Sets the value of the status property.
    
    Parameters:
    
    value - allowed object is UserListMembershipStatus
  - getIntegrationCode
```
public String getIntegrationCode()
```
    Gets the value of the integrationCode property.
    
    Returns:
    
    possible object is String
  - setIntegrationCode
```
public void setIntegrationCode(String value)
```
    Sets the value of the integrationCode property.
    
    Parameters:
    
    value - allowed object is String
  - getAccessReason
```
public AccessReason getAccessReason()
```
    Gets the value of the accessReason property.
    
    Returns:
    
    possible object is AccessReason
  - setAccessReason
```
public void setAccessReason(AccessReason value)
```
    Sets the value of the accessReason property.
    
    Parameters:
    
    value - allowed object is AccessReason
  - getAccountUserListStatus
```
public AccountUserListStatus getAccountUserListStatus()
```
    Gets the value of the accountUserListStatus property.
    
    Returns:
    
    possible object is AccountUserListStatus
  - setAccountUserListStatus
```
public void setAccountUserListStatus(AccountUserListStatus value)
```
    Sets the value of the accountUserListStatus property.
    
    Parameters:
    
    value - allowed object is AccountUserListStatus
  - getMembershipLifeSpan
```
public Long getMembershipLifeSpan()
```
    Gets the value of the membershipLifeSpan property.
    
    Returns:
    
    possible object is Long
  - setMembershipLifeSpan
```
public void setMembershipLifeSpan(Long value)
```
    Sets the value of the membershipLifeSpan property.
    
    Parameters:
    
    value - allowed object is Long
  - getSize
```
public Long getSize()
```
    Gets the value of the size property.
    
    Returns:
    
    possible object is Long
  - setSize
```
public void setSize(Long value)
```
    Sets the value of the size property.
    
    Parameters:
    
    value - allowed object is Long
  - getSizeRange
```
public SizeRange getSizeRange()
```
    Gets the value of the sizeRange property.
    
    Returns:
    
    possible object is SizeRange
  - setSizeRange
```
public void setSizeRange(SizeRange value)
```
    Sets the value of the sizeRange property.
    
    Parameters:
    
    value - allowed object is SizeRange
  - getSizeForSearch
```
public Long getSizeForSearch()
```
    Gets the value of the sizeForSearch property.
    
    Returns:
    
    possible object is Long
  - setSizeForSearch
```
public void setSizeForSearch(Long value)
```
    Sets the value of the sizeForSearch property.
    
    Parameters:
    
    value - allowed object is Long
  - getSizeRangeForSearch
```
public SizeRange getSizeRangeForSearch()
```
    Gets the value of the sizeRangeForSearch property.
    
    Returns:
    
    possible object is SizeRange
  - setSizeRangeForSearch
```
public void setSizeRangeForSearch(SizeRange value)
```
    Sets the value of the sizeRangeForSearch property.
    
    Parameters:
    
    value - allowed object is SizeRange
  - getListType
```
public UserListType getListType()
```
    Gets the value of the listType property.
    
    Returns:
    
    possible object is UserListType
  - setListType
```
public void setListType(UserListType value)
```
    Sets the value of the listType property.
    
    Parameters:
    
    value - allowed object is UserListType
  - isIsEligibleForSearch
```
public Boolean isIsEligibleForSearch()
```
    Gets the value of the isEligibleForSearch property.
    
    Returns:
    
    possible object is Boolean
  - setIsEligibleForSearch
```
public void setIsEligibleForSearch(Boolean value)
```
    Sets the value of the isEligibleForSearch property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isIsEligibleForDisplay
```
public Boolean isIsEligibleForDisplay()
```
    Gets the value of the isEligibleForDisplay property.
    
    Returns:
    
    possible object is Boolean
  - setIsEligibleForDisplay
```
public void setIsEligibleForDisplay(Boolean value)
```
    Sets the value of the isEligibleForDisplay property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getClosingReason
```
public UserListClosingReason getClosingReason()
```
    Gets the value of the closingReason property.
    
    Returns:
    
    possible object is UserListClosingReason
  - setClosingReason
```
public void setClosingReason(UserListClosingReason value)
```
    Sets the value of the closingReason property.
    
    Parameters:
    
    value - allowed object is UserListClosingReason
  - getUserListType
```
public String getUserListType()
```
    Gets the value of the userListType property.
    
    Returns:
    
    possible object is String
  - setUserListType
```
public void setUserListType(String value)
```
    Sets the value of the userListType property.
    
    Parameters:
    
    value - allowed object is String

Class UserList

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

isReadOnly

name

description

status

integrationCode

accessReason

accountUserListStatus

membershipLifeSpan

size

sizeRange

sizeForSearch

sizeRangeForSearch

listType

isEligibleForSearch

isEligibleForDisplay

closingReason

userListType

Constructor Detail

UserList

Method Detail

getId

setId

isIsReadOnly

setIsReadOnly

getName

setName

getDescription

setDescription

getStatus

setStatus

getIntegrationCode

setIntegrationCode

getAccessReason

setAccessReason

getAccountUserListStatus

setAccountUserListStatus

getMembershipLifeSpan

setMembershipLifeSpan

getSize

setSize

getSizeRange

setSizeRange

getSizeForSearch

setSizeForSearch

getSizeRangeForSearch

setSizeRangeForSearch

getListType

setListType

isIsEligibleForSearch

setIsEligibleForSearch

isIsEligibleForDisplay

setIsEligibleForDisplay

getClosingReason

setClosingReason

getUserListType

setUserListType