com.google.api.ads.adwords.v201109.cm
Interface MutateJobServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

MutateJobServiceSoapBindingStub

public interface MutateJobServiceInterface
extends Remote

Method Summary

Job[]	get(JobSelector selector) Query the status of existing jobs, both simple and bulk API. Use a JobSelector to query and return a list which may contain both BulkMutateJob and/or SimpleMutateJob.
JobResult	getResult(JobSelector selector) Query mutation results, of a COMPLETED job. Use a JobSelector to query and return either a BulkMutateResult or a SimpleMutateResult.
SimpleMutateJob	mutate(Operation[] operations, BulkMutateJobPolicy policy) Simplified way of submitting a mutation job.

Method Detail

get

Job[] get(JobSelector selector)
          throws RemoteException,
                 ApiException

Query the status of existing jobs, both simple and bulk API.
Use a JobSelector to query and return a list which may contain both BulkMutateJob and/or SimpleMutateJob.

This method will limit the number of returned results to the most recent 100 jobs. You should use a selector which will return a reasonable number of jobs in the result.

Throws:

RemoteException

ApiException

getResult

JobResult getResult(JobSelector selector)
                    throws RemoteException,
                           ApiException

Query mutation results, of a COMPLETED job.
Use a JobSelector to query and return either a BulkMutateResult or a SimpleMutateResult.

Throws:

RemoteException

ApiException

mutate

SimpleMutateJob mutate(Operation[] operations,
                       BulkMutateJobPolicy policy)
                       throws RemoteException,
                              ApiException

Simplified way of submitting a mutation job. The provided list of operations, if valid, will create a new job with a unique id, which will be returned. This id can later be used in invocations of get(com.google.api.ads.adwords.v201109.cm.JobSelector) and getResult(com.google.api.ads.adwords.v201109.cm.JobSelector). policy can optionally be specified.

When this method returns with success, the job will be in PROCESSING or PENDING state and no further action is needed for the job to get executed.
You should not use the returned BulkMutateJobId with bulk API BulkMutateJobService#mutate method.

Throws:

RemoteException

ApiException