ErrorResponse

אובייקט ErrorResponse לכל השיטות. הערך הזה מוחזר במקום סוג התגובה הרגיל, כשיש שגיאה. אין להשתמש באובייקט הזה לדחיה על סמך לוגיקה עסקית.

ייצוג ב-JSON 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "errorDescription": string,
  "issuerErrorIdentifier": string,

  // Union field result can be only one of the following:
  "invalidApiVersion": {
    object (InvalidApiVersion)
  },
  "invalidPayloadSignature": {
    object (InvalidPayloadSignature)
  },
  "invalidPayloadEncryption": {
    object (InvalidPayloadEncryption)
  },
  "invalidIdentifier": {
    object (InvalidIdentifier)
  },
  "invalidFieldValue": {
    object (InvalidFieldValue)
  },
  "missingRequiredField": {
    object (MissingRequiredField)
  },
  "invalidDecryptedRequest": {
    object (InvalidDecryptedRequest)
  },
  "permissionDenied": {
    object (PermissionDenied)
  },
  "forbidden": {
    object (Forbidden)
  },
  "invalidState": {
    object (InvalidState)
  }
  // End of list of possible types for union field result.
}
שדות
responseMetadata

object (ResponseMetadata)

המטא-נתונים של התגובה, הנדרשים בכל התשובות.
errorDescription

string

יש לתאר את הסטטוס הזה כדי שנציגי התמיכה יוכלו לנפות באגים בשגיאות. חשוב לדעת שהערה הזו לא מוצגת למשתמשים. הוא יכול להכיל טקסט תיאורי לא רגיש שמשמש לניפוי באגים. לתשומת ליבכם: לחלק מהערכים של errorResponseCode צריך לצרף פרטים נוספים בשדה הזה.

אזהרה: אין לכלול פרטים אישיים מזהים (PII) בהודעה הזו.
issuerErrorIdentifier

string

המזהה הזה ספציפי למנפיק ונוצר על ידו. הוא משמש למטרות ניפוי באגים בלבד, כדי לזהות את השגיאה הזו. זהו המזהה של השגיאה הזו אצל המנפיק.
שדה האיחוד result. מאפיין oneof שמתעד את סוג השגיאה שהתרחשה. הערך של result יכול להיות רק אחת מהאפשרויות הבאות:
invalidApiVersion

object (InvalidApiVersion)

משמש אם גרסת ה-API של הבקשה לא נתמכת. קוד HTTP מומלץ: 400
invalidPayloadSignature

object (InvalidPayloadSignature)

משמש אם החתימה על המטען הייעודי (payload) היא למפתח לא ידוע או לא פעיל. קוד HTTP מומלץ: 401
invalidPayloadEncryption

object (InvalidPayloadEncryption)

משמש אם ההצפנה של עומס העבודה מתבצעת למפתח לא ידוע או לא פעיל. קוד HTTP מומלץ: 400
invalidIdentifier

object (InvalidIdentifier)

השדה הזה משמש אם המזהה שנשלח בבקשה לא תקין או לא מוכר. קוד HTTP מומלץ: 404
invalidFieldValue

object (InvalidFieldValue)

הקוד הזה מופיע אם הבקשה מכילה ערך לשדה שלא נמצא בקבוצת הערכים הנתמכים. קוד HTTP מומלץ: 400
missingRequiredField

object (MissingRequiredField)

השדה הזה משמש אם שדה חובה לא מוגדר בבקשה. קוד HTTP מומלץ: 400
invalidDecryptedRequest

object (InvalidDecryptedRequest)

הקוד הזה משמש אם ניתן היה לפענח את המטען הייעודי של הבקשה, אבל לא ניתן היה לנתח את ההודעה שנוצרה. קוד HTTP מומלץ: 400
permissionDenied

object (PermissionDenied)

השדה הזה משמש אם הבקשה נדחתה בגלל בעיות שקשורות לפרטי הכניסה להרשאות ש-Google שולחת בקריאות ל-API. קוד HTTP מומלץ: 403
forbidden

object (Forbidden)

אסור לגשת למשאב המבוקש. קוד ה-Http המומלץ: 403
invalidState

object (InvalidState)

הקוד הזה משמש אם נשלחה בקשה, אבל המערכת לא במצב תקין לביצוע הבקשה. דוגמה: mdl.provisionCredential נקרא עם 'השלב של בדיקת ההתאמה נדחה'. קוד HTTP מומלץ: 400

InvalidApiVersion

אובייקט שמכיל מידע על שגיאה בגרסת API לא חוקית.

ייצוג ב-JSON 
{
  "requestVersion": {
    object (Version)
  },
  "expectedVersion": {
    object (Version)
  }
}
שדות
requestVersion

object (Version)

הגרסה הלא חוקית שצוינה בבקשה.
expectedVersion

object (Version)

הגרסה הצפויה.

InvalidPayloadSignature

ההודעה הזו ריקה כרגע באופן מכוון. יכול להיות שנוסיף שדות חדשים בעתיד.

InvalidPayloadEncryption

ההודעה הזו ריקה כרגע באופן מכוון. יכול להיות שנוסיף שדות חדשים בעתיד.

InvalidIdentifier

אובייקט שמכיל מידע על שגיאת מזהה לא חוקי.

ייצוג ב-JSON 
{
  "invalidIdentifierType": string
}
שדות
invalidIdentifierType

string

סוג המזהה שהיה לא תקין, למשל מזהה הגהה, מזהה מסמך וכו'.

InvalidFieldValue

אובייקט שמכיל מידע על שגיאה בערך שדה לא חוקי.

ייצוג ב-JSON 
{
  "invalidFieldName": string
}
שדות
invalidFieldName

string

שם השדה שנמצא לא חוקי.

MissingRequiredField

אובייקט שמכיל מידע על שגיאה של שדה חובה חסר.

ייצוג ב-JSON 
{
  "missingFieldNames": [
    string
  ]
}
שדות
missingFieldNames[]

string

השמות של השדות החסרים.

InvalidDecryptedRequest

ההודעה הזו ריקה כרגע באופן מכוון. יכול להיות שנוסיף שדות חדשים בעתיד.

PermissionDenied

אובייקט שמכיל מידע על שגיאה מסוג 'הרשאה נדחתה'.

ייצוג ב-JSON 
{
  "reason": string
}
שדות
reason

string

הסיבה לדחיית ההרשאה.

אסור

ההודעה הזו ריקה כרגע באופן מכוון. יכול להיות שנוסיף שדות חדשים בעתיד.

InvalidState

ההודעה הזו ריקה כרגע באופן מכוון. יכול להיות שנוסיף שדות חדשים בעתיד.