com.google.api.ads.adwords.jaxws.v201809.cm

Interface BatchJobServiceInterface

public interface BatchJobServiceInterface

Use the BatchJobService to schedule large batches of updates to your AdWords campaigns as asynchronous mutate jobs, and to retrieve the status, results or statistics of your recent jobs.

Use this service when you wish to release your application from actively waiting on a synchronous response. Your application can do other things or even shutdown while we execute mutations asynchronously.

Once a job has been submitted, you may check its status periodically, by calling get(com.google.api.ads.adwords.jaxws.v201809.cm.Selector).

Caution: Do not poll the job status too frequently or you will risk getting your customer rate-limited.

Once a job's status changes to DONE, you can retrieve the job's results. This class was generated by the JAX-WS RI. JAX-WS RI 2.2.9-b130926.1035 Generated source version: 2.1

Method Summary

Modifier and Type	Method and Description
BatchJobPage	get(Selector selector) Query the status of existing BatchJobs.
BatchJobReturnValue	mutate(List<BatchJobOperation> operations) Creates or updates a BatchJob.
BatchJobPage	query(String query) Returns the list of BatchJobs that match the query.

Method Detail

get

@RequestWrapper(localName="get",
                targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.cm.BatchJobServiceInterfaceget")
 @ResponseWrapper(localName="getResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.cm.BatchJobServiceInterfacegetResponse")
BatchJobPage get(Selector selector)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws ApiException_Exception

Query the status of existing BatchJobs.

Parameters:

selector - The selector specifying the BatchJobs to return.

selector -

Returns:

The list of selected jobs.

Throws:

ApiException

ApiException_Exception

mutate

@RequestWrapper(localName="mutate",
                targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.cm.BatchJobServiceInterfacemutate")
 @ResponseWrapper(localName="mutateResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.cm.BatchJobServiceInterfacemutateResponse")
BatchJobReturnValue mutate(List<BatchJobOperation> operations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throws ApiException_Exception

Creates or updates a BatchJob.

Note: BatchJobOperation does not support the REMOVE operator. It is not necessary to remove BatchJobs.

Parameters:

operations - A list of operations.

operations -

Returns:

The list of created or updated jobs.

Throws:

ApiException

ApiException_Exception

query

@RequestWrapper(localName="query",
                targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.cm.BatchJobServiceInterfacequery")
 @ResponseWrapper(localName="queryResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.cm.BatchJobServiceInterfacequeryResponse")
BatchJobPage query(String query)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              throws ApiException_Exception

Returns the list of BatchJobs that match the query.

Parameters:

query - The SQL-like AWQL query string.

query -

Returns:

The list of selected jobs.

Throws:

ApiException - if problems occur while parsing the query or fetching batchjob information.

ApiException_Exception