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 میدان اتحادیه یکی از آنها که نوع خطای رخ داده را نشان می دهد. result می تواند تنها یکی از موارد زیر باشد:
invalidApiVersion

object ( InvalidApiVersion )

اگر نسخه API درخواست پشتیبانی نشود استفاده می شود. کد HTTP توصیه شده: 400

invalidPayloadSignature

object ( InvalidPayloadSignature )

اگر امضای محموله به یک کلید ناشناخته یا غیرفعال باشد استفاده می شود. کد 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 با اثبات Rejected فراخوانی می شود. کد 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

این پیام در حال حاضر عمداً خالی است. فیلدهای جدید می تواند در آینده اضافه شود.

اجازه رد شد

شی حاوی اطلاعات مربوط به خطای رد مجوز.

نمایندگی JSON 
{
  "reason": string
}
فیلدها
reason

string

دلیل عدم اجازه.

ممنوع

این پیام در حال حاضر عمداً خالی است. فیلدهای جدید می تواند در آینده اضافه شود.

InvalidState

این پیام در حال حاضر عمداً خالی است. فیلدهای جدید می تواند در آینده اضافه شود.