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 emailAddresses = 2;
}

בדוגמה הזו, ב-proto,‏ field יכול לקבל אחד מהערכים הבאים:

  • ‫fullName על הפרה בערך fullName
  • ‫emailAddresses[0].email עבור הפרה בשדה email של ההודעה הראשונה emailAddresses
  • ‫emailAddresses[2].type[1] עבור הפרה בהודעה השנייה type ערך בהודעה השלישית emailAddresses.

ב-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

הודעת השגיאה שהותאמה לשוק המקומי בלוקאל שלמעלה.