Docs For Class awBulkMutateJob

Description

A {@code 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 {@code 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.

copyright: Mirchev Ideas Ltd. © 2010
link: http://code.google.com/apis/adwords/v2009/docs/reference/BulkMutateJobService.BulkMutateJob.html

Located in /classes/cm/BulkMutateJob.php

awComplexObject
   |
   --awJob
      |
      --awBulkMutateJob

Variable Summary

awBulkMutateJobEvent[] $history

long $id

int $numRequestParts

int $numRequestPartsReceived

awBulkMutateJobPolicy $policy

awBulkMutateRequest $request

awBulkMutateResult $result

string $status

mixed $_checkFields

Method Summary

void getRow ()

Variables

awBulkMutateJobEvent[] $history

History of status changes of this job.

This field is read only and should not be set.

long $id

ID of this bulk mutate job, which is returned by {@code BulkMutateJobService} after adding a new job.

This field is read only and should not be set for following Operators : ADD.

int $numRequestParts

Total number of request parts (maximum of 100) in this job.

int $numRequestPartsReceived

Number of request parts currently received via {@code ADD} and {@code SET} operations. This job will begin processing when {@code numRequestPartsReceived} equals {@code numRequestParts}.

This field is read only and should not be set.

awBulkMutateJobPolicy $policy

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.

awBulkMutateRequest $request

A request part of this job. Even though a {@code 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 {@code null} when it is contained within Operators : ADD.

awBulkMutateResult $result

The selected result part of this job.

This field is read only and should not be set.

string $status

Status of this job.

This field is read only and should not be set.

var: awBasicJobStatus

mixed $_checkFields = array(
'policy' => array(
'objName' => 'awBulkMutateJobPolicy',
'type' => 'obj'
),'request'=>array('objName'=>'awBulkMutateRequest','type'=>'obj'),'history'=>array('objName'=>'awBulkMutateJobEvent','type'=>'array'),'result'=>array('objName'=>'awBulkMutateResult','type'=>'obj'),)

access: public

Redefinition of:

awJob::$_checkFields

Inherited Variables

Inherited from awJob

awJob::$billingSummary
awJob::$context
awJob::$customerJobKey
awJob::$failureReason
awJob::$stats

Inherited from awComplexObject

awComplexObject::$_cachedCheckFields
awComplexObject::$_row

Methods

access: public

void getRow ()

Redefinition of:

awComplexObject::getRow()

Inherited Methods

Inherited From awJob

awJob::factory()

Inherited From awComplexObject

awComplexObject::__construct()
awComplexObject::factory()
awComplexObject::get()
awComplexObject::getCheckFields()
awComplexObject::getRow()
awComplexObject::getSoapVars()
awComplexObject::getXML()
awComplexObject::isEmpty()
awComplexObject::remove()
awComplexObject::set()
awComplexObject::setRow()
awComplexObject::_getAsObj()