\Google\AdsApi\AdWords\BatchJobs\v201809BatchJobs

Provides methods for uploading operations and downloading results using a batch job upload URL generated from creating a new batch job using the `BatchJobService`.

Summary

Methods
Properties
Constants
__construct()
uploadBatchJobOperations()
uploadIncrementalBatchJobOperations()
closeIncrementalUpload()
downloadBatchJobResults()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$batchJobsDelegate
$adsUtilityRegistry
N/A

Properties

$batchJobsDelegate

$batchJobsDelegate :

Type

$adsUtilityRegistry

$adsUtilityRegistry :

Type

Methods

__construct()

__construct(\Google\AdsApi\AdWords\AdWordsSession  $session,\GuzzleHttp\Client|null  $httpClient = null,string|null  $mutateResultClassName = null,\Google\AdsApi\AdWords\BatchJobs\v201809\BatchJobsDelegate|null  $batchJobsDelegate = null,\Google\AdsApi\Common\AdsUtilityRegistry|null  $adsUtilityRegistry = null)

Creates a `BatchJobs` object with the specified parameters.

Parameters

\Google\AdsApi\AdWords\AdWordsSession $session

the session used to connect to AdWords API

\GuzzleHttp\Client|null $httpClient

optional, the Guzzle HTTP client whose handler stacks this library's logging middleware will be pushed to

string|null $mutateResultClassName

the root class name for denormalization

\Google\AdsApi\AdWords\BatchJobs\v201809\BatchJobsDelegate|null $batchJobsDelegate

the batch jobs delegate that uploads batch job operations and downloads the results

\Google\AdsApi\Common\AdsUtilityRegistry|null $adsUtilityRegistry

the ads utility registry

uploadBatchJobOperations()

uploadBatchJobOperations(array  $operations,string  $uploadUrl): \Google\AdsApi\AdWords\BatchJobs\BatchJobUploadStatus

Uploads all batch job operations to the specified upload URL.

Parameters

array $operations

operations to be uploaded via the upload URL $uploadUrl

string $uploadUrl

the upload URL for uploading operations

Throws

\Google\AdsApi\AdWords\v201809\cm\ApiException

if the upload process failed

Returns

\Google\AdsApi\AdWords\BatchJobs\BatchJobUploadStatus

the updated batch job upload status

uploadIncrementalBatchJobOperations()

uploadIncrementalBatchJobOperations(array<mixed,\Google\AdsApi\AdWords\v201809\cm\Operation>  $operations,\Google\AdsApi\AdWords\BatchJobs\BatchJobUploadStatus  $batchJobUploadStatus): \Google\AdsApi\AdWords\BatchJobs\BatchJobUploadStatus

Uploads batch job operations incrementally to the specified upload URL.

Parameters

array<mixed,\Google\AdsApi\AdWords\v201809\cm\Operation> $operations

operations to be uploaded via the upload URL

\Google\AdsApi\AdWords\BatchJobs\BatchJobUploadStatus $batchJobUploadStatus

the batch job upload status

Throws

\Google\AdsApi\AdWords\v201809\cm\ApiException

if the upload process failed

Returns

\Google\AdsApi\AdWords\BatchJobs\BatchJobUploadStatus

the updated batch job upload status

downloadBatchJobResults()

downloadBatchJobResults(string  $downloadUrl): array<mixed,\Google\AdsApi\AdWords\v201809\cm\MutateResult>

Downloads the results of batch processing from the download URL.

Parameters

string $downloadUrl

the download URL from which the results are downloaded

Throws

\Google\AdsApi\AdWords\v201809\cm\ApiException

if the download process failed

Returns

array<mixed,\Google\AdsApi\AdWords\v201809\cm\MutateResult> —

the array of results from batch processing