BadRequest

Menjelaskan pelanggaran dalam permintaan klien. Jenis error ini berfokus pada aspek sintaksis permintaan.

Representasi JSON 
{
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}
Kolom
fieldViolations[]

object (FieldViolation)

Menjelaskan semua pelanggaran dalam permintaan klien.

FieldViolation

Jenis pesan yang digunakan untuk mendeskripsikan satu kolom permintaan buruk.

Representasi JSON 
{
  "field": string,
  "description": string,
  "reason": string,
  "localizedMessage": {
    object (LocalizedMessage)
  }
}
Kolom
field

string

Jalur yang mengarah ke kolom dalam isi permintaan. Nilainya akan berupa urutan ID yang dipisahkan dengan titik yang mengidentifikasi kolom buffer protokol.

Pertimbangkan hal berikut:

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 emailAddresses = 2;
}

Dalam contoh ini, di proto field dapat mengambil salah satu nilai berikut:

  • fullName untuk pelanggaran pada nilai fullName
  • emailAddresses[0].email untuk pelanggaran di kolom email pada pesan emailAddresses pertama
  • emailAddresses[2].type[1] untuk pelanggaran pada nilai type kedua dalam pesan emailAddresses ketiga.

Dalam JSON, nilai yang sama direpresentasikan sebagai:

  • fullName untuk pelanggaran pada nilai fullName
  • emailAddresses[0].email untuk pelanggaran di kolom email pada pesan emailAddresses pertama
  • emailAddresses[2].type[1] untuk pelanggaran pada nilai type kedua dalam pesan emailAddresses ketiga.
description

string

Deskripsi alasan elemen permintaan buruk.
reason

string

Alasan error tingkat kolom. Ini adalah nilai konstan yang mengidentifikasi penyebab langsung error tingkat kolom. Error ini harus mengidentifikasi jenis FieldViolation secara unik dalam cakupan google.rpc.ErrorInfo.domain. Panjangnya maksimal 63 karakter dan cocok dengan ekspresi reguler [A-Z][A-Z0-9_]+[A-Z0-9], yang merepresentasikan UPPER_SNAKE_CASE.
localizedMessage

object (LocalizedMessage)

Menyediakan pesan error yang dilokalkan untuk error tingkat kolom yang aman untuk ditampilkan kepada konsumen API.

LocalizedMessage

Memberikan pesan error yang dilokalkan dan aman untuk ditampilkan kepada pengguna yang dapat dilampirkan ke error RPC.

Representasi JSON 
{
  "locale": string,
  "message": string
}
Kolom
locale

string

Lokalitas yang digunakan mengikuti spesifikasi yang ditentukan di https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Contohnya adalah: "en-US", "fr-CH", "es-MX"
message

string

Pesan error yang dilokalkan dalam lokalitas di atas.