Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdWords.v201809.BatchJobService Class Reference

Use the More...

Inheritance diagram for Google.Api.Ads.AdWords.v201809.BatchJobService:
Google.Api.Ads.AdWords.v201809.IBatchJobService Google.Api.Ads.AdWords.v201809.BatchJobServiceInterface

Public Member Functions

 BatchJobService ()
 Creates a new instance of the BatchJobService class. More...
 
 BatchJobService (string endpointConfigurationName)
 Creates a new instance of the BatchJobService class. More...
 
 BatchJobService (string endpointConfigurationName, string remoteAddress)
 Creates a new instance of the BatchJobService class. More...
 
 BatchJobService (string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the BatchJobService class. More...
 
 BatchJobService (System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the BatchJobService class. More...
 
virtual
Google.Api.Ads.AdWords.v201809.BatchJobPage 
get (Google.Api.Ads.AdWords.v201809.Selector selector)
 Query the status of existing More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdWords.v201809.BatchJobPage
getAsync (Google.Api.Ads.AdWords.v201809.Selector selector)
 
virtual
Google.Api.Ads.AdWords.v201809.BatchJobReturnValue 
mutate (Google.Api.Ads.AdWords.v201809.BatchJobOperation[] operations)
 Creates or updates a More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdWords.v201809.BatchJobReturnValue
mutateAsync (Google.Api.Ads.AdWords.v201809.BatchJobOperation[] operations)
 
virtual
Google.Api.Ads.AdWords.v201809.BatchJobPage 
query (string query1)
 Returns the list of More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdWords.v201809.BatchJobPage
queryAsync (string query)
 

Detailed Description

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.

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.

Constructor & Destructor Documentation

Google.Api.Ads.AdWords.v201809.BatchJobService.BatchJobService ( )
inline

Creates a new instance of the BatchJobService class.

Google.Api.Ads.AdWords.v201809.BatchJobService.BatchJobService ( string  endpointConfigurationName)
inline

Creates a new instance of the BatchJobService class.

Google.Api.Ads.AdWords.v201809.BatchJobService.BatchJobService ( string  endpointConfigurationName,
string  remoteAddress 
)
inline

Creates a new instance of the BatchJobService class.

Google.Api.Ads.AdWords.v201809.BatchJobService.BatchJobService ( string  endpointConfigurationName,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the BatchJobService class.

Google.Api.Ads.AdWords.v201809.BatchJobService.BatchJobService ( System.ServiceModel.Channels.Binding  binding,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the BatchJobService class.

Member Function Documentation

virtual Google.Api.Ads.AdWords.v201809.BatchJobPage Google.Api.Ads.AdWords.v201809.BatchJobService.get ( Google.Api.Ads.AdWords.v201809.Selector  selector)
inlinevirtual

Query the status of existing

BatchJobs.

Parameters
selectorThe selector specifying the BatchJobs to return.
Returns
The list of selected jobs.

AdWordsApiException

Implements Google.Api.Ads.AdWords.v201809.BatchJobServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdWords.v201809.BatchJobPage> Google.Api.Ads.AdWords.v201809.BatchJobService.getAsync ( Google.Api.Ads.AdWords.v201809.Selector  selector)
inlinevirtual
virtual Google.Api.Ads.AdWords.v201809.BatchJobReturnValue Google.Api.Ads.AdWords.v201809.BatchJobService.mutate ( Google.Api.Ads.AdWords.v201809.BatchJobOperation[]  operations)
inlinevirtual

Creates or updates a

BatchJob.

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

Parameters
operationsA list of operations.
Returns
The list of created or updated jobs.

AdWordsApiException

Implements Google.Api.Ads.AdWords.v201809.IBatchJobService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdWords.v201809.BatchJobReturnValue> Google.Api.Ads.AdWords.v201809.BatchJobService.mutateAsync ( Google.Api.Ads.AdWords.v201809.BatchJobOperation[]  operations)
inlinevirtual
virtual Google.Api.Ads.AdWords.v201809.BatchJobPage Google.Api.Ads.AdWords.v201809.BatchJobService.query ( string  query1)
inlinevirtual

Returns the list of

BatchJobs that match the query.

Parameters
query1The SQL-like AWQL query string.
Returns
The list of selected jobs.
Exceptions
AdWordsApiExceptionif problems occur while parsing the query or fetching batchjob information.

Implements Google.Api.Ads.AdWords.v201809.BatchJobServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdWords.v201809.BatchJobPage> Google.Api.Ads.AdWords.v201809.BatchJobService.queryAsync ( string  query)
inlinevirtual

The documentation for this class was generated from the following file: