The AdWords API is no longer supported. Use the Google Ads API instead.

AdwordsUserListService (v201809)

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

get

Returns the list of user lists that meet the selector criteria.

Parameters

Field Type Description
serviceSelector cm:Selector the selector specifying the UserLists to return.

Response

Field Type Description
rval UserListPage 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 UserListOperation[] the operations to apply

Response

Field Type Description
rval UserListReturnValue 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 MutateMembersOperation[] the mutate members operations to apply

Response

Field Type Description
rval MutateMembersReturnValue a list of UserList objects

query

Returns the list of user lists that match the query.

Parameters

Field Type Description
query xsd:string The SQL-like AWQL query string

Response

Field Type Description
rval UserListPage A list of UserList

Errors

Error Reasons
AuthenticationError Errors returned when Authentication failed.
Enumerations
AUTHENTICATION_FAILED
Authentication of the request failed.
CLIENT_CUSTOMER_ID_IS_REQUIRED
Client Customer Id is required if CustomerIdMode is set to CLIENT_EXTERNAL_CUSTOMER_ID. Starting version V201409 ClientCustomerId will be required for all requests except for CustomerService.get
CLIENT_EMAIL_REQUIRED
Client Email is required if CustomerIdMode is set to CLIENT_EXTERNAL_EMAIL_FIELD.
CLIENT_CUSTOMER_ID_INVALID
Client customer Id is not a number.
CLIENT_EMAIL_INVALID
Client customer Id is not a number.
CLIENT_EMAIL_FAILED_TO_AUTHENTICATE
Client email is not a valid customer email.
CUSTOMER_NOT_FOUND
No customer found for the customer id provided in the header.
GOOGLE_ACCOUNT_DELETED
Client's Google Account is deleted.
GOOGLE_ACCOUNT_COOKIE_INVALID
Google account login token in the cookie is invalid.
FAILED_TO_AUTHENTICATE_GOOGLE_ACCOUNT
problem occurred during Google account authentication.
GOOGLE_ACCOUNT_USER_AND_ADS_USER_MISMATCH
The user in the google account login token does not match the UserId in the cookie.
LOGIN_COOKIE_REQUIRED
Login cookie is required for authentication.
NOT_ADS_USER
User in the cookie is not a valid Ads user.
OAUTH_TOKEN_INVALID
Oauth token in the header is not valid.
OAUTH_TOKEN_EXPIRED
Oauth token in the header has expired.
OAUTH_TOKEN_DISABLED
Oauth token in the header has been disabled.
OAUTH_TOKEN_REVOKED
Oauth token in the header has been revoked.
OAUTH_TOKEN_HEADER_INVALID
Oauth token HTTP header is malformed.
LOGIN_COOKIE_INVALID
Login cookie is not valid.
FAILED_TO_RETRIEVE_LOGIN_COOKIE
Failed to decrypt the login cookie.
USER_ID_INVALID
User Id in the header is not a valid id.
AuthorizationError Errors encountered when trying to authorize a user.
Enumerations
UNABLE_TO_AUTHORIZE
Could not complete authorization due to an internal problem.
NO_ADWORDS_ACCOUNT_FOR_CUSTOMER
Customer has no AdWords account.
USER_PERMISSION_DENIED
User doesn't have permission to access customer.
EFFECTIVE_USER_PERMISSION_DENIED
Effective user doesn't have permission to access this customer.
CUSTOMER_NOT_ACTIVE
Access denied since the customer is not active.
USER_HAS_READONLY_PERMISSION
User has read-only permission cannot mutate.
NO_CUSTOMER_FOUND
No customer found.
SERVICE_ACCESS_DENIED
Developer doesn't have permission to access service.
TWO_STEP_VERIFICATION_NOT_ENROLLED
The customer has a policy to enforce 2-Step Verification, but the user is not enrolled.
ADVANCED_PROTECTION_NOT_ENROLLED
The customer has a policy to enforce enrollment in the Advanced Protection Program, but the user is not enrolled.
CollectionSizeError Errors associated with the size of the given collection being out of bounds.
Enumerations
TOO_FEW
TOO_MANY
DatabaseError Errors that are thrown due to a database access problem.
Enumerations
CONCURRENT_MODIFICATION
A concurrency problem occurred as two threads were attempting to modify same object.
PERMISSION_DENIED
The permission was denied to access an object.
ACCESS_PROHIBITED
The user's access to an object has been prohibited.
CAMPAIGN_PRODUCT_NOT_SUPPORTED
Requested campaign belongs to a product that is not supported by the api.
DUPLICATE_KEY
a duplicate key was detected upon insertion
DATABASE_ERROR
a database error has occurred
UNKNOWN
an unknown error has occurred
DateError Errors associated with invalid dates and date ranges.
Enumerations
INVALID_FIELD_VALUES_IN_DATE
Given field values do not correspond to a valid date.
INVALID_FIELD_VALUES_IN_DATE_TIME
Given field values do not correspond to a valid date time.
INVALID_STRING_DATE
The string date's format should be yyyymmdd.
INVALID_STRING_DATE_RANGE
The string date range's format should be yyyymmdd yyyymmdd.
INVALID_STRING_DATE_TIME
The string date time's format should be yyyymmdd hhmmss [tz].
EARLIER_THAN_MINIMUM_DATE
Date is before allowed minimum.
LATER_THAN_MAXIMUM_DATE
Date is after allowed maximum.
DATE_RANGE_MINIMUM_DATE_LATER_THAN_MAXIMUM_DATE
Date range bounds are not in order.
DATE_RANGE_MINIMUM_AND_MAXIMUM_DATES_BOTH_NULL
Both dates in range are null.
DistinctError Errors related to distinct ids or content.
Enumerations
DUPLICATE_ELEMENT
DUPLICATE_TYPE
EntityNotFound An id did not correspond to an entity, or it referred to an entity which does not belong to the customer.
Enumerations
INVALID_ID
The specified id refered to an entity which either doesn't exist or is not accessible to the customer. e.g. campaign belongs to another customer.
InternalApiError Indicates that a server-side error has occured. InternalApiErrors are generally not the result of an invalid request or message sent by the client.
Enumerations
UNEXPECTED_INTERNAL_API_ERROR
API encountered an unexpected internal error.
TRANSIENT_ERROR
A temporary error occurred during the request. Please retry.
UNKNOWN
The cause of the error is not known or only defined in newer versions.
DOWNTIME
The API is currently unavailable for a planned downtime.
ERROR_GENERATING_RESPONSE
Mutate succeeded but server was unable to build response. Client should not retry mutate.
MutateMembersError Represents possible error codes from UserListService#mutateMembers.
Enumerations
UNKNOWN
UNSUPPORTED_METHOD
INVALID_USER_LIST_ID
INVALID_USER_LIST_TYPE
INVALID_DATA_TYPE
INVALID_SHA256_FORMAT
OPERATOR_CONFLICT_FOR_SAME_USER_LIST_ID
INVALID_REMOVEALL_OPERATION
INVALID_OPERATION_ORDER
MISSING_MEMBER_IDENTIFIER
INCOMPATIBLE_UPLOAD_KEY_TYPE
NotEmptyError Errors corresponding with violation of a NOT EMPTY check.
Enumerations
EMPTY_LIST
NotWhitelistedError Indicates that the customer is not whitelisted for accessing the API.
Enumerations
CUSTOMER_NOT_WHITELISTED_FOR_API
Customer is not whitelisted for accessing the API.
NullError Errors associated with violation of a NOT NULL check.
Enumerations
NULL_CONTENT
Specified list/container must not contain any null elements
OperationAccessDenied Operation not permitted due to the invoked service's access policy.
Enumerations
ACTION_NOT_PERMITTED
Unauthorized invocation of a service's method (get, mutate, etc.)
ADD_OPERATION_NOT_PERMITTED
Unauthorized ADD operation in invoking a service's mutate method.
REMOVE_OPERATION_NOT_PERMITTED
Unauthorized REMOVE operation in invoking a service's mutate method.
SET_OPERATION_NOT_PERMITTED
Unauthorized SET operation in invoking a service's mutate method.
MUTATE_ACTION_NOT_PERMITTED_FOR_CLIENT
A mutate action is not allowed on this campaign, from this client.
OPERATION_NOT_PERMITTED_FOR_CAMPAIGN_TYPE
This operation is not permitted on this campaign type
ADD_AS_REMOVED_NOT_PERMITTED
An ADD operation may not set status to REMOVED.
OPERATION_NOT_PERMITTED_FOR_REMOVED_ENTITY
This operation is not allowed because the campaign or adgroup is removed.
OPERATION_NOT_PERMITTED_FOR_AD_GROUP_TYPE
This operation is not permitted on this ad group type.
UNKNOWN
The reason the invoked method or operation is prohibited is not known (the client may be of an older version than the server).
OperatorError Errors due to the use of unsupported operations.
Enumerations
OPERATOR_NOT_SUPPORTED
QueryError A QueryError represents possible errors for query parsing and execution.
Enumerations
PARSING_FAILED
Exception that happens when trying to parse a query that doesn't match the AWQL grammar.
MISSING_QUERY
The provided query is an empty string.
MISSING_SELECT_CLAUSE
The query does not contain the required SELECT clause or it is not in the correct location.
MISSING_FROM_CLAUSE
The query does not contain the required FROM clause or it is not in the correct location.
INVALID_SELECT_CLAUSE
The SELECT clause could not be parsed.
INVALID_FROM_CLAUSE
The FROM clause could not be parsed.
INVALID_WHERE_CLAUSE
The WHERE clause could not be parsed.
INVALID_ORDER_BY_CLAUSE
The ORDER BY clause could not be parsed.
INVALID_LIMIT_CLAUSE
The LIMIT clause could not be parsed.
INVALID_START_INDEX_IN_LIMIT_CLAUSE
The startIndex in the LIMIT clause does not contain a valid integer.
INVALID_PAGE_SIZE_IN_LIMIT_CLAUSE
The pageSize in the LIMIT clause does not contain a valid integer.
INVALID_DURING_CLAUSE
The DURING clause could not be parsed.
INVALID_MIN_DATE_IN_DURING_CLAUSE
The minimum date in the DURING clause is not a valid date in YYYYMMDD format.
INVALID_MAX_DATE_IN_DURING_CLAUSE
The maximum date in the DURING clause is not a valid date in YYYYMMDD format.
MAX_LESS_THAN_MIN_IN_DURING_CLAUSE
The minimum date in the DURING is after the maximum date.
VALIDATION_FAILED
The query matched the grammar, but is invalid in some way such as using a service that isn't supported.
QuotaCheckError Encapsulates the errors thrown during developer quota checks.
Enumerations
INVALID_TOKEN_HEADER
Customer passed in an invalid token in the header.
ACCOUNT_DELINQUENT
Customer is marked delinquent.
ACCOUNT_INACCESSIBLE
Customer is a fraudulent.
ACCOUNT_INACTIVE
Inactive Account.
INCOMPLETE_SIGNUP
Signup not complete
DEVELOPER_TOKEN_NOT_APPROVED
Developer token is not approved for production access, and the customer is attempting to access a production account.
TERMS_AND_CONDITIONS_NOT_SIGNED
Terms and conditions are not signed.
MONTHLY_BUDGET_REACHED
Monthly budget quota reached.
QUOTA_EXCEEDED
Monthly budget quota exceeded.
RangeError A list of all errors associated with the Range constraint.
Enumerations
TOO_LOW
TOO_HIGH
RateExceededError Signals that a call failed because a measured rate exceeded.
Enumerations
RATE_EXCEEDED
Rate exceeded.
ReadOnlyError Errors from attempting to write to read-only fields.
Enumerations
READ_ONLY
RejectedError Indicates that a field was rejected due to compatibility issues.
Enumerations
UNKNOWN_VALUE
Unknown value encountered
RequestError Encapsulates the generic errors thrown when there's an error with user request.
Enumerations
UNKNOWN
Error reason is unknown.
INVALID_INPUT
Invalid input.
UNSUPPORTED_VERSION
The api version in the request has been discontinued. Please update to the new AdWords API version.
RequiredError Errors due to missing required field.
Enumerations
REQUIRED
Missing required field.
SelectorError Represents possible error codes for Selector.
Enumerations
INVALID_FIELD_NAME
The field name is not valid.
MISSING_FIELDS
The list of fields is null or empty.
MISSING_PREDICATES
The list of predicates is null or empty.
OPERATOR_DOES_NOT_SUPPORT_MULTIPLE_VALUES
Predicate operator does not support multiple values. Multiple values are supported only for Predicate.Operator.IN and Predicate.Operator.NOT_IN.
INVALID_PREDICATE_ENUM_VALUE
The predicate enum value is not valid.
MISSING_PREDICATE_OPERATOR
The predicate operator is empty.
MISSING_PREDICATE_VALUES
The predicate values are empty.
INVALID_PREDICATE_FIELD_NAME
The predicate field name is not valid.
INVALID_PREDICATE_OPERATOR
The predicate operator is not valid.
INVALID_FIELD_SELECTION
Invalid selection of fields.
INVALID_PREDICATE_VALUE
The predicate value is not valid.
INVALID_SORT_FIELD_NAME
The sort field name is not valid or the field is not sortable.
SELECTOR_ERROR
Standard error.
FILTER_BY_DATE_RANGE_NOT_SUPPORTED
Filtering by date range is not supported.
START_INDEX_IS_TOO_HIGH
Selector paging start index is too high.
TOO_MANY_PREDICATE_VALUES
The values list in a predicate was too long.
UNKNOWN_ERROR
SizeLimitError Indicates that the number of entries in the request or response exceeds the system limit.
Enumerations
REQUEST_SIZE_LIMIT_EXCEEDED
The number of entries in the request exceeds the system limit.
RESPONSE_SIZE_LIMIT_EXCEEDED
The number of entries in the response exceeds the system limit.
INTERNAL_STORAGE_ERROR
The account is too large to load.
UNKNOWN
StringFormatError A list of error code for reporting invalid content of input strings.
Enumerations
UNKNOWN
ILLEGAL_CHARS
The input string value contains disallowed characters.
INVALID_FORMAT
The input string value is invalid for the associated field.
StringLengthError Errors associated with the length of the given string being out of bounds.
Enumerations
TOO_SHORT
TOO_LONG
UserListError Represents possible error codes in UserListService.
Enumerations
EXTERNAL_REMARKETING_USER_LIST_MUTATE_NOT_SUPPORTED
Creating and updating external remarketing user lists is not supported.
CONCRETE_TYPE_REQUIRED
Concrete type of user list (logical v.s. remarketing) is required for ADD and SET operations.
CONVERSION_TYPE_ID_REQUIRED
Adding/updating user list conversion types requires specifying the conversion type id.
DUPLICATE_CONVERSION_TYPES
Remarketing user list cannot have duplicate conversion types.
INVALID_CONVERSION_TYPE
Conversion type is invalid/unknown.
INVALID_DESCRIPTION
User list description is empty or invalid
INVALID_NAME
User list name is empty or invalid.
INVALID_TYPE
Type of the UserList does not match.
CAN_NOT_ADD_SIMILAR_LIST_AS_LOGICAL_LIST_NONE_OPERAND
Can't use similar list in logical user list rule when operator is NONE.
CAN_NOT_ADD_LOGICAL_LIST_AS_LOGICAL_LIST_OPERAND
Embedded logical user lists are not allowed.
INVALID_USER_LIST_LOGICAL_RULE_OPERAND
User list rule operand is invalid.
NAME_ALREADY_USED
Name is already being used for another user list for the account.
NEW_CONVERSION_TYPE_NAME_REQUIRED
Name is required when creating a new conversion type.
CONVERSION_TYPE_NAME_ALREADY_USED
The given conversion type name has been used.
OWNERSHIP_REQUIRED_FOR_SET
Only an owner account may edit a user list.
REMOVE_NOT_SUPPORTED
Removing user lists is not supported.
USER_LIST_MUTATE_NOT_SUPPORTED
The user list of the type is not mutable
INVALID_RULE
Rule is invalid.
INVALID_DATE_RANGE
The specified date range is empty.
CAN_NOT_MUTATE_SENSITIVE_USERLIST
A userlist which is privacy sensitive or legal rejected cannot be mutated by external users.
MAX_NUM_RULEBASED_USERLISTS
Maximum number of rulebased user lists a customer can have.
CANNOT_MODIFY_BILLABLE_RECORD_COUNT
BasicUserList's billable record field cannot be modified once it is set.
APP_ID_NOT_ALLOWED
appId field can only be set when uploadKeyType is MOBILE_ADVERTISING_ID.
APP_ID_NOT_SET
appId field must be set when uploadKeyType is MOBILE_ADVERTISING_ID.
USERLIST_NAME_IS_RESERVED_FOR_SYSTEM_LIST
USER_LIST_SERVICE_ERROR
Default generic error.