BadRequest

Describe las infracciones en una solicitud del cliente. Este tipo de error se enfoca en los aspectos sintácticos de la solicitud.

Representación JSON
{
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}
Campos
fieldViolations[]

object (FieldViolation)

Describe todos los incumplimientos en una solicitud del cliente.

FieldViolation

Es un tipo de mensaje que se usa para describir un solo campo de solicitud incorrecta.

Representación JSON
{
  "field": string,
  "description": string,
  "reason": string,
  "localizedMessage": {
    object (LocalizedMessage)
  }
}
Campos
field

string

Es una ruta de acceso que lleva a un campo en el cuerpo de la solicitud. El valor será una secuencia de identificadores separados por puntos que identifican un campo de búfer de protocolo.

Ten en cuenta lo siguiente:

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

En este ejemplo, en el proto field podría tomar uno de los siguientes valores:

  • fullName para un incumplimiento en el valor de fullName
  • email_addresses[1].email para un incumplimiento en el campo email del primer mensaje email_addresses
  • email_addresses[3].type[2] por un incumplimiento en el segundo valor de type en el tercer mensaje de email_addresses

En JSON, los mismos valores se representan de la siguiente manera:

  • fullName para un incumplimiento en el valor de fullName
  • emailAddresses[1].email para un incumplimiento en el campo email del primer mensaje emailAddresses
  • emailAddresses[3].type[2] por un incumplimiento en el segundo valor de type en el tercer mensaje de emailAddresses
description

string

Es una descripción del motivo por el que el elemento de la solicitud es incorrecto.

reason

string

Es el motivo del error a nivel del campo. Este es un valor constante que identifica la causa próxima del error a nivel del campo. Debe identificar de forma única el tipo de FieldViolation dentro del alcance de google.rpc.ErrorInfo.domain. Debe tener un máximo de 63 caracteres y coincidir con una expresión regular de [A-Z][A-Z0-9_]+[A-Z0-9], que representa UPPER_SNAKE_CASE.

localizedMessage

object (LocalizedMessage)

Proporciona un mensaje de error localizado para los errores a nivel del campo que se puede devolver de forma segura al consumidor de la API.

LocalizedMessage

Proporciona un mensaje de error localizado que se puede devolver al usuario de forma segura y que se puede adjuntar a un error de RPC.

Representación JSON
{
  "locale": string,
  "message": string
}
Campos
locale

string

Es la configuración regional que se usa según la especificación definida en https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Algunos ejemplos son "en-US", "fr-CH" y "es-MX".

message

string

Es el mensaje de error localizado en la configuración regional anterior.