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

BatchJobService (v201809)

Use the BatchJobService to schedule large batches of updates to your AdWords campaigns as asynchronous mutate jobs, and to retrieve the status, results or statistics of your recent jobs.

Use this service when you wish to release your application from actively waiting on a synchronous response. Your application can do other things or even shutdown while we execute mutations asynchronously.

Once a job has been submitted, you may check its status periodically, by calling get.

Caution: Do not poll the job status too frequently or you will risk getting your customer rate-limited.

Once a job's status changes to DONE, you can retrieve the job's results.

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

get

Query the status of existing BatchJobs.

Parameters

Field Type Description
selector Selector The selector specifying the BatchJobs to return.

Response

Field Type Description
rval BatchJobPage The list of selected jobs.

mutate

Creates or updates a BatchJob.

Note: BatchJobOperation does not support the REMOVE operator. It is not necessary to remove BatchJobs.

Parameters

Field Type Description
operations BatchJobOperation[] A list of operations.

Response

Field Type Description
rval BatchJobReturnValue The list of created or updated jobs.

query

Returns the list of BatchJobs that match the query.

Parameters

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

Response

Field Type Description
rval BatchJobPage The list of selected jobs.

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.
BatchJobError An error related to a BatchJob.
Enumerations
UNKNOWN
DISK_QUOTA_EXCEEDED
The user exceeded allowed disk quota for in-flight jobs.
FAILED_TO_CREATE_JOB
An internal error resulted in a failure to create the job.
INVALID_STATE_CHANGE
The requested state change was invalid.
BatchJobProcessingError An error related to processing a BatchJob.
Enumerations
UNKNOWN
INPUT_FILE_CORRUPTION
The input file was corrupted.
INTERNAL_ERROR
An internal API error occurred while processing the batch.
DEADLINE_EXCEEDED
Unable to complete a batch in the allotted time.
FILE_FORMAT_ERROR
The input file had a format error.
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.
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
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.
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