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

Class BatchJobUploader<OperandT,ApiErrorT,ResultT extends BatchJobMutateResultInterface<OperandT,ApiErrorT>,ResponseT extends BatchJobMutateResponseInterface<OperandT,ApiErrorT,ResultT>>

java.lang.Object

com.google.api.ads.adwords.lib.utils.BatchJobUploader<OperandT,ApiErrorT,ResultT,ResponseT>

Type Parameters:

OperandT - Operand for the SOAP framework and AdWords API version.

ApiErrorT - ApiError for the SOAP framework and AdWords API version.

ResultT - MutateResult for the SOAP framework and AdWords API version.

ResponseT - BatchJobMutateResponseInterface type for the SOAP framework and AdWords API version.

public class BatchJobUploader<OperandT,ApiErrorT,ResultT extends BatchJobMutateResultInterface<OperandT,ApiErrorT>,ResponseT extends BatchJobMutateResponseInterface<OperandT,ApiErrorT,ResultT>>
extends Object

Utility for uploading operations to a BatchJob and downloading results from a completed BatchJob.

Constructor Summary

Constructors

Constructor and Description
BatchJobUploader(AdWordsSession session, boolean isInitiateResumableUpload) Constructor that stores the session for authentication.

Method Summary

Modifier and Type	Method and Description
BatchJobUploadResponse	uploadBatchJobOperations(BatchJobMutateRequestInterface request, String uploadUrl) Uploads a batch job's operations and returns the response.
BatchJobUploadResponse	uploadIncrementalBatchJobOperations(BatchJobMutateRequestInterface request, boolean isLastRequest, BatchJobUploadStatus batchJobUploadStatus) Incrementally uploads a batch job's operations and returns the response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BatchJobUploader

public BatchJobUploader(AdWordsSession session,
                        boolean isInitiateResumableUpload)

Constructor that stores the session for authentication.

Parameters:

session - the AdWords session to use for authentication.

isInitiateResumableUpload - if true, then the uploader will issue an additional request to initiate resumable uploads.

Method Detail

uploadBatchJobOperations

public BatchJobUploadResponse uploadBatchJobOperations(BatchJobMutateRequestInterface request,
                                                       String uploadUrl)
                                                throws BatchJobException

Uploads a batch job's operations and returns the response.

Throws:

BatchJobException

uploadIncrementalBatchJobOperations

public BatchJobUploadResponse uploadIncrementalBatchJobOperations(BatchJobMutateRequestInterface request,
                                                                  boolean isLastRequest,
                                                                  BatchJobUploadStatus batchJobUploadStatus)
                                                           throws BatchJobException

Incrementally uploads a batch job's operations and returns the response.

Parameters:

request - the request to upload

isLastRequest - if the request is the last request in the sequence of uploads for the job

batchJobUploadStatus - the current upload status of the job

Throws:

BatchJobException