BadRequest

Описывает нарушения в запросе клиента. Этот тип ошибки фокусируется на синтаксических аспектах запроса.

JSON-представление 
{
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}
Поля
fieldViolations[]

object ( FieldViolation )

Описывает все нарушения в запросе клиента.

Нарушение правил игры на поле

Тип сообщения, используемый для описания одного некорректного поля запроса.

JSON-представление 
{
  "field": string,
  "description": string,
  "reason": string,
  "localizedMessage": {
    object (LocalizedMessage)
  }
}
Поля
field

string

Путь, ведущий к полю в теле запроса. Значение будет представлять собой последовательность идентификаторов, разделенных точками, которые идентифицируют поле протокола буферизации.

Рассмотрим следующее:

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 в протоколе может принимать одно из следующих значений:

  • 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

Причина ошибки на уровне поля. Это постоянное значение, определяющее непосредственную причину ошибки на уровне поля. Оно должно однозначно идентифицировать тип нарушения поля в рамках области действия google.rpc.ErrorInfo.domain. Длина значения не должна превышать 63 символа, и оно должно соответствовать регулярному выражению [AZ][A-Z0-9_]+[A-Z0-9] , что соответствует регистру UPPER_SNAKE_CASE.

localizedMessage

object ( LocalizedMessage )

Предоставляет локализованное сообщение об ошибке для ошибок на уровне полей, которое можно безопасно вернуть потребителю API.

Локализованное сообщение

Предоставляет локализованное сообщение об ошибке, которое можно безопасно вернуть пользователю и которое может быть прикреплено к ошибке 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

Локализованное сообщение об ошибке в указанной выше языковой версии.