BadRequest

Opisuje naruszenia w żądaniu klienta. Ten typ błędu dotyczy aspektów składniowych żądania.

Zapis JSON 
{
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}
Pola
fieldViolations[]

object (FieldViolation)

Opisuje wszystkie naruszenia w żądaniu klienta.

FieldViolation

Typ wiadomości używany do opisywania pojedynczego pola nieprawidłowego żądania.

Zapis JSON 
{
  "field": string,
  "description": string,
  "reason": string,
  "localizedMessage": {
    object (LocalizedMessage)
  }
}
Pola
field

string

Ścieżka prowadząca do pola w treści żądania. Wartość będzie ciągiem identyfikatorów oddzielonych kropkami, które identyfikują pole bufora protokołu.

Weź pod uwagę następujące kwestie:

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;
}

W tym przykładzie w protokole field może przyjąć jedną z tych wartości:

  • fullName za naruszenie zasady dotyczące wartości fullName
  • emailAddresses[0].email w przypadku naruszenia w polu email pierwszej wiadomości emailAddresses.
  • emailAddresses[2].type[1] w przypadku naruszenia w drugiej type wartości w trzeciej emailAddresses wiadomości.

W formacie JSON te same wartości są reprezentowane w ten sposób:

  • fullName za naruszenie zasady dotyczące wartości fullName
  • emailAddresses[0].email w przypadku naruszenia w polu email pierwszej wiadomości emailAddresses.
  • emailAddresses[2].type[1] w przypadku naruszenia w drugiej type wartości w trzeciej emailAddresses wiadomości.
description

string

Opis, dlaczego element żądania jest nieprawidłowy.
reason

string

Przyczyna błędu na poziomie pola. Jest to stała wartość, która określa bezpośrednią przyczynę błędu na poziomie pola. Powinien on jednoznacznie identyfikować typ naruszenia pola w zakresie google.rpc.ErrorInfo.domain. Musi mieć maksymalnie 63 znaki i pasować do wyrażenia regularnego [A-Z][A-Z0-9_]+[A-Z0-9], które reprezentuje format UPPER_SNAKE_CASE.
localizedMessage

object (LocalizedMessage)

Zawiera zlokalizowany komunikat o błędzie na poziomie pola, który można bezpiecznie zwrócić do klienta interfejsu API.

LocalizedMessage

Zawiera zlokalizowany komunikat o błędzie, który można bezpiecznie zwrócić użytkownikowi i który można dołączyć do błędu RPC.

Zapis JSON 
{
  "locale": string,
  "message": string
}
Pola
locale

string

Używany język jest zgodny ze specyfikacją określoną na stronie https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Przykłady: „en-US”, „fr-CH”, „es-MX”
message

string

Zlokalizowany komunikat o błędzie w podanym języku.