Errors

  • The content focuses on defining the structure and components of errors returned by a failed batch entry in an API.

  • Errors are represented in JSON format and include details such as a list of errors, an HTTP status code, and an overall error message.

  • Individual errors within the list contain information about the error domain, a specific error code, and a descriptive message.

A list of errors returned by a failed batch entry.

JSON representation 
{
  "errors": [
    {
      object (Error)
    }
  ],
  "code": integer,
  "message": string
}
Fields
errors[]

object (Error)

A list of errors.
code

integer (uint32 format)

The HTTP status of the first error in errors.
message

string

The message of the first error in errors.

Error

An error returned by the API.

JSON representation 
{
  "domain": string,
  "reason": string,
  "message": string
}
Fields
domain

string

The domain of the error.
reason

string

The error code.
message

string

A description of the error.