Service

MutateJobService

Inheritance

Job

▼

BulkMutateJob SimpleMutateJob

A BulkMutateJob is essentially a mixed collection of mutate operations from the following AdWords API campaign management services:

• CampaignService
• CampaignTargetService
• CampaignCriterionService
• AdGroupService
• AdGroupAdService
• AdGroupCriterionService

The mutate operations in a job's request are constructed in exactly the same way as they are for synchronous calls to these services.

The mutate operations are grouped by their scoping entity in the AdWords customer tree. Currently, mutate operations can be grouped either by the customer or by their parent campaign. However, they cannot be grouped both ways - some by customer and others by campaigns - in the same job.

Note: A job may have no more than 500,000 mutate operations in total, and no more than 10 different scoping campaigns.

The mutate operations must be packaged into containers called Operation Streams, each tagged with the ID of the scoping entity of its operations.

To facilitate the building of very large bulk mutate jobs, the operation streams of a job can be submitted using multiple request parts. A job is queued for processing as soon as it can be determined that all of its request parts have been received.

Note: A job may have no more than 100 request parts. Each part may have no more than 25 operation streams and no more than 10,000 operations in total.

---

Namespace

https://adwords.google.com/api/adwords/cm/v201209

Fields

• failureReason
• stats
• billingSummary
• Job.Type
• id
• policy
• request
• status
• history
• result
• numRequestParts
• numRequestPartsReceived

Field	Type	Description
Job (inherited)
failureReason ReadOnly	ApiErrorReason	Failure reason if this job has failed. This field is read only and should not be set. If this field is sent to the API, it will be ignored.
stats ReadOnly	JobStats BulkMutateJobStats	The statistics concerning the processing of this job. This field is read only and should not be set. If this field is sent to the API, it will be ignored.
billingSummary ReadOnly	BillingSummary	The billing summary specifying the cost of this job. This field is read only and should not be set. If this field is sent to the API, it will be ignored.
Job.Type	xsd:string	Indicates that this instance is a subtype of Job. Although this field is returned in the response, it is ignored on input and cannot be selected. Specify xsi:type instead.
BulkMutateJob
id ReadOnly	xsd:long	ID of this bulk mutate job, which is returned by BulkMutateJobService after adding a new job. This field is read only and should not be set for following Operators : ADD. If this field is sent to the API, it will be ignored.
policy ReadOnly	BulkMutateJobPolicy	Defines which existing jobs are required to successfully process before starting this job. This field can only be set when adding a new job. This field is read only and should not be set for following Operators : SET. If this field is sent to the API, it will be ignored.
request Required	BulkMutateRequest	A request part of this job. Even though a BulkMutateJob can contain up to 100 request parts (each with a unique partIndex), only one can be added or updated at a time for optimization purposes. This field is required and should not be null when it is contained within Operators : ADD.
status ReadOnly	BasicJobStatus	Status of this job. This field is read only and should not be set. If this field is sent to the API, it will be ignored. Enumerations COMPLETED The job has completed (successfully or otherwise) and all its complete result is available. PROCESSING The job is being actively processed by one or more tasks. FAILED The job has encountered severe failures and could not be completed. PENDING The job request has been received, and is pending receipt of additional request parts, validation and assignment to tasks for processing.
history ReadOnly	BulkMutateJobEvent[]	History of status changes of this job. This field is read only and should not be set. If this field is sent to the API, it will be ignored.
result ReadOnly	BulkMutateResult	The selected result part of this job. This field is read only and should not be set. If this field is sent to the API, it will be ignored.
numRequestParts	xsd:int	Total number of request parts (maximum of 100) in this job.
numRequestPartsReceived ReadOnly	xsd:int	Number of request parts currently received via ADD and SET operations. This job will begin processing when numRequestPartsReceived equals numRequestParts. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

Last updated October 4, 2012.