Service which is used to manage user lists.
- Production WSDL
-
https://adwords.google.com/api/adwords/rm/v201809/AdwordsUserListService?wsdl
- Namespace
-
https://adwords.google.com/api/adwords/rm/v201809
- Operations
- Errors
-
- AuthenticationError
- AuthorizationError
- CollectionSizeError
- DatabaseError
- DateError
- DistinctError
- EntityNotFound
- InternalApiError
- MutateMembersError
- NotEmptyError
- NotWhitelistedError
- NullError
- OperationAccessDenied
- OperatorError
- QueryError
- QuotaCheckError
- RangeError
- RateExceededError
- ReadOnlyError
- RejectedError
- RequestError
- RequiredError
- SelectorError
- SizeLimitError
- StringFormatError
- StringLengthError
- UserListError
get
Returns the list of user lists that meet the selector criteria.
Parameters
Field | Type | Description |
---|---|---|
serviceSelector
|
|
the selector specifying the UserLists to return. |
Response
Field | Type | Description |
---|---|---|
rval
|
|
a list of UserList entities which meet the selector criteria. |
mutate
Applies a list of mutate operations (i.e. add, set): Add - creates a set of user lists Set - updates a set of user lists Remove - not supported
Parameters
Field | Type | Description |
---|---|---|
operations
|
|
the operations to apply |
Response
Field | Type | Description |
---|---|---|
rval
|
|
a list of UserList objects |
mutateMembers
Mutate members of user lists by either adding or removing their lists of members. The following Operators are supported: ADD and REMOVE. The SET operator is not supported.
Note that operations cannot have same user list id but different operators.
Parameters
Field | Type | Description |
---|---|---|
operations
|
|
the mutate members operations to apply |
Response
Field | Type | Description |
---|---|---|
rval
|
|
a list of UserList objects |
query
Returns the list of user lists that match the query.
Parameters
Field | Type | Description |
---|---|---|
query
|
|
The SQL-like AWQL query string |
Response
Field | Type | Description |
---|---|---|
rval
|
|
A list of UserList |
Errors
Error | Reasons |
---|---|
AuthenticationError
|
Errors returned when Authentication failed.
Enumerations
|
AuthorizationError
|
Errors encountered when trying to authorize a user.
Enumerations
|
CollectionSizeError
|
Errors associated with the size of the given collection being
out of bounds.
Enumerations
|
DatabaseError
|
Errors that are thrown due to a database access problem.
Enumerations
|
DateError
|
Errors associated with invalid dates and date ranges.
Enumerations
|
DistinctError
|
Errors related to distinct ids or content.
Enumerations
|
EntityNotFound
|
An id did not correspond to an entity, or it referred to an entity which does not belong to the
customer.
Enumerations
|
InternalApiError
|
Indicates that a server-side error has occured. InternalApiError s
are generally not the result of an invalid request or message sent by the
client.
Enumerations
|
MutateMembersError
|
Represents possible error codes from UserListService#mutateMembers .
Enumerations
|
NotEmptyError
|
Errors corresponding with violation of a NOT EMPTY check.
Enumerations
|
NotWhitelistedError
|
Indicates that the customer is not whitelisted for accessing the API.
Enumerations
|
NullError
|
Errors associated with violation of a NOT NULL check.
Enumerations
|
OperationAccessDenied
|
Operation not permitted due to the invoked service's access policy.
Enumerations
|
OperatorError
|
Errors due to the use of unsupported operations.
Enumerations
|
QueryError
|
A QueryError represents possible errors for query parsing and execution.
Enumerations
|
QuotaCheckError
|
Encapsulates the errors thrown during developer quota checks.
Enumerations
|
RangeError
|
A list of all errors associated with the Range constraint.
Enumerations
|
RateExceededError
|
Signals that a call failed because a measured rate exceeded.
Enumerations
|
ReadOnlyError
|
Errors from attempting to write to read-only fields.
Enumerations
|
RejectedError
|
Indicates that a field was rejected due to compatibility issues.
Enumerations
|
RequestError
|
Encapsulates the generic errors thrown when there's an error with user
request.
Enumerations
|
RequiredError
|
Errors due to missing required field.
Enumerations
|
SelectorError
|
Represents possible error codes for Selector.
Enumerations
|
SizeLimitError
|
Indicates that the number of entries in the request or response exceeds the system limit.
Enumerations
|
StringFormatError
|
A list of error code for reporting invalid content of input strings.
Enumerations
|
StringLengthError
|
Errors associated with the length of the given string being
out of bounds.
Enumerations
|
UserListError
|
Represents possible error codes in UserListService.
Enumerations
|