com.google.api.ads.adwords.v201109.cm
Class UserList

java.lang.Object
  com.google.api.ads.adwords.v201109.cm.UserList

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ExternalRemarketingUserList, LogicalUserList, RemarketingUserList

public class UserList
extends Object
implements Serializable

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

See Also:

Serialized Form

Constructor Summary

UserList()

UserList(Long id, Boolean isReadOnly, String name, String description, UserListMembershipStatus status, AccessReason accessReason, AccountUserListStatus accountUserListStatus, Long membershipLifeSpan, Long size, SizeRange sizeRange, UserListType type, String userListType)

Method Summary

boolean	equals(Object obj)
AccessReason	getAccessReason() Gets the accessReason value for this UserList.
AccountUserListStatus	getAccountUserListStatus() Gets the accountUserListStatus value for this UserList.
String	getDescription() Gets the description value for this UserList.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
Long	getId() Gets the id value for this UserList.
Boolean	getIsReadOnly() Gets the isReadOnly value for this UserList.
Long	getMembershipLifeSpan() Gets the membershipLifeSpan value for this UserList.
String	getName() Gets the name value for this UserList.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
Long	getSize() Gets the size value for this UserList.
SizeRange	getSizeRange() Gets the sizeRange value for this UserList.
UserListMembershipStatus	getStatus() Gets the status value for this UserList.
UserListType	getType() Gets the type value for this UserList.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
String	getUserListType() Gets the userListType value for this UserList.
int	hashCode()
void	setAccessReason(AccessReason accessReason) Sets the accessReason value for this UserList.
void	setAccountUserListStatus(AccountUserListStatus accountUserListStatus) Sets the accountUserListStatus value for this UserList.
void	setDescription(String description) Sets the description value for this UserList.
void	setId(Long id) Sets the id value for this UserList.
void	setIsReadOnly(Boolean isReadOnly) Sets the isReadOnly value for this UserList.
void	setMembershipLifeSpan(Long membershipLifeSpan) Sets the membershipLifeSpan value for this UserList.
void	setName(String name) Sets the name value for this UserList.
void	setSize(Long size) Sets the size value for this UserList.
void	setSizeRange(SizeRange sizeRange) Sets the sizeRange value for this UserList.
void	setStatus(UserListMembershipStatus status) Sets the status value for this UserList.
void	setType(UserListType type) Sets the type value for this UserList.
void	setUserListType(String userListType) Sets the userListType value for this UserList.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserList

public UserList()

UserList

public UserList(Long id,
                Boolean isReadOnly,
                String name,
                String description,
                UserListMembershipStatus status,
                AccessReason accessReason,
                AccountUserListStatus accountUserListStatus,
                Long membershipLifeSpan,
                Long size,
                SizeRange sizeRange,
                UserListType type,
                String userListType)

Method Detail

getId

public Long getId()

Gets the id value for this UserList.

Returns:

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

setId

public void setId(Long id)

Sets the id value for this UserList.

Parameters:

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

getIsReadOnly

public Boolean getIsReadOnly()

Gets the isReadOnly value for this UserList.

Returns:

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. This field can be selected using the value "IsReadOnly". This field is read only and should not be set. If this field is sent to the API, it will be ignored.

setIsReadOnly

public void setIsReadOnly(Boolean isReadOnly)

Sets the isReadOnly value for this UserList.

Parameters:

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. This field can be selected using the value "IsReadOnly". This field is read only and should not be set. If this field is sent to the API, it will be ignored.

getName

public String getName()

Gets the name value for this UserList.

Returns:

name * Name of this user list. This field can be selected using the value "Name".This field can be filtered on.

setName

public void setName(String name)

Sets the name value for this UserList.

Parameters:

name - * Name of this user list. This field can be selected using the value "Name".This field can be filtered on.

getDescription

public String getDescription()

Gets the description value for this UserList.

Returns:

description * Description of this user list. This field can be selected using the value "Description".

setDescription

public void setDescription(String description)

Sets the description value for this UserList.

Parameters:

description - * Description of this user list. This field can be selected using the value "Description".

getStatus

public UserListMembershipStatus getStatus()

Gets the status value for this UserList.

Returns:

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. This field can be selected using the value "Status".This field can be filtered on.

setStatus

public void setStatus(UserListMembershipStatus status)

Sets the status value for this UserList.

Parameters:

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. This field can be selected using the value "Status".This field can be filtered on.

getAccessReason

public AccessReason getAccessReason()

Gets the accessReason value for this UserList.

Returns:

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

setAccessReason

public void setAccessReason(AccessReason accessReason)

Sets the accessReason value for this UserList.

Parameters:

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

getAccountUserListStatus

public AccountUserListStatus getAccountUserListStatus()

Gets the accountUserListStatus value for this UserList.

Returns:

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. This field can be selected using the value "AccountUserListStatus".This field can be filtered on.

setAccountUserListStatus

public void setAccountUserListStatus(AccountUserListStatus accountUserListStatus)

Sets the accountUserListStatus value for this UserList.

Parameters:

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. This field can be selected using the value "AccountUserListStatus".This field can be filtered on.

getMembershipLifeSpan

public Long getMembershipLifeSpan()

Gets the membershipLifeSpan value for this UserList.

Returns:

membershipLifeSpan * Number of inactive days after which a user should be removed from the list. This field can be selected using the value "MembershipLifeSpan".This field can be filtered on.

setMembershipLifeSpan

public void setMembershipLifeSpan(Long membershipLifeSpan)

Sets the membershipLifeSpan value for this UserList.

Parameters:

membershipLifeSpan - * Number of inactive days after which a user should be removed from the list. This field can be selected using the value "MembershipLifeSpan".This field can be filtered on.

getSize

public Long getSize()

Gets the size value for this UserList.

Returns:

size * Estimated number of users in this user list. 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 should not be set. If this field is sent to the API, it will be ignored.

setSize

public void setSize(Long size)

Sets the size value for this UserList.

Parameters:

size - * Estimated number of users in this user list. 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 should not be set. If this field is sent to the API, it will be ignored.

getSizeRange

public SizeRange getSizeRange()

Gets the sizeRange value for this UserList.

Returns:

sizeRange * 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 should not be set. If this field is sent to the API, it will be ignored.

setSizeRange

public void setSizeRange(SizeRange sizeRange)

Sets the sizeRange value for this UserList.

Parameters:

sizeRange - * 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 should not be set. If this field is sent to the API, it will be ignored.

getType

public UserListType getType()

Gets the type value for this UserList.

Returns:

type * Type of this list: remarketing/logical/external remarketing. This field can be selected using the value "Type".This field can be filtered on. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

setType

public void setType(UserListType type)

Sets the type value for this UserList.

Parameters:

type - * Type of this list: remarketing/logical/external remarketing. This field can be selected using the value "Type".This field can be filtered on. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

getUserListType

public String getUserListType()

Gets the userListType value for this UserList.

Returns:

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

setUserListType

public void setUserListType(String userListType)

Sets the userListType value for this UserList.

Parameters:

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(String mechType,
                                                                Class _javaType,
                                                                QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(String mechType,
                                                                    Class _javaType,
                                                                    QName _xmlType)

Get Custom Deserializer