Status (Automotive)

הסוג Status מגדיר מודל שגיאות לוגיות שמתאים לסביבות תכנות שונות, כולל ממשקי API ל-REST ו-RPC API. היא משמשת את 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 שבהם אפשר להשתמש.

אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף "@type" מכיל URI המזהה את הסוג. דוגמה: { "id": 1234, "@type": "types.example.com/standard/id" }