ChatAppLogEntry
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
מטען ייעודי (payload) של JSON של הודעות שגיאה. אם Cloud Logging API מופעל, הודעות השגיאה האלה מתועדות ביומן ב-Google Cloud Logging.
| ייצוג ב-JSON |
{
"deployment": string,
"error": {
object (Status)
},
"deploymentFunction": string
} |
| שדות |
deployment |
string
הפריסה שגרמה לשגיאה. באפליקציות ל-Chat שנוצרו ב-Apps Script, זהו מזהה הפריסה שהוגדר על ידי Apps Script.
|
error |
object (Status)
קוד השגיאה וההודעה.
|
deploymentFunction |
string
שם callback_method ללא הצפנה שהיה פועל כשנתקלתם בשגיאה.
|
סטטוס
הסוג Status מגדיר מודל שגיאה לוגי שמתאים לסביבות תכנות שונות, כולל ממשקי API ל-REST וממשקי API ל-RPC. הוא משמש את gRPC. כל הודעה מסוג Status מכילה שלושה נתונים: קוד שגיאה, הודעת שגיאה ופרטי השגיאה.
מידע נוסף על מודל השגיאות הזה ועל אופן העבודה איתו זמין במדריך לעיצוב API.
| ייצוג ב-JSON |
{
"code": integer,
"message": string,
"details": [
{
"@type": string,
field1: ...,
...
}
]
} |
| שדות |
code |
integer
קוד הסטטוס, שצריך להיות ערך enum של google.rpc.Code.
|
message |
string
הודעת שגיאה למפתחים, שצריכה להיות באנגלית. כל הודעת שגיאה שמוצגת למשתמש צריכה להיות מותאמת לשוק המקומי ונשלחת בשדה google.rpc.Status.details, או שמותאמת על ידי הלקוח.
|
details[] |
object
רשימה של הודעות שמכילות את פרטי השגיאה. יש קבוצה משותפת של סוגי הודעות שאפשר להשתמש בהם בממשקי API.
|
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[[["\u003cp\u003eChat app error messages are logged to Google Cloud Logging if the API is enabled, providing details on the deployment, error, and function involved.\u003c/p\u003e\n"],["\u003cp\u003eError messages utilize a standardized \u003ccode\u003eStatus\u003c/code\u003e format, including an error code, message, and optional details for comprehensive debugging.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eStatus\u003c/code\u003e format aligns with gRPC and Google API Design Guide principles for consistent error handling across different programming environments.\u003c/p\u003e\n"]]],["Error messages are logged to Google Cloud Logging when the Cloud Logging API is enabled. Errors are represented in JSON with a deployment string, an error object (containing code, message, and details), and the deployment function name. The `Status` type defines the error model, including an integer `code`, a string `message`, and an array `details` for additional context. The `code` indicates the type of error, while the `message` provides a developer-facing explanation. The details array provides context about the error.\n"],null,["# ChatAppLogEntry\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [Status](#Status)\n - [JSON representation](#Status.SCHEMA_REPRESENTATION)\n\nJSON payload of error messages. If the Cloud Logging API is enabled, these error messages are logged to [Google Cloud Logging](https://cloud.google.com/logging/docs).\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"deployment\": string, \"error\": { object (/workspace/chat/api/reference/rest/v1/ChatAppLogEntry#Status) }, \"deploymentFunction\": string } ``` |\n\n| Fields ||\n|----------------------|--------------------------------------------------------------------------------------------------------------------------------------|\n| `deployment` | `string` The deployment that caused the error. For Chat apps built in Apps Script, this is the deployment ID defined by Apps Script. |\n| `error` | `object (`[Status](/workspace/chat/api/reference/rest/v1/ChatAppLogEntry#Status)`)` The error code and message. |\n| `deploymentFunction` | `string` The unencrypted `callback_method` name that was running when the error was encountered. |\n\nStatus\n------\n\nThe `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](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------|\n| ``` { \"code\": integer, \"message\": string, \"details\": [ { \"@type\": string, field1: ..., ... } ] } ``` |\n\n| Fields ||\n|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `code` | `integer` The status code, which should be an enum value of [google.rpc.Code](/workspace/chat/api/reference/rest/v1/spaces.messages#Message.Code). |\n| `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](/workspace/chat/api/reference/rest/v1/ChatAppLogEntry#Status.FIELDS.details) field, or localized by the client. |\n| `details[]` | `object` A list of messages that carry the error details. There is a common set of message types for APIs to use. |"]]
