メインコンテンツへスキップ
XBOX CLI では、タイトル シークレット キーまたはタイトル エンティティ トークンを受け入れる任意の PlayFab API を、 それらの代わりに Microsoft Entra ID の開発者資格情報を使用して呼び出すことができます。プレイヤーまたは ゲーム サーバーのエンティティ トークンのみを受け入れる API は、この方法では承認されません。 PlayFab タイトルに対する Admin 権限が必要です。 PlayFab 認証のしくみを参照してください。

セットアップ

サインインし、PlayFab タイトル ID を既定値として保存して、読み取り専用のリクエストを実行します。 ABC123 は自分のタイトル ID に置き換えてください。
1 つのコマンドだけで別のタイトルを使用するには、--playfab-title-id を渡します。 コンテキストを参照してください。

API を見つける

PlayFab では、すべての操作について、リクエストとレスポンスのスキーマ、必須フィールド、受け入れる資格情報が ドキュメント化されています。
  • PlayFab REST API リファレンスは、 人向けに記述されています。
  • PlayFab の Swagger 仕様 は機械で読み取れる形式です。ファイル名はパスの最初のセグメントではなく PlayFab の API グループに基づいているため、 ファイルの paths で操作を検索してください。たとえば、/Catalog と /Inventory は Economy.swagger.json に、/Match、/Lobby、 /MultiplayerServer は Multiplayer.swagger.json に含まれています。
  • 各操作の security フィールドには、受け入れる資格情報が示されます。SecretKey (タイトル シークレット キー)、EntityToken、SessionTicket (プレイヤー セッション)、または None です。一部の 操作では、説明に許可されるエンティティ トークンの種類も記載されています。
API パスは /Admin/GetTitleData のような /<Prefix>/<Operation> の形式で、リクエスト 本文はその操作の JSON リクエスト オブジェクトです。

例

これらの例では、playfab api を使用して API を呼び出します。オプションの 完全なリファレンスはそのページにあります。Delete* 操作と Shutdown* 操作は、ターミナルでは最初に確認を求め、それ以外の環境では --confirm が必要です。安全性と破壊的な操作を参照してください。

タイトル データを取得する

タイトル データのキーを 1 つ取得する

タイトル データを設定する

--body でリクエスト本文をインラインで渡します。
または、--body-file でファイルから読み取ります。次の例は PowerShell の場合です。

データのみを 1 行で取得する

--data-only はレスポンス エンベロープを除去し、--output json-compact はパイプ処理用に 1 行の JSON を書き込みます。

エラー レスポンス

失敗した呼び出しは、コード 1 で終了します。
  • PlayFab がエラーを返した場合、コマンドは PlayFab のエラー JSON を、--output に従った形式で stderr に書き込みます。
  • ネットワーク エラーなど、その他の失敗では、プレーン テキストのメッセージが stderr に書き込まれます。
  • --data-only を使用すると、エラー時の stdout は空になります。
最終更新日 2026年11月19日