Use the MutateJobService 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.
Note this service is similar to BulkMutateJobService and will
eventually replace it. This new service supports a simplified API.
Keep in mind that using the simplified mutate will create a
SimpleMutateJob, which should not be used with subsequent calls
to BulkMutateJobService.
Requests to the service will fail if the request was invalid or if any of a job's structural constraints are violated, and depending on the operation, the job will not get created or updated.
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 COMPLETED, you can retrieve the
job's results.
A job can fail even after it has been accepted for processing. For
example, a job may fail if the system experienced too many transient errors.
In this scenario, the job will get a status of FAILED and will
stop processing.
The submitted operations are processed in batches for efficiency. Each batch is processed atomically so that either all of them have successful results, or they all fail with a failure result for the entire batch.
Normally, jobs could be processed in parallel. This may cause concurrent
mutations to the same entities to fail, though these would be retried later,
see below. If you want to serialize the processing of jobs, you could
specify prerequisites through the optional JobPolicy.
You may choose to avoid submitting a new job for mutating an entity while another job for the same entity has not completed yet.
The service will keep retrying operations when transient failures occur. However, if these failures persist for several hours or more serious ones occur, the service will abort a job leaving some or all of its operations unprocessed.
- Production WSDL
-
https://adwords.google.com/api/adwords/cm/v201302/MutateJobService?wsdl - Namespace
-
https://adwords.google.com/api/adwords/cm/v201302 - Operations
- Errors
-
- AdError
- AdExtensionError
- AdExtensionOverrideError
- AdGroupAdError
- AdGroupCriterionError
- AdGroupServiceError
- AdxError
- AuthenticationError
- AuthorizationError
- BetaError
- BiddingError
- BiddingErrors
- BiddingTransitionError
- BudgetError
- BulkMutateJobError
- CampaignAdExtensionError
- CampaignCriterionError
- CampaignError
- ClientTermsError
- CriterionError
- DatabaseError
- DateError
- DistinctError
- EntityAccessDenied
- EntityCountLimitExceeded
- EntityNotFound
- ForwardCompatibilityError
- IdError
- ImageError
- InternalApiError
- JobError
- MediaError
- NewEntityCreationError
- NotEmptyError
- NotWhitelistedError
- NullError
- OperationAccessDenied
- OperatorError
- PagingError
- PolicyViolationError
- QueryError
- QuotaCheckError
- QuotaError
- RangeError
- RateExceededError
- ReadOnlyError
- RegionCodeError
- RejectedError
- RequestError
- RequiredError
- SelectorError
- SettingError
- SizeLimitError
- StatsQueryError
- StringLengthError
- TargetError
get
Query the status of existing jobs, both simple and bulk API.
Use a JobSelector to query and return a list which may contain both BulkMutateJob and/or SimpleMutateJob.
Parameters
| Field | Type | Description |
|---|---|---|
| selector |
Response
| Field | Type | Description |
|---|---|---|
| rval |
getResult
Query mutation results, of a COMPLETED job.
Use a JobSelector to query and return either a BulkMutateResult or a SimpleMutateResult. Submit only one job ID at a time.
Parameters
| Field | Type | Description |
|---|---|---|
| selector |
Response
| Field | Type | Description |
|---|---|---|
| rval |
JobResult
|
mutate
Simplified way of submitting a mutation job. The provided list of operations, if valid, will create a new job with a unique id, which will be returned. This id can later be used in invocations of get and getResult. Policy can optionally be specified.
When this method returns with success, the job will be in
PROCESSING or PENDING state and no further action is
needed for the job to get executed.
You should not use the returned BulkMutateJobId with bulk API
BulkMutateJobService.mutate method.
Parameters
| Field | Type | Description |
|---|---|---|
| operations | ||
| policy |
BulkMutateJobPolicy
|
Response
| Field | Type | Description |
|---|---|---|
| rval |
SimpleMutateJob
|
Errors
| Error | Reasons |
|---|---|
| AdError | Base error class for Ad Service. Enumerations
|
| AdExtensionError | AdExtension errors. Enumerations
|
| AdExtensionOverrideError | AdExtensionOverride errors. Enumerations
|
| AdGroupAdError | Error information for AdGroupAdService. Enumerations
|
| AdGroupCriterionError | Base error class for Ad Group Criterion Service. Enumerations
|
| AdGroupServiceError | Represents possible error codes in AdGroupService. Enumerations
|
| AdxError | Errors that are thrown when a non-AdX feature is accessed by an AdX customer. Enumerations
|
| AuthenticationError | Errors returned when Authentication failed. Enumerations
|
| AuthorizationError | Errors encountered when trying to authorize a user. Enumerations
|
| BetaError | Errors that are thrown when a Beta feature is accessed incorrectly. Enumerations
|
| BiddingError | Represents bidding errors. Enumerations
|
| BiddingErrors | Represents error codes for bidding strategy entities. Enumerations
|
| BiddingTransitionError | Bidding transition errors. Enumerations
|
| BudgetError | A list of all the error codes being used by the common budget domain package. Enumerations
|
| BulkMutateJobError | Bulk mutate job handling errors. Enumerations
|
| CampaignAdExtensionError | CampaignAdExtension errors. Enumerations
|
| CampaignCriterionError | Base error class for Campaign Criterion Service. Enumerations
|
| CampaignError | Base error class for Campaign Service. Enumerations
|
| ClientTermsError | Error due to user not accepting the AdWords terms of service. Enumerations
|
| CriterionError | Error class used for reporting criteria related errors. Enumerations
|
| DatabaseError | Errors that are thrown due to a database access problem. Enumerations
|
| DateError | Errors associated with invalid dates and date ranges. Enumerations
|
| DistinctError | Errors related to distinct ids or content. Enumerations
|
| EntityAccessDenied | Reports permission problems trying to access an entity. Enumerations
|
| EntityCountLimitExceeded | Signals that an entity count limit was exceeded for some level.
For example, too many criteria for a campaign. Enumerations
|
| EntityNotFound | An id did not correspond to an entity, or it referred to an entity which does not belong to the
customer. Enumerations
|
| ForwardCompatibilityError | A ForwardComptibilityError represents possible errors when using the forwardCompatibilityMap
in some of the common services. Enumerations
|
| IdError | Errors associated with the ids. Enumerations
|
| ImageError | Error class for errors associated with parsing image data. Enumerations
|
| 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
|
| JobError | Job handling errors. Enumerations
|
| MediaError | Error class for media related errors. Enumerations
|
| NewEntityCreationError | Error associated with creation of new entities using
TempIds.Enumerations
|
| NotEmptyError | Errors corresponding with violation of a NOT EMPTY check. Enumerations
|
| NotWhitelistedError | Indicates that the customer is not whitelisted for accessing the API. Enumerations
|
| NullError | Errors associated with violation of a NOT NULL 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
|
| PagingError | Error codes for pagination.
See Paging. Enumerations
|
| PolicyViolationError | Represents violations of a single policy by some text in a field. Violations of a single policy by the same string in multiple places within a field is reported in one instance of this class and only one exemption needs to be filed. Violations of a single policy by two different strings is reported as two separate instances of this class. e.g. If 'ACME' violates 'capitalization' and occurs twice in a text ad it would be represented by one instance. If the ad also contains 'INC' which also violates 'capitalization' it would be represented in a separate instance. |
| QueryError | A QueryError represents possible errors for query parsing and execution. Enumerations
|
| QuotaCheckError | Encapsulates the errors thrown during developer quota checks. Enumerations
|
| QuotaError | Errors that are thrown if a quota limit is exceeded. 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
|
| RegionCodeError | A list of all errors associated with the @RegionCode constraints. 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
|
| SettingError | Indicates a problem with campaign settings. Enumerations
|
| SizeLimitError | Indicates that the number of entries in the request or response exceeds the system limit. Enumerations
|
| StatsQueryError | Represents possible error codes when querying for stats. Enumerations
|
| StringLengthError | Errors associated with the length of the given string being
out of bounds. Enumerations
|
| TargetError | A list of all the error codes being used by the common targeting package. Enumerations
|