com.google.api.ads.adwords.lib.utils.BatchJobHelperInterface Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ads-lib Show documentation

Client library for Java for accessing ads APIs including DFP. If you want to use this library, you must also include another Maven artifact to specify which framework you would like to use it with. For example, to use DFP with Axis, you should include the "dfp-axis" artifact.

There is a newer version: 5.7.0

Show newest version

// Copyright 2015 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

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

import com.google.api.ads.common.lib.utils.AdsUtility;
import com.google.api.ads.common.lib.utils.UsesAdsUtilities;

/**
 * Utility for uploading operations and downloading results for a {@code BatchJob}.
 * @param  the operation type for the API version and SOAP toolkit.
 * @param  the operand type for the API version and SOAP toolkit.
 * @param  the {@code ApiError} type for the API version and SOAP toolkit.
 * @param  the mutate result type for the API version and SOAP toolkit.
 * @param  the mutate response type for the API version and SOAP toolkit.
 */
public interface BatchJobHelperInterface,
    ResponseT extends BatchJobMutateResponseInterface> {
  /**
   * Uploads the specified operations to the batch job. After this method returns successfully, the
   * job will transition to the {@code ACTIVE} state.
   *
   * 
   * Use this method if you want to upload all operations in a single request. To upload operations
   * across multiple requests, use
   * {@link #uploadIncrementalBatchJobOperations(Iterable, boolean, BatchJobUploadStatus)} instead.
   *
   * @param operations the operations to upload to the batch job
   * @param uploadUrl the {@code BatchJob#getUploadUrl()}
   * @return the response from the upload if the request succeeded
   * @throws BatchJobException if the request failed
   */
  @UsesAdsUtilities({AdsUtility.BATCH_JOB_HELPER})
  BatchJobUploadResponse uploadBatchJobOperations(Iterable operations, String uploadUrl)
      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 {@link
   * #uploadBatchJobOperations(Iterable, String)}
   * instead.
   *
   * If {@code isLastRequest}, then after this method returns successfully, the job will
   * transition to the {@code ACTIVE} state.
   *
   * @param operations the operations to upload to the batch job
   * @param isLastRequest if this is the last set of operations to upload for the job
   * @param batchJobUploadStatus the current upload status. If this is the first upload,
   * set the {@link BatchJobUploadStatus#getResumableUploadUri()} to the {@code
   * BatchJob#getUploadUrl()}.
   * @return the response from the upload if the request succeeded
   * @throws BatchJobException if the request failed
   */
  @UsesAdsUtilities({AdsUtility.BATCH_JOB_HELPER})
  BatchJobUploadResponse uploadIncrementalBatchJobOperations(
      Iterable operations, boolean isLastRequest,
      BatchJobUploadStatus batchJobUploadStatus) throws BatchJobException;

  /**
   * Downloads and returns the results from the attempted operations for a completed batch job.
   *
   * @param downloadUrl the {@code BatchJob.getDownloadUrl()}
   */
  @UsesAdsUtilities({AdsUtility.BATCH_JOB_HELPER})
  ResponseT downloadBatchJobMutateResponse(String downloadUrl) throws BatchJobException;
}