AI-generated Key Takeaways
-
Chat app error messages are logged to Google Cloud Logging if the API is enabled, providing details on the deployment, error, and function involved.
-
Error messages utilize a standardized
Status
format, including an error code, message, and optional details for comprehensive debugging. -
The
Status
format aligns with gRPC and Google API Design Guide principles for consistent error handling across different programming environments.
JSON payload of error messages. If the Cloud Logging API is enabled, these error messages are logged to Google Cloud Logging.
JSON representation |
---|
{
"deployment": string,
"error": {
object ( |
Fields | |
---|---|
deployment |
The deployment that caused the error. For Chat apps built in Apps Script, this is the deployment ID defined by Apps Script. |
error |
The error code and message. |
deploymentFunction |
The unencrypted |
Status
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.
JSON representation |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Fields | |
---|---|
code |
The status code, which should be an enum value of |
message |
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the |
details[] |
A list of messages that carry the error details. There is a common set of message types for APIs to use. |