Class: BulkMutateJob

Source Location: /AdWords/v201008/cm/BulkMutateJobService.php

Class Overview

Job
   |
   --BulkMutateJob

A {@code BulkMutateJob} is essentially a mixed collection of mutate

Inherited Variables

Class: Job

Job::$billingSummary
Job::$context
Job::$customerJobKey
Job::$failureReason
Job::$JobType
Job::$stats

Inherited Methods

Class: Job

Job::__construct()
Job::getNamespace(): Gets the namesapce of this class
Job::getParameterMap(): Provided for getting non-php-standard named variables
Job::getXsiTypeName(): Gets the xsi:type name of this class
Job::__get(): Provided for getting non-php-standard named variables
Job::__set(): Provided for setting non-php-standard named variables

Class Details

[line 12253]
A {@code 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. Since v201003, a job may have no fewer than 100 mutate operations in total.

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.

[ Top ]

Class Variables

$history =

[line 12282]

Tags:

access:

public

Type:

BulkMutateJobEvent[]

[ Top ]

$id =

[line 12258]

Tags:

access:

public

Type:

integer

[ Top ]

$numRequestParts =

[line 12294]

Tags:

access:

public

Type:

integer

[ Top ]

$numRequestPartsReceived =

[line 12300]

Tags:

access:

public

Type:

integer

[ Top ]

$policy =

[line 12264]

Tags:

access:

public

Type:

BulkMutateJobPolicy

[ Top ]

$request =

[line 12270]

Tags:

access:

public

Type:

BulkMutateRequest

[ Top ]

$result =

[line 12288]

Tags:

access:

public

Type:

BulkMutateResult

[ Top ]

$status =

[line 12276]

Tags:

access:

public

Type:

tnsBasicJobStatus

[ Top ]

Class Methods

constructor __construct [line 12318]

BulkMutateJob __construct(
[
$id = NULL], [
$policy = NULL], [
$request = NULL], [
$status = NULL], [
$history = NULL], [
$result = NULL], [
$numRequestParts = NULL], [
$numRequestPartsReceived = NULL], [
$customerJobKey = NULL], [
$context = NULL], [
$failureReason = NULL], [
$stats = NULL], [
$billingSummary = NULL], [
$JobType = NULL])

Tags:

access:

public

Overrides Job::__construct() (parent method not documented)

Parameters:

	$id
	$policy
	$request
	$status
	$history
	$result
	$numRequestParts
	$numRequestPartsReceived
	$customerJobKey
	$context
	$failureReason
	$stats
	$billingSummary
	$JobType

[ Top ]

method getNamespace [line 12306]

the getNamespace(
)

Gets the namesapce of this class

Tags:

return:	namespace of this class
access:	public

Overrides Job::getNamespace() (Gets the namesapce of this class)

[ Top ]

method getXsiTypeName [line 12314]

the getXsiTypeName(
)

Gets the xsi:type name of this class

Tags:

return:	xsi:type name of this class
access:	public

Overrides Job::getXsiTypeName() (Gets the xsi:type name of this class)

[ Top ]

Documentation generated by phpDocumentor 1.4.3