com.google.api.ads.adwords.lib.utils

Interface BatchJobHelperInterface<OperationT,OperandT,ErrorT,ResultT extends BatchJobMutateResultInterface<OperandT,ErrorT>,ResponseT extends BatchJobMutateResponseInterface<OperandT,ErrorT,ResultT>>

Type Parameters:

OperationT - the operation type for the API version and SOAP toolkit.

OperandT - the operand type for the API version and SOAP toolkit.

ErrorT - the ApiError type for the API version and SOAP toolkit.

ResultT - the mutate result type for the API version and SOAP toolkit.

ResponseT - the mutate response type for the API version and SOAP toolkit.

All Known Implementing Classes:

BatchJobHelper, BatchJobHelper

public interface BatchJobHelperInterface<OperationT,OperandT,ErrorT,ResultT extends BatchJobMutateResultInterface<OperandT,ErrorT>,ResponseT extends BatchJobMutateResponseInterface<OperandT,ErrorT,ResultT>>

Utility for uploading operations and downloading results for a BatchJob.

Method Summary

Modifier and Type	Method and Description
ResponseT	downloadBatchJobMutateResponse(String downloadUrl) Downloads and returns the results from the attempted operations for a completed batch job.
ResponseT	downloadBatchJobMutateResponse(String downloadUrl, int startIndex, int numberResults) Downloads and returns a chunk of results from the attempted operations for a completed batch job.
BatchJobUploadResponse	uploadBatchJobOperations(Iterable<OperationT> operations, String uploadUrl) Uploads the specified operations to the batch job.
BatchJobUploadResponse	uploadIncrementalBatchJobOperations(Iterable<? extends OperationT> operations, boolean isLastRequest, BatchJobUploadStatus batchJobUploadStatus) Uploads the specified operations to the batch job.

Method Detail

uploadBatchJobOperations

BatchJobUploadResponse uploadBatchJobOperations(Iterable<OperationT> operations,
                                                String uploadUrl)
                                         throws BatchJobException

Uploads the specified operations to the batch job. After this method returns successfully, the job will transition to the ACTIVE state.

Use this method if you want to upload all operations in a single request. To upload operations across multiple requests, use uploadIncrementalBatchJobOperations(Iterable, boolean, BatchJobUploadStatus) instead.

Parameters:

operations - the operations to upload to the batch job

uploadUrl - the BatchJob#getUploadUrl()

Returns:

the response from the upload if the request succeeded

Throws:

BatchJobException - if the request failed

uploadIncrementalBatchJobOperations

BatchJobUploadResponse uploadIncrementalBatchJobOperations(Iterable<? extends OperationT> operations,
                                                           boolean isLastRequest,
                                                           BatchJobUploadStatus batchJobUploadStatus)
                                                    throws BatchJobException

Uploads the specified operations to the batch job. Use this method if you want to upload operations incrementally. To upload all operations in a single request, use uploadBatchJobOperations(Iterable, String) instead.

If isLastRequest, then after this method returns successfully, the job will transition to the ACTIVE state.

Parameters:

operations - the operations to upload to the batch job

isLastRequest - if this is the last set of operations to upload for the job

batchJobUploadStatus - the current upload status. If this is the first upload, set the BatchJobUploadStatus.getResumableUploadUri() to the BatchJob#getUploadUrl().

Returns:

the response from the upload if the request succeeded

Throws:

BatchJobException - if the request failed

downloadBatchJobMutateResponse

ResponseT downloadBatchJobMutateResponse(String downloadUrl)
                                  throws BatchJobException

Downloads and returns the results from the attempted operations for a completed batch job.

Parameters:

downloadUrl - the BatchJob.getDownloadUrl()

Throws:

BatchJobException

downloadBatchJobMutateResponse

ResponseT downloadBatchJobMutateResponse(String downloadUrl,
                                         int startIndex,
                                         int numberResults)
                                  throws BatchJobException

Downloads and returns a chunk of results from the attempted operations for a completed batch job.

NOTE: This is only available on Axis implementations of this interface. The JAX-WS implementations will throw an UnsupportedOperationException.

Parameters:

downloadUrl - the BatchJob.getDownloadUrl()

startIndex - zero-based index of the first result to return

numberResults - maximum number of results to return

Throws:

BatchJobException - if unable to download the results.

UnsupportedOperationException - if this method is not supported by the implementation.