\Google\AdsApi\AdWords\BatchJobsBatchJobUploadStatus

Status of the upload process for a batch job.

Summary

Methods
Properties
Constants
__construct()
getTotalContentBytes()
getResumableUploadUrl()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
initiateResumableUpload()
$connectionSettings
$totalContentBytes
$resumableUploadUrl
$httpClient
N/A

Properties

$connectionSettings

$connectionSettings :

Type

$totalContentBytes

$totalContentBytes :

Type

$resumableUploadUrl

$resumableUploadUrl :

Type

$httpClient

$httpClient :

Type

Methods

__construct()

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

Creates a `BatchJobUploadStatus` object with the specified parameters.

Parameters

string $url

the resumable upload URL or an upload URL if $totalContentBytes is 0

\Google\AdsApi\AdWords\AdWordsSession $session

the session used to connect to AdWords API

integer|null $totalContentBytes

the total content bytes uploaded so far

\GuzzleHttp\Client|null $httpClient

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

\Google\AdsApi\Common\GuzzleHttpClientFactory|null $httpClientFactory

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

getTotalContentBytes()

getTotalContentBytes(): integer

Returns

integer —

the total content bytes uploaded so far

getResumableUploadUrl()

getResumableUploadUrl(): string

Returns

string —

the resumable upload URL for incremental upload

initiateResumableUpload()

initiateResumableUpload(string  $uploadUrl): string

Initiates the resumable upload by sending a request to Google Cloud Storage.

Parameters

string $uploadUrl

the upload URL of a batch job

Returns

string —

the URL for the initiated resumable upload