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
-
- AuthenticationError
- AuthorizationError
- BatchJobError
- BatchJobProcessingError
- ClientTermsError
- DatabaseError
- DistinctError
- IdError
- InternalApiError
- NotEmptyError
- OperationAccessDenied
- OperatorError
- QuotaCheckError
- RangeError
- RateExceededError
- ReadOnlyError
- RejectedError
- RequestError
- RequiredError
- SelectorError
- SizeLimitError
- StringFormatError
- StringLengthError
get
Query the status of existing BatchJob
s.
Parameters
Field | Type | Description |
---|---|---|
selector
|
|
The selector specifying the BatchJob s to return. |
Response
Field | Type | Description |
---|---|---|
rval
|
|
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
|
|
A list of operations. |
Response
Field | Type | Description |
---|---|---|
rval
|
|
The list of created or updated jobs. |
query
Returns the list of BatchJob
s that match the query.
Parameters
Field | Type | Description |
---|---|---|
query
|
|
The SQL-like AWQL query string. |
Response
Field | Type | Description |
---|---|---|
rval
|
|
The list of selected jobs. |
Errors
Error | Reasons |
---|---|
AuthenticationError
|
Errors returned when Authentication failed.
Enumerations
|
AuthorizationError
|
Errors encountered when trying to authorize a user.
Enumerations
|
BatchJobError
|
An error related to a BatchJob .
Enumerations
|
BatchJobProcessingError
|
An error related to processing a BatchJob .
Enumerations
|
ClientTermsError
|
Error due to user not accepting the AdWords terms of service.
Enumerations
|
DatabaseError
|
Errors that are thrown due to a database access problem.
Enumerations
|
DistinctError
|
Errors related to distinct ids or content.
Enumerations
|
IdError
|
Errors associated with the ids.
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
|
NotEmptyError
|
Errors corresponding with violation of a NOT EMPTY 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
|
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
|