type BatchJob (v201710)

Represents a large mutation job.


Namespace
https://adwords.google.com/api/adwords/cm/v201710

Field

id

xsd:long

ID of this job.

This field can be selected using the value "Id".
This field can be filtered on.
This field is read only and will be ignored when sent to the API for the following Operators: ADD.
This field is required and should not be null when it is contained within Operators : SET.

status

BatchJobStatus

Status of this job.


Enumerations
UNKNOWN
AWAITING_FILE
Initial state of a BatchJob. While a job has this status, it is awaiting a file upload to Google Cloud Storage.
ACTIVE
Indicates that a job has an associated file and is being executed.
CANCELING
Indicates that a job is being canceled. It will remain in this status until any partial results are written, and then will be marked CANCELED. Send this status in a SET operation to cancel a job that is in progress. This is the only status that can be explicitly set.
CANCELED
Indicates that a job has been canceled. It will be garbage-collected 30 days after cancellation.
DONE
Indicates that a job has completed. It will be garbage-collected 30 days after completion.

This field can be selected using the value "Status".
This field is read only and will be ignored when sent to the API for the following Operators: ADD.

progressStats

ProgressStats

Statistics related to the progress of this job.

This field can be selected using the value "ProgressStats".
This field is read only and will be ignored when sent to the API.

uploadUrl

TemporaryUrl

The URL to use in upload operations for this job. The URL is unique to this job and will expire one week after the job was created. This field is only returned when calling BatchJobService.mutate with an ADD operation.

To upload a file, make a POST request to uploadUrl and retrieve the "Location" header from the response as the URL to upload operations. For the set of supported operations, look up https://adwords.google.com/api/adwords/cm/xsd/<version>/BatchJobOps.xsd. For more information about how to upload files, see https://cloud.google.com/storage/docs/json_api/v1/how-tos/upload.

This field is read only and will be ignored when sent to the API.

downloadUrl

TemporaryUrl

The URL to use to download results for this job. Results will be available for 30 days after job completion. This field is only returned once status is either DONE or CANCELED.

This field can be selected using the value "DownloadUrl".
This field is read only and will be ignored when sent to the API.

processingErrors

BatchJobProcessingError[]

A list of any errors that occurred during processing, not related to specific input operations, e.g. input file corruption errors.

This field can be selected using the value "ProcessingErrors".
This field is read only and will be ignored when sent to the API.

diskUsageQuotaBalance

xsd:long

Disk quota balance of the batch job's customer in KB, which is the limit of batch job disk usage for the customer. The field is only returned when calling BatchJobService.mutate with an ADD operation.

This field is read only and will be ignored when sent to the API.

Send feedback about...

AdWords API
AdWords API
Need help? Visit our support page.