The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.
You can find out more about this error model and how to work with it in the API Design Guide.
The status code, which should be an enum value of google.rpc.Code.
message
string
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
details[]
object
A list of messages that carry the error details. There is a common set of message types for APIs to use.
An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-02 UTC."],[[["The `Status` type is a logical error model suitable for various programming environments, such as REST and RPC APIs, and is used by gRPC."],["A `Status` message includes an error code, a developer-facing error message in English, and error details."],["The `code` field in the JSON representation of `Status` is an integer representing an enum value of `google.rpc.Code`."],["The `details` field in `Status` is a list of messages carrying error details, with an \"@type\" field to identify the type."],["The JSON representation of the `Status` type is in the format of `{\"code\": integer, \"message\": string, \"details\": [ { \"@type\": string, field1: ..., ... } ]}`."]]],[]]