Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

Method: customers.batchJobs.listResults

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

HTTP request

GET https://googleads.googleapis.com/v8/{resourceName=customers/*/batchJobs/*}:listResults

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
resourceName

string

Required. The resource name of the batch job whose results are being listed.

Query parameters

Parameters
pageToken

string

Token of the page to retrieve. If not specified, the first page of results will be returned. Use the value obtained from nextPageToken in the previous response in order to request the next page of results.

pageSize

integer

Number of elements to retrieve in a single page. When a page request is too large, the server may decide to further limit the number of returned resources.

responseContentType

enum (ResponseContentType)

The response content type setting. Determines whether the mutable resource or just the resource name should be returned.

Request body

The request body must be empty.

Response body

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

Response message for BatchJobService.ListBatchJobResults.

JSON representation
{
  "results": [
    {
      object (BatchJobResult)
    }
  ],
  "nextPageToken": string
}
Fields
results[]

object (BatchJobResult)

The list of rows that matched the query.

nextPageToken

string

Pagination token used to retrieve the next page of results. Pass the content of this string as the pageToken attribute of the next request. nextPageToken is not returned for the last page.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

BatchJobResult

An individual batch job result.

JSON representation
{
  "operationIndex": string,
  "mutateOperationResponse": {
    object (MutateOperationResponse)
  },
  "status": {
    object (Status)
  }
}
Fields
operationIndex

string (int64 format)

Index of the mutate operation.

mutateOperationResponse

object (MutateOperationResponse)

Response for the mutate. May be empty if errors occurred.

status

object (Status)

Details of the errors when processing the operation.