PHP Class BatchJobUtils, googleads-php-lib

Show file Open project: googleads/googleads-php-lib Class Usage Examples

Public Properties

Property	Type	Description
$CLASS_MAP

Public Methods

Method	Description
DownloadBatchJobResults ( string $downloadUrl ) : string	Downloads the results of batch processing from $downloadUrl.
UploadBatchJobOperations ( array $operations )	Uploads batch job operations to the specified upload URL.
UploadIncrementalBatchJobOperations ( array $operations, boolean $isLastRequest = null )	Uploads batch job operations incrementally to the specified upload URL.
__construct ( string $uploadUrl, integer \| null $totalContentBytes = null, CurlUtils $curlUtils = null, BatchJobUtilsDelegate $batchJobUtilsDelegate = null, AdsUtilityRegistry $adsUtilityRegistry = null )	Create an instance of BatchJobUtils with the specified upload URL, total uploaded content bytes, CurlUtils object, BatchJobUtilsDelegate object and ads utility registry.

Method Details

DownloadBatchJobResults() public method

Downloads the results of batch processing from $downloadUrl.

public DownloadBatchJobResults ( string $downloadUrl ) : string
$downloadUrl	string	the download URL from which the results are downloaded
return	string	the contents of returned HTTP response

UploadBatchJobOperations() public method

Uploads batch job operations to the specified upload URL.

public UploadBatchJobOperations ( array $operations )
$operations	array	operations to be uploaded via the upload URL $uploadUrl

UploadIncrementalBatchJobOperations() public method

Uploads batch job operations incrementally to the specified upload URL.

public UploadIncrementalBatchJobOperations ( array $operations, boolean $isLastRequest = null )
$operations	array	operations to be uploaded via the upload URL
$isLastRequest	boolean	if this is last upload request

__construct() public method

Create an instance of BatchJobUtils with the specified upload URL, total uploaded content bytes, CurlUtils object, BatchJobUtilsDelegate object and ads utility registry.

public __construct ( string $uploadUrl, integer \| null $totalContentBytes = null, CurlUtils $curlUtils = null, BatchJobUtilsDelegate $batchJobUtilsDelegate = null, AdsUtilityRegistry $adsUtilityRegistry = null )
$uploadUrl	string	the upload URL to which the operations will be uploaded
$totalContentBytes	integer \| null	the total content bytes uploaded so far, used in incremental batch job uploads
$curlUtils	CurlUtils	the CurlUtils object for uploading batch job operations and downloading the results of batch job processing
$batchJobUtilsDelegate	BatchJobUtilsDelegate	the batch job utils delegate that uploads batch job operations and downloads the results
$adsUtilityRegistry	AdsUtilityRegistry	the ads utility registry

Property Details

$CLASS_MAP public static property

public static $CLASS_MAP