התכונה 'פעולות שיחה' הוצאה משימוש ב-13 ביוני 2023.
כאן תוכלו לקרוא מידע נוסף על ההוצאה משימוש של 'פעולות שיחה'.
Package google.rpc
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
סטטוס
הסוג Status מגדיר מודל שגיאה לוגית שמתאים לסביבות תכנות שונות, כולל ממשקי REST API ו-RPC API. הוא משמש את gRPC. מודל השגיאה אמור להיות:
- קל לשימוש ומובן לרוב המשתמשים
- גמישים מספיק כדי לענות על צרכים בלתי צפויים
סקירה כללית
ההודעה Status מכילה שלושה קטעי נתונים: קוד שגיאה, הודעת שגיאה ופרטי שגיאה. קוד השגיאה צריך להיות ערך 'טיפוסים בני מנייה (enum)' google.rpc.Code, אבל ייתכן שניתן יהיה לקבל קודי שגיאה נוספים במקרה הצורך. הודעת השגיאה צריכה להיות הודעה באנגלית למפתחים, שעוזרת למפתחים understand וunderstand את השגיאה. אם יש צורך בהודעת שגיאה מותאמת לשוק המקומי של המשתמש, מוסיפים את ההודעה המותאמת לשוק המקומי בפרטי השגיאה או מבצעים לה לוקליזציה בלקוח. הפרטים האופציונליים של השגיאה עשויים להכיל מידע שרירותי לגבי השגיאה. יש קבוצה מוגדרת מראש של סוגי פרטי שגיאות בחבילה google.rpc, שניתן להשתמש בהם לתנאי שגיאה נפוצים.
מיפוי שפות
ההודעה Status היא הייצוג הלוגי של מודל השגיאה, אבל היא לא בהכרח הפורמט של הכבל בפועל. כשההודעה Status נחשפת בספריות לקוח שונות ובפרוטוקולים שונים של כבלים, ניתן למפות אותה באופן שונה. לדוגמה, סביר להניח שהוא ימופה לחריגים מסוימים ב-Java, אך סביר יותר שהוא ימופה לקודי שגיאה מסוימים ב-C.
שימושים אחרים
אפשר להשתמש במודל השגיאה ובהודעה Status במגוון סביבות – עם ממשקי API וגם בלעדיהם, כדי לספק חוויית פיתוח עקבית בסביבות שונות.
דוגמאות לשימושים במודל השגיאה הזה:
שגיאות חלקיות. אם שירות צריך להחזיר שגיאות חלקיות ללקוח, הוא עשוי להטמיע את Status בתגובה הרגילה כדי לציין את השגיאות החלקיות.
שגיאות בתהליך העבודה. תהליך עבודה טיפוסי כולל כמה שלבים. בכל שלב עשויה להופיע הודעת Status לדיווח על שגיאות.
פעולות אצווה. אם לקוח משתמש בבקשה באצווה ובתגובה באצווה, יש להשתמש בהודעה Status ישירות בתוך תגובת אצווה, אחת לכל תגובת משנה לשגיאה.
פעולות אסינכרוניות. אם קריאה ל-API מטמיעה פעולה אסינכרונית בתגובה שלה, יש לייצג את הסטטוס של הפעולות האלה ישירות באמצעות ההודעה Status.
רישום ביומן. אם חלק משגיאות ה-API מאוחסנות ביומנים, ניתן יהיה להשתמש בהודעה Status ישירות לאחר כל הסרה הנחוצה מטעמי אבטחה או פרטיות.
| שדות |
code |
int32
קוד הסטטוס, שצריך להיות ערך 'טיפוסים בני מנייה (enum)' google.rpc.Code.
|
message |
string
הודעת שגיאה למפתחים, שאמורה להיות באנגלית. כל הודעת שגיאה שמוצגת למשתמש צריכה להיות מותאמת לשוק המקומי ולשלוח אותה בשדה google.rpc.Status.details, או לתרגם אותה על ידי הלקוח.
|
details[] |
Any
רשימת ההודעות עם פרטי השגיאה. יש קבוצה משותפת של סוגי הודעות שבהם אפשר להשתמש בממשקי API.
|
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-26 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-26 (שעון UTC)."],[[["\u003cp\u003eThe \u003ccode\u003eStatus\u003c/code\u003e type defines a consistent and flexible error model suitable for various programming environments, including REST APIs and RPC APIs.\u003c/p\u003e\n"],["\u003cp\u003eIt provides three key pieces of information: an error code using \u003ccode\u003egoogle.rpc.Code\u003c/code\u003e, a developer-facing English error message, and optional error details for context.\u003c/p\u003e\n"],["\u003cp\u003eWhile logically represented by the \u003ccode\u003eStatus\u003c/code\u003e message, its actual implementation may vary across languages and wire protocols.\u003c/p\u003e\n"],["\u003cp\u003eThis error model can be utilized in diverse scenarios beyond APIs to ensure a uniform developer experience, including partial errors, workflow errors, batch operations, and asynchronous operations.\u003c/p\u003e\n"]]],["The `Status` message defines an error model with three data pieces: `code`, `message`, and `details`. The `code` is an error code, `message` is a developer-facing English error message, and `details` contains additional error information. This model can be used for partial, workflow, batch, and asynchronous operations and in logging. It is designed for simplicity and flexibility and is adaptable across different programming environments and API types, with a mapping system that can change based on implementation.\n"],null,["# Package google.rpc\n\nIndex\n-----\n\n- [Status](/assistant/sdk/reference/rpc/google.rpc#google.rpc.Status) (message)\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). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n#### Overview\n\nThe `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of `google.rpc.Code`, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions.\n\n#### Language mapping\n\nThe `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.\n\n#### Other uses\n\nThe error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.\n\n| Fields ||\n|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `code` | `int32` The status code, which should be an enum value of `google.rpc.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](/assistant/sdk/reference/rpc/google.rpc#google.rpc.Status.FIELDS.repeated.google.protobuf.Any.google.rpc.Status.details) field, or localized by the client. |\n| `details[]` | [Any](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Any) A list of messages that carry the error details. There is a common set of message types for APIs to use. |"]]
