Status

يحدد النوع Status نموذج خطأ منطقي مناسبًا لبيئات البرمجة المختلفة، بما في ذلك واجهات برمجة تطبيقات REST وواجهات برمجة التطبيقات RPC. ويتم استخدامها من قِبل gRPC. تحتوي كل رسالة Status على ثلاث بيانات: رمز الخطأ ورسالة الخطأ وتفاصيل الخطأ.

يمكنك معرفة المزيد حول نموذج الخطأ هذا وكيفية التعامل معه في دليل تصميم واجهة برمجة التطبيقات.

تمثيل JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
الحقول
code

integer

تمثّل هذه السمة رمز الحالة، ويجب أن تكون قيمة التعداد google.rpc.Code.
message

string

رسالة خطأ موجَّهة للمطوِّر، يجب أن تكون باللغة الإنجليزية. يجب ترجمة أي رسالة خطأ موجَّهة للمستخدمين وإرسالها في الحقل google.rpc.Status.details، أو يجب أن يترجمها البرنامج.
details[]

object

قائمة بالرسائل التي تحتوي على تفاصيل الخطأ. تتوفّر مجموعة شائعة من أنواع الرسائل التي يمكن أن تستخدمها واجهات برمجة التطبيقات.

يشير ذلك المصطلح إلى كائن يحتوي على حقول من نوع عشوائي. يحتوي الحقل الإضافي "@type" على معرّف URI يحدّد النوع. مثال: { "id": 1234, "@type": "types.example.com/standard/id" }