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 2025-07-11 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eStatus\u003c/code\u003e type is a logical error model suitable for various programming environments, such as REST and RPC APIs, and is utilized by gRPC.\u003c/p\u003e\n"],["\u003cp\u003eA \u003ccode\u003eStatus\u003c/code\u003e message comprises three data elements: an error code, an error message, and error details.\u003c/p\u003e\n"],["\u003cp\u003eThe JSON representation of a \u003ccode\u003eStatus\u003c/code\u003e object includes fields for \u003ccode\u003ecode\u003c/code\u003e (integer), \u003ccode\u003emessage\u003c/code\u003e (string), and \u003ccode\u003edetails\u003c/code\u003e (an array of objects).\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ecode\u003c/code\u003e field is an integer representing the status code, the \u003ccode\u003emessage\u003c/code\u003e is a developer-facing English string, and \u003ccode\u003edetails\u003c/code\u003e contains an array of error detail objects.\u003c/p\u003e\n"]]],[],null,[]]
