REST API の概要

PlayFab REST API リファレンスへようこそ。 ここには、API の動作についてのリファレンス用資料が用意されており、分析情報を得られます。 各 API リファレンスは、いくつかのセクションに分かれています。

エンドポイント

エンドポイントは、API のリクエスト先となる HTTP URL です。 先頭には REST メソッド型 (GET、POST など) が付きます。 さらに、titleId はゲームの titleId に置き換える必要があります。

例:

POST https://[titleId].playfabapi.com/Client/LoginWithCustomID

リクエストの本文

リクエストの本文はオブジェクト モデルであり、(JSON) として API サービスに送信されます。 このモデルは、ペイロードとして API と共に送信される必要があるプロパティを含みます。 一部のプロパティには必須としてフラグが付けられますが、その他のプロパティはオプションです。

応答

API サービスは、モデルとして逆シリアル化可能な JSON ペイロードと共に 200 OK を返します。 次の例では、Login API 呼び出しが LoginResult の型に逆シリアル化されます。

応答が失敗した場合は、4XX エラー応答を受信します。 「400 要求が正しくありません」の応答は、多くの場合、API 呼び出しでパラメーターが不足しているか、レート制限の超過や検証エラーなどのその他の理由が原因である可能性があります。 4XX エラーが発生した場合は、要求パラメーターと認証トークンを確認し、それらが正しいことを確認することをお勧めしています。 ApiErrorWrapper オブジェクトには、エラー コード、エラーの詳細、およびサーバーからのエラー メッセージを含むエラーに関する重要な情報が含まれており、問題の特定に役立ちます。

セキュリティ

各 API には、各リクエストのヘッダーで渡す必要があるセキュリティ形式があります。 定義する必要がある内容についてこのセクションで説明します。 場合によっては、ログイン要求からのセッション チケットや、サーバー API 要求を作成している場合はタイトル シークレット キーの定義が必要です。

コンカレンシー

API サービスは、各タイトルからの多数の同時呼び出しを処理するように設計されていますが、単一のプレイヤーまたはキャラクターやグループなどの他の単一のエンティティにアクセスできる同時呼び出しの数には制限と制約があります。 この同時実行制限を超えた場合、API は APIConcurrentRequestLimitExceeded または ConcurrentEditError エラー コードを返します。 一般に、特定のプレイヤーに対して複数の読み取り要求を同時に行うのは安全ですが、更新要求は一度に 1 つずつ行うのが最善です。

モデルの定義

API サービスからの各応答には、1 つまたは複数のモデルが含まれていることがあります。 これらは ApiErrorWrapper の下に配置され、各モデルは同じドキュメント内に API として表されます。 各モデルは応答の親モデルにもリンクされています。 各 API の [定義] セクションを表示して、API でサポートされるモデルの一覧を確認することもできます。

イベント モデルの定義

「PlayStream イベント モデル リファレンス」には、自動生成される PlayStream イベントの種類のモデルが含まれています。 各イベントの種類には一連のプロパティがあり、これらは送信されるイベントのデータの一部として含まれています。