\Google\AdsApi\AdWords\BatchJobs\v201809BatchJobsDelegate

A delegate of `BatchJobs`, which shouldn't be used directly.

Use BatchJobs to upload batch operations and download the results of batch processing.

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
padContent()
$REQUIRED_CONTENT_BYTES_INCREMENT
$MUTATE_RESULT_CLASS_NAME
$session
$httpClient
$httpClientFactory
$batchJobSerializer
$mutateResultClassName
N/A

Properties

$REQUIRED_CONTENT_BYTES_INCREMENT

$REQUIRED_CONTENT_BYTES_INCREMENT :

For incremental uploads, each request's contents must have a length in bytes divisible by 256K, per Google Cloud Storage's requirement: https://cloud.google.com/storage/docs/xml-api/resumable-upload#step_3wzxhzdk34upload_the_file_blocks.

Type

$MUTATE_RESULT_CLASS_NAME

$MUTATE_RESULT_CLASS_NAME :

Type

$session

$session :

Type

$httpClient

$httpClient :

Type

$httpClientFactory

$httpClientFactory :

Type

$batchJobSerializer

$batchJobSerializer :

Type

$mutateResultClassName

$mutateResultClassName :

Type

Methods

__construct()

__construct(\Google\AdsApi\AdWords\AdWordsSession  $session,\GuzzleHttp\Client|null  $httpClient = null,string|null  $mutateResultClassName = null,\Google\AdsApi\Common\GuzzleHttpClientFactory|null  $httpClientFactory = null)

Creates a `BatchJobsDelegate` 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\Common\GuzzleHttpClientFactory|null $httpClientFactory

optional, the Guzzle HTTP client factory that will generate a client handling HTTP calls

uploadBatchJobOperations()

uploadBatchJobOperations(array  $operations,  $uploadUrl)

Parameters

array $operations
$uploadUrl

uploadIncrementalBatchJobOperations()

uploadIncrementalBatchJobOperations(array  $operations,\Google\AdsApi\AdWords\BatchJobs\BatchJobUploadStatus  $batchJobUploadStatus)

Parameters

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

downloadBatchJobResults()

downloadBatchJobResults(  $downloadUrl)

Parameters

$downloadUrl

padContent()

padContent(string  $content): string

Pads the request content to conform to the requirements of Google Cloud Storage.

Parameters

string $content

the request content

Returns

string —

the post-processed content