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 ב-proto יכול להיות אחד מהערכים הבאים:

  • ‫fullName על הפרה של הערך fullName
  • ‫email_addresses[1].email להפרה בשדה email של ההודעה הראשונה email_addresses
  • ‫email_addresses[3].type[2] להפרה בערך השני type במסר השלישי email_addresses.

ב-JSON, אותם ערכים מיוצגים כך:

  • ‫fullName על הפרה של הערך fullName
  • ‫emailAddresses[1].email להפרה בשדה email של ההודעה הראשונה emailAddresses
  • ‫emailAddresses[3].type[2] להפרה בערך השני 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

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