BadRequest

Décrit les cas de non-respect dans une requête client. Ce type d'erreur se concentre sur les aspects syntaxiques de la requête.

Représentation JSON 
{
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}
Champs
fieldViolations[]

object (FieldViolation)

Décrit toutes les violations dans une requête client.

FieldViolation

Type de message utilisé pour décrire un seul champ de requête incorrect.

Représentation JSON 
{
  "field": string,
  "description": string,
  "reason": string,
  "localizedMessage": {
    object (LocalizedMessage)
  }
}
Champs
field

string

Chemin d'accès à un champ du corps de la requête. La valeur sera une séquence d'identifiants séparés par des points, qui identifient un champ de tampon de protocole.

Réfléchissez aux éléments suivants :

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

Dans cet exemple, dans le fichier proto, field peut prendre l'une des valeurs suivantes :

  • fullName pour un cas de non-respect de la valeur fullName
  • email_addresses[1].email pour non-respect dans le champ email du premier message email_addresses
  • email_addresses[3].type[2] pour un cas de non-respect dans la deuxième valeur type dans le troisième message email_addresses.

En JSON, les mêmes valeurs sont représentées comme suit :

  • fullName pour un cas de non-respect de la valeur fullName
  • emailAddresses[1].email pour un non-respect dans le champ email du premier message emailAddresses
  • emailAddresses[3].type[2] pour un cas de non-respect dans la deuxième valeur type dans le troisième message emailAddresses.
description

string

Description de la raison pour laquelle l'élément de la requête est incorrect.
reason

string

Raison de l'erreur au niveau du champ. Il s'agit d'une valeur constante qui identifie la cause immédiate de l'erreur au niveau du champ. Il doit identifier de manière unique le type de FieldViolation dans le champ d'application de google.rpc.ErrorInfo.domain. Cette valeur ne doit pas comporter plus de 63 caractères et doit correspondre à l'expression régulière [A-Z][A-Z0-9_]+[A-Z0-9], qui représente UPPER_SNAKE_CASE.
localizedMessage

object (LocalizedMessage)

Fournit un message d'erreur localisé pour les erreurs au niveau des champs, qui peut être renvoyé à l'utilisateur de l'API.

LocalizedMessage

Fournit un message d'erreur localisé qui peut être renvoyé à l'utilisateur et qui peut être associé à une erreur RPC.

Représentation JSON 
{
  "locale": string,
  "message": string
}
Champs
locale

string

Paramètres régionaux utilisés conformément à la spécification définie sur https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Exemples : "en-US", "fr-CH", "es-MX"
message

string

Message d'erreur localisé dans les paramètres régionaux ci-dessus.