Service
UserListService
Dependencies
Inheritance
Represents a UserList object that is sent over the wire. This is a list of users an account may target.
- Namespace
-
https://adwords.google.com/api/adwords/cm/v201302 - Fields
| Field | Type | Description |
|---|---|---|
| id Filterable
Required
Selectable
|
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 ReadOnly
Selectable
|
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 should not be set. If this field is sent to the API, it will be ignored. |
| name Filterable
Selectable
|
xsd:string
|
Name of this user list. This field can be selected using the value "Name". This field can be filtered on. |
| description Selectable
|
xsd:string
|
Description of this user list. This field can be selected using the value "Description". |
| status Filterable
Selectable
|
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.
This field can be selected using the value "Status".
This field can be filtered on.
Enumerations
|
| accessReason Filterable
Selectable
|
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.
Enumerations
|
| accountUserListStatus Filterable
Selectable
|
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.
Enumerations
|
| membershipLifeSpan Filterable
Selectable
|
xsd:long
|
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. |
| size Filterable
ReadOnly
Selectable
|
xsd:long
|
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. |
| sizeRange ReadOnly
Selectable
|
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.
Enumerations
|
| type Filterable
ReadOnly
Selectable
|
UserList.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.
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.
Enumerations
|
| 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. |