- 錯誤回應主體
- InvalidApiVersion
- InvalidPayloadSignature
- InvalidPayloadEncryption
- InvalidIdentifier
- InvalidFieldValue
- MissingRequiredField
- InvalidDecryptedRequest
- PermissionDenied
- Forbidden
- InvalidState
所有方法的 ErrorResponse 物件。發生錯誤時,系統會傳回此類型,而非一般回應類型。請勿將此物件用於以商業邏輯為依據的拒絕。
| JSON 表示法 |
|---|
{ "responseMetadata": { object ( |
| 欄位 | |
|---|---|
responseMetadata |
回應的中繼資料,所有回應都需要。 |
errorDescription |
請提供這個狀態的說明,讓支援團隊代表能對錯誤進行偵錯。請注意,使用者不會看到這項資訊,其中可能包含用於偵錯的描述性非機密文字。請注意,errorResponseCode 的某些值應在此欄位中隨附其他詳細資料。 警告:請勿在訊息中加入任何個人識別資訊 (PII)。 |
issuerErrorIdentifier |
這個 ID 專屬於發卡機構,由發卡機構產生。這項參數僅用於偵錯,用途是找出這項錯誤。這是核發機構用來識別這項錯誤的 ID。 |
聯集欄位 result。擷取發生錯誤類型的 oneof。result 只能是下列其中一項: |
|
invalidApiVersion |
如果要求的 API 版本不受支援,就會使用這個值。建議的 HTTP 代碼:400 |
invalidPayloadSignature |
酬載的簽名對象是不明或無效的金鑰時使用。建議的 HTTP 代碼:401 |
invalidPayloadEncryption |
酬載的加密對象是不明或無效的金鑰時使用。建議的 HTTP 代碼:400 |
invalidIdentifier |
要求中傳送的識別碼無效或不明時使用。建議的 HTTP 代碼:404 |
invalidFieldValue |
要求包含的欄位值不在支援的值集中時使用。建議的 HTTP 代碼:400 |
missingRequiredField |
要求中未設定必填欄位時使用。建議的 HTTP 代碼:400 |
invalidDecryptedRequest |
要求酬載可以解密,但產生的訊息無法剖析時使用。建議的 HTTP 代碼:400 |
permissionDenied |
如果要求因 Google 在 API 呼叫中傳送的任何權限憑證相關問題而遭拒,就會使用此值。建議的 HTTP 代碼:403 |
forbidden |
您無法存取所要求的資源。建議的 HTTP 代碼:403 |
invalidState |
如果提出要求,但系統處於無法執行要求的狀態,就會使用這個代碼。例如:呼叫 mdl.provisionCredential 時,會傳回已拒絕的校對結果。建議的 HTTP 代碼:400 |
InvalidApiVersion
包含無效 API 版本錯誤資訊的物件。
| JSON 表示法 |
|---|
{ "requestVersion": { object ( |
| 欄位 | |
|---|---|
requestVersion |
要求中指定的無效版本。 |
expectedVersion |
預期的版本。 |
InvalidPayloadSignature
這則訊息目前刻意空白,日後可能會新增其他欄位。
InvalidPayloadEncryption
這則訊息目前刻意空白,日後可能會新增其他欄位。
InvalidIdentifier
包含無效 ID 錯誤資訊的物件。
| JSON 表示法 |
|---|
{ "invalidIdentifierType": string } |
| 欄位 | |
|---|---|
invalidIdentifierType |
無效的 ID 類型,例如校對 ID、文件 ID 等。 |
InvalidFieldValue
包含無效欄位值錯誤資訊的物件。
| JSON 表示法 |
|---|
{ "invalidFieldName": string } |
| 欄位 | |
|---|---|
invalidFieldName |
發現無效的欄位名稱。 |
MissingRequiredField
物件,其中包含缺少必要欄位錯誤的相關資訊。
| JSON 表示法 |
|---|
{ "missingFieldNames": [ string ] } |
| 欄位 | |
|---|---|
missingFieldNames[] |
缺少欄位的名稱。 |
InvalidDecryptedRequest
這則訊息目前刻意空白,日後可能會新增其他欄位。
PermissionDenied
包含權限遭拒錯誤資訊的物件。
| JSON 表示法 |
|---|
{ "reason": string } |
| 欄位 | |
|---|---|
reason |
拒絕權限的原因。 |
已禁止
這則訊息目前刻意空白,日後可能會新增其他欄位。
InvalidState
這則訊息目前刻意空白,日後可能會新增其他欄位。