BadRequest

Beschreibt Verstöße in einer Clientanfrage. Bei diesem Fehlertyp geht es um die syntaktischen Aspekte der Anfrage.

JSON-Darstellung 
{
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}
Felder
fieldViolations[]

object (FieldViolation)

Beschreibt alle Verstöße in einer Clientanfrage.

FieldViolation

Ein Nachrichtentyp, der verwendet wird, um ein einzelnes Feld mit ungültiger Anfrage zu beschreiben.

JSON-Darstellung 
{
  "field": string,
  "description": string,
  "reason": string,
  "localizedMessage": {
    object (LocalizedMessage)
  }
}
Felder
field

string

Ein Pfad, der zu einem Feld im Anfragetext führt. Der Wert ist eine Abfolge von durch Punkten getrennten Kennungen, die ein Protokollpufferfeld angeben.

Hier einige Tipps:

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

In diesem Beispiel kann field im Proto einen der folgenden Werte haben:

  • fullName für einen Verstoß im fullName-Wert
  • email_addresses[1].email für einen Verstoß im Feld email der ersten email_addresses-Nachricht
  • email_addresses[3].type[2] für einen Verstoß im zweiten type-Wert in der dritten email_addresses-Nachricht.

In JSON werden dieselben Werte so dargestellt:

  • fullName für einen Verstoß im fullName-Wert
  • emailAddresses[1].email für einen Verstoß im Feld email der ersten emailAddresses-Nachricht
  • emailAddresses[3].type[2] für einen Verstoß im zweiten type-Wert in der dritten emailAddresses-Nachricht.
description

string

Eine Beschreibung, warum das Anfrageelement schlecht ist.
reason

string

Der Grund für den Fehler auf Feldebene. Dies ist ein konstanter Wert, der die unmittelbare Ursache des Fehlers auf Feldebene angibt. Sie sollte den Typ des FieldViolation innerhalb des Bereichs von google.rpc.ErrorInfo.domain eindeutig identifizieren. Diese darf höchstens 63 Zeichen umfassen und mit dem regulären Ausdruck [A-Z][A-Z0-9_]+[A-Z0-9] für UPPER_SNAKE_CASE übereinstimmen.
localizedMessage

object (LocalizedMessage)

Stellt eine lokalisierte Fehlermeldung für Fehler auf Feldebene bereit, die sicher an den API-Nutzer zurückgegeben werden kann.

LocalizedMessage

Stellt eine lokalisierte Fehlermeldung bereit, die sicher an den Nutzer zurückgegeben werden kann und an einen RPC-Fehler angehängt werden kann.

JSON-Darstellung 
{
  "locale": string,
  "message": string
}
Felder
locale

string

Das verwendete Gebietsschema gemäß der Spezifikation unter https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Beispiele: „en-US“, „fr-CH“, „es-MX“
message

string

Die übersetzte Fehlermeldung in der Sprache oben.