AdWords API

AdWords API
Feedback on this document

UserListService (v201209)

Use this service in conjunction with user list criteria to display ads to users that have previously expressed interest in your website. This style of advertising is called remarketing.

A remarketing user list contains the list of users that have triggered a specific conversion event on your website.

A logical user list contains the set of users constructed by logically combining existing user lists.

External remarketing user lists expose user lists created using the DoubleClick platform and are only available for certain advertisers.

Production WSDL
https://adwords.google.com/api/adwords/cm/v201209/UserListService?wsdl
Namespace
https://adwords.google.com/api/adwords/cm/v201209
Operations
Errors

get

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

Parameters

Field Type Description
serviceSelector 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

Adds and updates user lists.

Note: UserListOperation does not support the REMOVE operator. To disable a user list, set its UserListMembershipStatus to CLOSED.

Parameters

Field Type Description
operations UserListOperation[] The operations to apply.

Response

Field Type Description
rval UserListReturnValue The mutated UserList entities.

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.
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.
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.
ClientTermsError Error due to user not accepting the AdWords terms of service.
Enumerations
INCOMPLETE_SIGNUP_CURRENT_ADWORDS_TNC_NOT_AGREED
Customer has not agreed to the latest AdWords Terms & Conditions
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.
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
DistinctError Errors related to distinct ids or content.
Enumerations
DUPLICATE_ELEMENT
DUPLICATE_TYPE
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.
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.
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.
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.
UNKNOWN
The reason the invoked method or operation is prohibited is not known (the client may be of an older version than the server).
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
INCOMPLETE_SIGNUP_LATEST_ADWORDS_API_TNC_NOT_AGREED
Latest AdWords API T&C not agreed.
INCOMPLETE_SIGNUP_NO_BILLING_INFO
No Billing Info.
INCOMPLETE_SIGNUP_USER_INFO_MISSING
User Info missing.
INCOMPLETE_SIGNUP_USER_INFO_PENDING
User Info pending.
INCOMPLETE_SIGNUP_USER_INFO_REJECTED
User Info rejected.
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
RequestError Encapsulates the generic errors thrown when there's an error with user request.
Enumerations
UNKNOWN
Error reason is unknown.
INVALID_INPUT
Invalid input.
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.
UNKNOWN_ERROR
Used for return value only. An enumeration could not be processed, typically due to incompatibility with your WSDL version.
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.
UNKNOWN
Used for return value only. An enumeration could not be processed, typically due to incompatibility with your WSDL version.
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_USER_INTEREST_LOGICAL_RULE_OPERAND
User interest rule operand is invalid.
INVALID_USER_LIST_LOGICAL_RULE_OPERAND
User list rule operand is invalid.
MEMBERSHIP_LIFE_SPAN_NOT_POSITIVE
User list membership life span should be positive.
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.
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
USER_LIST_SERVICE_ERROR
Default generic error.

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.