My favorites | English | Sign in

Faster apps faster - GWT 2.0 with Speed Tracer New!

AdWords API v2009

v2009 Docs | v13 Docs

type BulkMutateJob

Service

BulkMutateJobService

Dependencies

get() mutate()
uses
BulkMutateJob
uses
BasicJobStatus BulkMutateJobEvent BulkMutateJobPolicy BulkMutateRequest BulkMutateResult

Inheritance

Job
is a superclass of
BulkMutateJob

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

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/v200909

Fields

Field Type Description

Job (inherited)
customerJobKey xsd:string Unique job key (per customer) for guarding against duplicate job submissions. This field is optional. This field is read only and should not be set for following Operators : SET.
context JobContext The request and processing context of this job. This field is read only and should not be set.
failureReason ApiErrorReason Failure reason if this job has failed. This field is read only and should not be set.
stats
  1. JobStats
    1. BulkMutateJobStats
The statistics concerning the processing of this job. This field is read only and should not be set.
billingSummary BillingSummary The billing summary specifying the cost of this job. This field is read only and should not be set.
Job.Type xsd:string This field indicates the subtype of Job of this instance. It is ignored on input, and instead xsi:type should be specified.

BulkMutateJob
id 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.
policy 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.
request 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 BasicJobStatus Status of this job. This field is read only and should not be set.
  1. Enumerations
    1. COMPLETED

      1. The job has completed (successfully or otherwise) and all its complete result is available.

    2. PROCESSING

      1. The job is being actively processed by one or more tasks.

    3. FAILED

      1. The job has encountered severe failures and could not be completed.

    4. PENDING

      1. The job request has been received, and is pending receipt of additional request parts, validation and assignment to tasks for processing.
history BulkMutateJobEvent[] History of status changes of this job. This field is read only and should not be set.
result BulkMutateResult The selected result part of this job. This field is read only and should not be set.
numRequestParts xsd:int Total number of request parts (maximum of 100) in this job.
numRequestPartsReceived 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.