ChatAppLogEntry
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
بار JSON از پیام های خطا. اگر Cloud Logging API فعال باشد، این پیامهای خطا در Google Cloud Logging ثبت میشوند.
نمایندگی JSON |
---|
{
"deployment": string,
"error": {
object (Status )
},
"deploymentFunction": string
} |
فیلدها |
---|
deployment | string استقرار که باعث خطا شد. برای برنامههای چت ساخته شده در Apps Script، این شناسه استقرار تعریف شده توسط Apps Script است. |
error | object ( Status ) کد خطا و پیام |
deploymentFunction | string نام callback_method رمزگذاری نشده ای که در هنگام بروز خطا در حال اجرا بود. |
وضعیت
نوع Status
یک مدل خطای منطقی را تعریف می کند که برای محیط های برنامه نویسی مختلف، از جمله REST API و RPC API مناسب است. توسط gRPC استفاده می شود. هر پیام Status
شامل سه داده است: کد خطا، پیام خطا و جزئیات خطا.
در راهنمای طراحی API میتوانید درباره این مدل خطا و نحوه کار با آن اطلاعات بیشتری کسب کنید.
نمایندگی JSON |
---|
{
"code": integer,
"message": string,
"details": [
{
"@type": string,
field1: ...,
...
}
]
} |
فیلدها |
---|
code | integer کد وضعیت، که باید مقداری از google.rpc.Code باشد. |
message | string یک پیغام خطای برنامهنویس، که باید به زبان انگلیسی باشد. هر پیام خطای کاربر باید بومی سازی شده و در قسمت google.rpc.Status.details ارسال شود یا توسط مشتری بومی سازی شود. |
details[] | object لیستی از پیام هایی که حاوی جزئیات خطا هستند. مجموعه ای متداول از انواع پیام ها برای استفاده API ها وجود دارد. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[[["\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. |"]]