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

Represents a large mutation job. More...

Classes

class  Fields
 List of all supported fields for the BatchJob class. More...
 
class  FilterableFields
 List of all supported filterable fields for the BatchJob class. More...
 
class  SelectableFields
 List of all supported selectable fields for the BatchJob class. More...
 

Properties

long id [get, set]
 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 More...
 
bool idSpecified [get, set]
 
BatchJobStatus status [get, set]
 Status of this job. 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. More...
 
bool statusSpecified [get, set]
 
ProgressStats progressStats [get, set]
 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. More...
 
TemporaryUrl uploadUrl [get, set]
 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 More...
 
TemporaryUrl downloadUrl [get, set]
 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 More...
 
BatchJobProcessingError[] processingErrors [get, set]
 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. More...
 
long diskUsageQuotaBalance [get, set]
 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 More...
 
bool diskUsageQuotaBalanceSpecified [get, set]
 

Detailed Description

Represents a large mutation job.

Property Documentation

long Google.Api.Ads.AdWords.v201809.BatchJob.diskUsageQuotaBalance
getset

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

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

bool Google.Api.Ads.AdWords.v201809.BatchJob.diskUsageQuotaBalanceSpecified
getset

true, if a value is specified for diskUsageQuotaBalance, false otherwise.

TemporaryUrl Google.Api.Ads.AdWords.v201809.BatchJob.downloadUrl
getset

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.

Referenced by Google.Api.Ads.AdWords.Examples.CSharp.v201809.AddKeywordsUsingIncrementalBatchJob.Run().

long Google.Api.Ads.AdWords.v201809.BatchJob.id
getset

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.

bool Google.Api.Ads.AdWords.v201809.BatchJob.idSpecified
getset

true, if a value is specified for id, false otherwise.

BatchJobProcessingError [] Google.Api.Ads.AdWords.v201809.BatchJob.processingErrors
getset

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.

Referenced by Google.Api.Ads.AdWords.Examples.CSharp.v201809.AddKeywordsUsingIncrementalBatchJob.Run().

ProgressStats Google.Api.Ads.AdWords.v201809.BatchJob.progressStats
getset

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.

BatchJobStatus Google.Api.Ads.AdWords.v201809.BatchJob.status
getset

Status of this job. 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.

bool Google.Api.Ads.AdWords.v201809.BatchJob.statusSpecified
getset

true, if a value is specified for status, false otherwise.

TemporaryUrl Google.Api.Ads.AdWords.v201809.BatchJob.uploadUrl
getset

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

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 . 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.


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