The AdWords API will sunset on April 27, 2022. Migrate to the Google Ads API to take advantage of the latest Google Ads features.

CustomerService (v201809)

Service to access basic details about any customer.

Production WSDL
https://adwords.google.com/api/adwords/mcm/v201809/CustomerService?wsdl
Namespace
https://adwords.google.com/api/adwords/mcm/v201809
Operations
Errors

getCustomers

Returns details of all the customers directly accessible by the user authenticating the call.

Note: This method will return only test accounts if the developer token used has not been approved.

Starting with v201607, if clientCustomerId is specified in the request header, only details of that customer will be returned. To do this for prior versions, use the get() method instead.

Parameters

Field Type Description

Response

Field Type Description
rval Customer[]

mutate

Update the authorized customer.

While there are a limited set of properties available to update, please read this help center article on auto-tagging before updating customer.autoTaggingEnabled.

Parameters

Field Type Description
customer Customer the requested updated value for the customer.

Response

Field Type Description
rval Customer

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.
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
CustomerError Possible error codes in CustomerService.
Enumerations
INVALID_SERVICE_LINK
Referenced service link does not exist
INVALID_STATUS
An ACTIVE link cannot be made PENDING
ACCOUNT_NOT_SET_UP
CustomerService cannot get an account that is not fully set up.
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
DistinctError Errors related to distinct ids or content.
Enumerations
DUPLICATE_ELEMENT
DUPLICATE_TYPE
IdError Errors associated with the ids.
Enumerations
NOT_FOUND
Id not found
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.
NotEmptyError Errors corresponding with violation of a NOT EMPTY check.
Enumerations
EMPTY_LIST
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
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.
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
UrlError Url Validation errors.
Enumerations
INVALID_TRACKING_URL_TEMPLATE
The tracking url template is invalid.
INVALID_TAG_IN_TRACKING_URL_TEMPLATE
The tracking url template contains invalid tag.
MISSING_TRACKING_URL_TEMPLATE_TAG
The tracking url template must contain at least one tag (e.g. {lpurl}), This applies only to tracking url template associated with website ads or product ads.
MISSING_PROTOCOL_IN_TRACKING_URL_TEMPLATE
The tracking url template must start with a valid protocol (or lpurl tag).
INVALID_PROTOCOL_IN_TRACKING_URL_TEMPLATE
The tracking url template starts with an invalid protocol.
MALFORMED_TRACKING_URL_TEMPLATE
The tracking url template contains illegal characters.
MISSING_HOST_IN_TRACKING_URL_TEMPLATE
The tracking url template must contain a host name (or lpurl tag).
INVALID_TLD_IN_TRACKING_URL_TEMPLATE
The tracking url template has an invalid or missing top level domain extension.
REDUNDANT_NESTED_TRACKING_URL_TEMPLATE_TAG
The tracking url template contains nested occurrences of the same conditional tag (i.e. {ifmobile:{ifmobile:x}}).
INVALID_FINAL_URL
The final url is invalid.
INVALID_TAG_IN_FINAL_URL
The final url contains invalid tag.
REDUNDANT_NESTED_FINAL_URL_TAG
The final url contains nested occurrences of the same conditional tag (i.e. {ifmobile:{ifmobile:x}}).
MISSING_PROTOCOL_IN_FINAL_URL
The final url must start with a valid protocol.
INVALID_PROTOCOL_IN_FINAL_URL
The final url starts with an invalid protocol.
MALFORMED_FINAL_URL
The final url contains illegal characters.
MISSING_HOST_IN_FINAL_URL
The final url must contain a host name.
INVALID_TLD_IN_FINAL_URL
The tracking url template has an invalid or missing top level domain extension.
INVALID_FINAL_MOBILE_URL
The final mobile url is invalid.
INVALID_TAG_IN_FINAL_MOBILE_URL
The final mobile url contains invalid tag.
REDUNDANT_NESTED_FINAL_MOBILE_URL_TAG
The final mobile url contains nested occurrences of the same conditional tag (i.e. {ifmobile:{ifmobile:x}}).
MISSING_PROTOCOL_IN_FINAL_MOBILE_URL
The final mobile url must start with a valid protocol.
INVALID_PROTOCOL_IN_FINAL_MOBILE_URL
The final mobile url starts with an invalid protocol.
MALFORMED_FINAL_MOBILE_URL
The final mobile url contains illegal characters.
MISSING_HOST_IN_FINAL_MOBILE_URL
The final mobile url must contain a host name.
INVALID_TLD_IN_FINAL_MOBILE_URL
The tracking url template has an invalid or missing top level domain extension.
INVALID_FINAL_APP_URL
The final app url is invalid.
INVALID_TAG_IN_FINAL_APP_URL
The final app url contains invalid tag.
REDUNDANT_NESTED_FINAL_APP_URL_TAG
The final app url contains nested occurrences of the same conditional tag (i.e. {ifmobile:{ifmobile:x}}).
MULTIPLE_APP_URLS_FOR_OSTYPE
More than one app url found for the same OS type.
INVALID_OSTYPE
The OS type given for an app url is not valid.
INVALID_PROTOCOL_FOR_APP_URL
The protocol given for an app url is not valid. (E.g. "android-app://")
INVALID_PACKAGE_ID_FOR_APP_URL
The package id (app id) given for an app url is not valid.
URL_CUSTOM_PARAMETERS_COUNT_EXCEEDS_LIMIT
The number of url custom parameters for an entity exceeds the maximum limit allowed.
URL_CUSTOM_PARAMETER_REMOVAL_WITH_NON_NULL_VALUE
The parameter has isRemove set to true but a value that is non-null.
CANNOT_REMOVE_URL_CUSTOM_PARAMETER_IN_ADD_OPERATION
For add operations, there will not be any existing parameters to delete.
CANNOT_REMOVE_URL_CUSTOM_PARAMETER_DURING_FULL_REPLACEMENT
When the doReplace flag is set to true, individual parameters cannot be deleted.
FINAL_URL_SUFFIX_MALFORMED
The final url suffix cannot begin with ? or & characters and must be a valid query string.
INVALID_TAG_IN_FINAL_URL_SUFFIX
The final url suffix cannot contain {lpurl} related or {ignore} tags.
NULL_CUSTOM_PARAMETER_VALUE_DURING_ADD_OR_FULL_REPLACEMENT
For ADD operations and when the doReplace flag is set to true, custom parameter values cannot be null.
INVALID_CHARACTERS_IN_URL_CUSTOM_PARAMETER_KEY
An invalid character appears in the parameter key.
INVALID_CHARACTERS_IN_URL_CUSTOM_PARAMETER_VALUE
An invalid character appears in the parameter value.
INVALID_TAG_IN_URL_CUSTOM_PARAMETER_VALUE
The url custom parameter value fails url tag validation.
REDUNDANT_NESTED_URL_CUSTOM_PARAMETER_TAG
The custom parameter contains nested occurrences of the same conditional tag (i.e. {ifmobile:{ifmobile:x}}).
MISSING_PROTOCOL
The protocol (http:// or https://) is missing.
INVALID_URL
The url is invalid.
DESTINATION_URL_DEPRECATED
Destination Url is deprecated.
INVALID_TAG_IN_URL
The url contains invalid tag.
MISSING_URL_TAG
The url must contain at least one tag (e.g. {lpurl}), This applies only to urls associated with website ads or product ads.
DUPLICATE_URL_ID
INVALID_URL_ID
URL_ERROR