ErrorInfo

תיאור הגורם לשגיאה עם פרטים מובְנים.

דוגמה לשגיאה שמתקבלת כשפונים אל ה-API ‏pubsub.googleapis.com כשהוא לא מופעל:

{ "reason": "API_DISABLED"
  "domain": "googleapis.com"
  "metadata": {
    "resource": "projects/123",
    "service": "pubsub.googleapis.com"
  }
}

התגובה הזו מציינת שממשק pubsub.googleapis.com API לא מופעל.

דוגמה לשגיאה שמוחזרת כשמנסים ליצור מופע Spanner באזור שבו אין מלאי:

{ "reason": "STOCKOUT"
  "domain": "spanner.googleapis.com",
  "metadata": {
    "availableRegions": "us-central1,us-east2"
  }
}
ייצוג JSON 
{
  "reason": string,
  "domain": string,
  "metadata": {
    string: string,
    ...
  }
}
שדות
reason

string

הסיבה לשגיאה. זהו ערך קבוע שמזהה את הסיבה הקרובה לשגיאה. הסיבות לשגיאות הן ייחודיות בתוך תחום שגיאות מסוים. האורך המקסימלי של השדה הזה הוא 63 תווים, והוא צריך להתאים לביטוי הרגולרי [A-Z][A-Z0-9_]+[A-Z0-9], שמייצג UPPER_SNAKE_CASE.
domain

string

הקיבוץ הלוגי שאליו שייך הנימוק. דומיין השגיאה הוא בדרך כלל שם השירות הרשום של הכלי או המוצר שיצרו את השגיאה. לדוגמה: pubsub.googleapis.com אם השגיאה נוצרת על ידי תשתית נפוצה, דומיין השגיאה חייב להיות ערך ייחודי גלובלי שמזהה את התשתית. בתשתית של Google API, דומיין השגיאה הוא googleapis.com.
metadata

map (key: string, value: string)

פרטים מובְנים נוספים על השגיאה הזו.

המפתחות צריכים להתאים לביטוי רגולרי של [a-z][a-zA-Z0-9-_]+, אבל מומלץ להשתמש בשיטת lowerCamelCase. בנוסף, האורך שלהם צריך להיות מוגבל ל-64 תווים. כשמזהים את הערך הנוכחי של חריגה ממגבלה, היחידות צריכות להיכלל במפתח ולא בערך. לדוגמה, במקום {"instanceLimit": "100/request"}, צריך להחזיר את הערך {"instanceLimitPerRequest": "100"}, אם הלקוח חורג ממספר המופעים שאפשר ליצור בבקשה אחת (בקשת אצווה).

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.