データのエクスポート

この記事では、PlayFab からプレイヤーとイベントデータをエクスポートする方法について説明します。

プレイヤーアカウントデータのエクスポート

プレイヤーのデータをエクスポートするリクエストを行うと、リクエストは キュー処理エージェント に送信されます (プレイヤーの削除と同様)。 ExportMasterPlayerData API は、指定された PlayFabId に関連するすべてのデータをエクスポートします。これには、次のような、すべてのタイトルにわたるデータが含まれます:

統計
カスタムデータ
インベントリ
購入
プレイヤー作成アイテム/UGC
トランザクション履歴
仮想通貨残高
キャラクター
グループメンバーシップ
パブリッシャーデータ
資格情報データ
アカウントリンケージ
フレンドリスト
PlayStream イベント履歴

プレイヤーのすべての PlayFabId を確実に把握する方法の詳細については、すべてのデータを必ず見つけてくださいをお読みください。この API はすぐに JobReceiptId を返します。今後の参照のためにこれを記録に保存してください。エクスポートがダウンロード可能になるまでには時間がかかる場合があります。エクスポートの完了時に、エクスポートのダウンロードリンクを含むメールが、タイトル用に構成された通知メールアドレスに送信されます。タスクの完了は player_data_exported PlayStream イベントもトリガーします。イベントには、プロパティとして JobReceiptId と、エクスポートされたデータへのアクセスを提供する ExportDownloadUrl プロパティが含まれます。Azure Functions を用いたオートメーションルールまたは Webhook のいずれかを使用して、選択したエンドポイントでこれらのイベントを受信するよう登録し、必要に応じて処理できます。以下の例は、C# SDK で Admin API を使用する方法を示しています。別の SDK を使用したい場合は、PlayFab SDKs のリストから選択してください。

public static async void ExportMasterPlayerExample(Action<PlayFabError> callback)
{
    var task = await PlayFabAdminAPI.ExportMasterPlayerDataAsync(new ExportMasterPlayerDataRequest()
    {
        PlayFabId = PlayFabId
    });

    if(task.Error != null)
    {
        callback(task.Error);
    }

    var jobReceiptId = task.Result.JobReceiptId;

    Console.WriteLine(string.Format("Export Player Request Received - Receipt: {0}", jobReceiptId));

    callback(null);
}

URL は、エクスポートの完了後、最大 30 日間利用できます。この時間を経過すると、ファイルは削除され、新しい エクスポートリクエストを開始する必要があります。

エクスポートされたデータの形式

エクスポートされたデータは、JobReceiptId とエクスポート時刻を含む名前の ZIP アーカイブにパッケージ化されます。アーカイブには、ディレクトリ構造に整理された複数のファイルが含まれます。

ファイルパス	説明
/master_player_export.json	PlayFab に記録されているプレイヤーのデータを含む JSON ファイルです。これには、プレイヤーが参加している各タイトルのデータが含まれます。 JSON ドキュメントのスキーマは、OpenAPI 仕様として提供されています。`https://<your_title_id>.playfabapi.com/Swagger/MasterPlayerDataExport.swagger.json` の `MasterPlayerDataExport` オブジェクトを参照してください。
/CustomFiles/MasterPlayerFiles/*	プレイヤーの `master_player_account` エンティティに関連付けられたカスタムエンティティファイルが含まれます。
/CustomFiles/TitlePlayerFiles/<TitlePlayerAccountId>/*	プレイヤーの `title_player_account` エンティティに関連付けられたカスタムエンティティファイルが含まれます。ファイルは、プレイヤーが参加している各タイトルごとに 1 つのサブディレクトリに整理されています。各サブディレクトリの名前は、そのタイトルにおけるプレイヤーの `title_player_account` エンティティ ID です。
/TitlePlayerEvents/<TitleId>/event-history_1.jsonl … /TitlePlayerEvents/<TitleId>/event-history_<N>.jsonl	プレイヤーに関して記録された PlayStream イベントとテレメトリイベントです。ファイルは、プレイヤーが参加している各タイトルごとに 1 つのサブディレクトリに整理されています。各サブディレクトリの名前は Title ID です。各サブディレクトリには、プレイヤーが指定されたタイトルで持っているデータ量に応じて、1 つ以上の `event-history` ファイルが含まれます。ファイルには、1 行に 1 つのイベントの形式で、JSON オブジェクトにシリアル化されたイベントが含まれます。

イベントデータのエクスポート

PlayFab には、いくつかのタイプのイベントデータ—カスタムデータ、エンティティオブジェクト、およびエンティティファイルがあります。

カスタムデータのエクスポート

カスタムデータは、プレイヤーに任意のデータを関連付けることを可能にする幅広いカテゴリの機能を指します。PlayFab はゲームロジックからデータを操作する方法を提供しますが、それ以外の方法でデータを解釈したり理解したりすることはありません。

レガシープレイヤーデータ

ExportMasterPlayerData API を使用する場合 (PlayFab データのエクスポートセクションを参照)、すべてのプレイヤーデータプロパティは、ZIP アーカイブのルートにある master_player_export.json ファイル内に含まれます:

「Publisher」データは JSONPath: $.PublisherData にあります。
タイトル別データは JSONPath: $.Titles[*].CustomData にあります。

これらの値のみをエクスポートする必要がある場合は、専用の「get」API 経由でも取得できます。専用の API の利点は、すぐに戻り値を返すことです。ただし、この機能の設計上、必要なデータの特定のタイプに基づいて、適切な API を呼び出す必要があります: GetUserData、GetUserInternalData、GetUserReadOnlyData、GetUserPublisherData、GetUserPublisherInternalData、GetUserPublisherReadOnlyData

エンティティオブジェクトのエクスポート

ExportMasterPlayerData API を使用する場合、すべてのエンティティオブジェクトは、ZIP アーカイブのルートにある master_player_export.json ファイル内で見つけることができます: master_player_account エンティティオブジェクトは JSONPath: $.CustomObjects にあります。 title_player_account エンティティオブジェクトは JSONPath: $.Titles[*].CustomObjects にあります。キャラクターエンティティオブジェクトは JSONPath: $.Titles[].Characters[].CustomObjects にあります。エンティティオブジェクトは、GetObjects API 経由でも取得できます。どのエンティティのオブジェクトを探しているか既にわかっている場合は、オブジェクトをすぐに返す専用の API を使用する方が簡単です。ただし、欠点は、プレイヤーの master_player_account エンティティ、各 title_player_account エンティティ、および各キャラクターエンティティごとに、API を別々に呼び出す必要があることです。

エンティティファイルのエクスポート

ExportMasterPlayerData API を使用する場合、プレイヤーに関連付けられたすべてのエンティティファイルは、そのまま ZIP アーカイブの /CustomFiles/ ディレクトリに追加されます。具体的には: プレイヤーの master_player_account エンティティのファイルは /CustomFiles/MasterPlayerFiles/* にあります。 title_player_account については、ファイルは /CustomFiles/TitlePlayerFiles/<TitlePlayerAccountId>/* にあります。

エンティティごとに 1 つのサブディレクトリが存在し、ディレクトリ名は title_player_account エンティティ ID です。

エンティティファイルは直接ダウンロードすることもできます。まず、GetFiles API を呼び出して、エンティティのファイルに関するメタデータを取得します。各ファイルメタデータドキュメントには DownloadUrl プロパティが含まれており、これを使用してファイルを直接ダウンロードできます。

XBOX Services

PlayFab

PlayFab GDPR - プレイヤーデータのエクスポート

データのエクスポート

プレイヤーアカウントデータのエクスポート

エクスポートされたデータの形式

イベントデータのエクスポート

カスタムデータのエクスポート

レガシープレイヤーデータ

エンティティオブジェクトのエクスポート

エンティティファイルのエクスポート

​データのエクスポート

​プレイヤー アカウント データのエクスポート

​エクスポートされたデータの形式

​イベント データのエクスポート

​カスタム データのエクスポート

​レガシー プレイヤー データ

​エンティティ オブジェクトのエクスポート

​エンティティ ファイルのエクスポート

データのエクスポート

プレイヤーアカウントデータのエクスポート

エクスポートされたデータの形式

イベントデータのエクスポート

カスタムデータのエクスポート

レガシープレイヤーデータ

エンティティオブジェクトのエクスポート

エンティティファイルのエクスポート