マーケットプレイス引き換えのエラー処理

マーケットプレイス引き換え API を扱う際、堅牢なエラー処理が非常に重要です。この記事では、一般的なエラーコードの理解から、優雅なエラー回復戦略の実装まで、エラー処理のベストプラクティスを紹介します。エラーは、標準の PlayFab Error Wrapper を使用して返されます。

APIErrorWrapper

APIErrorWrapper は、失敗したすべての API レスポンスをラップするラッパーです。

名前	型	説明
code	integer	数値の HTTP コード。
error	string	PlayFab のエラーコード。
errorCode	integer	数値の PlayFab エラーコード。
errorDetails	object	リクエストオブジェクトの個別の問題に関する詳細な説明。
errorMessage	string	PlayFab errorCode の説明。
status	string	文字列の HTTP コード。

マーケットプレイス関連の問題については、errorDetails オブジェクトでキーと値のペア (KVP) を返します。

名前	型	説明
MarketplaceErrorCode	string[]	マーケットプレイスへの呼び出しが失敗した場合にマーケットプレイスから返されるエラーコード。配列の最初の文字列がエラーコードで、2 番目の文字列は使用可能な場合はエラーメッセージです。

これは、マーケットプレイスから返されたエラーコードとエラーコードメッセージのパススルーです。

エラーレスポンスは以下のように表示されます。開発者は wrapper.errorDetails['MarketplaceErrorCode'] が null でないことを確認し、その後最初の要素を解析して、それぞれのマーケットプレイスエラーコードを適切に処理する必要があります。

"{
    "code":503,
    "errorDetails":
    {
        "MarketplaceErrorCode":["1234","sample error code"]
    },
    ...    
}"

このセクションでは、redeem API から返されるエラーコードを一覧表示します。

400 - Bad Request
- すべてのリクエストおよび入力検証の失敗 GenericErroCodes.InvalidRequest
- すべての構成検証の失敗 GenericErrorCodes.InvalidServiceConfiguration
- すべてのマーケットプレイス認可の失敗
  - GenericErrorCodes.InvalidServiceConfiguration - サービス ID の失敗に関連します。
  - GenericErrorCodes.InvalidAuthToken - プレイヤー ID の失敗に関連します。
- すべてのカタログアイテム構成の失敗 GenericErrorCodes.InvalidCatalogItemConfiguration
401/403 - Not Authorized/Forbidden
- PlayFab 認可の失敗 GenericErrorCodes.NotAuthorized
503 - MarketplaceUnavailable
- GenericErrorCodes.DownstreamServiceUnavailable