Register for one of our Google Ads API Migration Workshops (October 5, 2021 - October 14, 2021)

BatchJobService

Service to manage batch jobs.

AddBatchJobOperations

rpc AddBatchJobOperations(AddBatchJobOperationsRequest) returns (AddBatchJobOperationsResponse)

Add operations to the batch job.

List of thrown errors: AuthenticationError AuthorizationError BatchJobError HeaderError InternalError QuotaError RequestError ResourceCountLimitExceededError

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

GetBatchJob

rpc GetBatchJob(GetBatchJobRequest) returns (BatchJob)

Returns the batch job.

List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

ListBatchJobResults

rpc ListBatchJobResults(ListBatchJobResultsRequest) returns (ListBatchJobResultsResponse)

Returns the results of the batch job. The job must be done. Supports standard list paging.

List of thrown errors: AuthenticationError AuthorizationError BatchJobError HeaderError InternalError QuotaError RequestError

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

MutateBatchJob

rpc MutateBatchJob(MutateBatchJobRequest) returns (MutateBatchJobResponse)

Mutates a batch job.

List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError ResourceCountLimitExceededError

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

RunBatchJob

rpc RunBatchJob(RunBatchJobRequest) returns (Operation)

Runs the batch job.

The Operation.metadata field type is BatchJobMetadata. When finished, the long running operation will not contain errors or a response. Instead, use ListBatchJobResults to get the results of the job.

List of thrown errors: AuthenticationError AuthorizationError BatchJobError HeaderError InternalError QuotaError RequestError

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.