Method: customers.batchJobs.mutate

Mutates a batch job.

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

HTTP request

POST https://googleads.googleapis.com/v13/customers/{customerId}/batchJobs:mutate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer for which to create a batch job.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "operation": {
    object (BatchJobOperation)
  }
}
Fields
operation

object (BatchJobOperation)

Required. The operation to perform on an individual batch job.

Response body

Response message for BatchJobService.MutateBatchJob.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "result": {
    object (MutateBatchJobResult)
  }
}
Fields
result

object (MutateBatchJobResult)

The result for the mutate.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

BatchJobOperation

A single operation on a batch job.

JSON representation 
{

  // Union field operation can be only one of the following:
  "create": {
    object (BatchJob)
  },
  "remove": string
  // End of list of possible types for union field operation.
}
Fields
Union field operation. The mutate operation. operation can be only one of the following:
create

object (BatchJob)

Create operation: No resource name is expected for the new batch job.
remove

string

Remove operation: The batch job must not have been run. A resource name for the removed batch job is expected, in this format:

customers/{customerId}/batchJobs/{batch_job_id}

MutateBatchJobResult

The result for the batch job mutate.

JSON representation 
{
  "resourceName": string
}
Fields
resourceName

string

The resource name of the batch job.