BadRequest

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

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

object (FieldViolation)

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

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[0].email за нарушение в поле email первого сообщения email_addresses
  • email_addresses[2].type[1] за нарушение во втором type и значение в третьем сообщении email_addresses.

В JSON те же значения будут представлены следующим образом:

  • fullName за нарушение в значении fullName
  • emailAddresses[0].email за нарушение в поле email первого сообщения emailAddresses
  • emailAddresses[2].type[1] за нарушение во втором 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

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