Status

ประเภท Status กําหนดรูปแบบข้อผิดพลาดทางตรรกะที่เหมาะสมสําหรับสภาพแวดล้อมการเขียนโปรแกรมแบบต่างๆ ซึ่งรวมถึง REST API และ RPC API ใช้โดย gRPC ข้อความ Status แต่ละข้อความมีข้อมูล 3 ส่วน ได้แก่ รหัสข้อผิดพลาด ข้อความแสดงข้อผิดพลาด และรายละเอียดข้อผิดพลาด

คุณสามารถดูข้อมูลเพิ่มเติมเกี่ยวกับรูปแบบข้อผิดพลาดนี้และวิธีใช้งานได้ในคู่มือการออกแบบ 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" }