BadRequest

อธิบายการละเมิดในคำขอของไคลเอ็นต์ ข้อผิดพลาดประเภทนี้มุ่งเน้นที่ด้านไวยากรณ์ของคำขอ

การแสดง JSON 
{
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}
ช่อง
fieldViolations[]

object (FieldViolation)

อธิบายการละเมิดทั้งหมดในคำขอของไคลเอ็นต์

FieldViolation

ประเภทข้อความที่ใช้เพื่ออธิบายฟิลด์คำขอที่ไม่ถูกต้องรายการเดียว

การแสดง JSON 
{
  "field": string,
  "description": string,
  "reason": string,
  "localizedMessage": {
    object (LocalizedMessage)
  }
}
ช่อง
field

string

เส้นทางที่นำไปยังฟิลด์ในเนื้อหาคำขอ ค่าจะเป็นลำดับของตัวระบุที่คั่นด้วยจุดซึ่งระบุฟิลด์ Protocol Buffer

ลองพิจารณาสิ่งเหล่านี้

message CreateContactRequest {
  message EmailAddress {
    enum Type {
      TYPE_UNSPECIFIED = 0;
      HOME = 1;
      WORK = 2;
    }

    optional string email = 1;
    repeated EmailType type = 2;
  }

  string fullName = 1;
  repeated EmailAddress email_addresses = 2;
}

ในตัวอย่างนี้ field ใน Proto อาจมีค่าใดค่าหนึ่งต่อไปนี้

  • fullName สำหรับการละเมิดในค่า fullName
  • email_addresses[1].email สำหรับการละเมิดในฟิลด์ email ของข้อความ email_addresses แรก
  • email_addresses[3].type[2] สำหรับการละเมิดในค่า type ที่สองในข้อความ email_addresses ที่สาม

ใน JSON ค่าเดียวกันจะแสดงเป็น

  • fullName สำหรับการละเมิดในค่า fullName
  • emailAddresses[1].email สำหรับการละเมิดในฟิลด์ email ของข้อความ emailAddresses แรก
  • emailAddresses[3].type[2] สำหรับการละเมิดในค่า type ที่สองในข้อความ emailAddresses ที่สาม
description

string

คำอธิบายว่าเหตุใดองค์ประกอบคำขอจึงไม่ถูกต้อง
reason

string

เหตุผลของข้อผิดพลาดระดับฟิลด์ นี่คือค่าคงที่ที่ระบุสาเหตุที่ใกล้ที่สุดของข้อผิดพลาดระดับฟิลด์ โดยควรระบุประเภท FieldViolation ภายในขอบเขตของ google.rpc.ErrorInfo.domain โดยไม่ซ้ำกัน ควรมีอักขระไม่เกิน 63 ตัวและตรงกับนิพจน์ทั่วไปของ [A-Z][A-Z0-9_]+[A-Z0-9] ซึ่งแสดงถึง UPPER_SNAKE_CASE
localizedMessage

object (LocalizedMessage)

แสดงข้อความแสดงข้อผิดพลาดที่แปลเป็นภาษาท้องถิ่นสำหรับข้อผิดพลาดระดับฟิลด์ซึ่งส่งคืนให้ผู้ใช้ API ได้อย่างปลอดภัย

LocalizedMessage

แสดงข้อความแสดงข้อผิดพลาดที่แปลแล้วซึ่งส่งคืนให้ผู้ใช้ได้อย่างปลอดภัยและแนบไปกับข้อผิดพลาด RPC ได้

การแสดง JSON 
{
  "locale": string,
  "message": string
}
ช่อง
locale

string

ภาษาที่ใช้ตามข้อกำหนดที่ระบุไว้ที่ https://www.rfc-editor.org/rfc/bcp/bcp47.txt เช่น "en-US", "fr-CH", "es-MX"
message

string

ข้อความแสดงข้อผิดพลาดที่แปลแล้วในภาษาข้างต้น