ユーザー生成コンテンツ (UGC) クイックスタート

このガイドの目的は、直接的なサービス間呼び出しを使用して UGC をすばやく始める方法を説明することです。下書き UGC コンテンツアイテムに接続し、それらのアイテムを公開してから、検索して見つける方法を段階的に示します。

エンティティトークンを取得する

UGC は PlayFab エンティティで動作するように設計されているため、最初のステップは LoginWithCustomID を使用してエンティティトークンを取得することです。この例はサービス呼び出しを示しています。

{
  "CustomId": "exampleUser",
  "CreateAccount": true,
  "TitleId": "DC7B"
}

Blob URL を作成する

UGC システムは、タイトルの UGC に関連付けられたすべてのコンテンツ (ファイルと画像) を格納するために Azure Blob Storage を使用します。コンテンツをアップロードするには、まず CreateUploadUrls API を呼び出し、ファイル名とサイズ (バイト単位) を渡して新しい blob を作成する必要があります。たとえば、テキストファイルと PNG 画像をアップロードしたい場合は、次をリクエスト本文に渡します。

{
  "Files": [
    {
      "FileName": "HelloWorld.txt",
      "FileSize": 12
    },
    {
      "FileName": "PlayFabLogo.png",
      "FileSize": 20725
    }
  ]
}

レスポンスには、各コンテンツの Id と Url が含まれます。

{
    "code": 200,
    "status": "OK",
    "data": {
        "UploadUrls": [
            {
                "Id": "[Content ID]",
                "Url": "[Content Url + '?' + Token]",
                "FileName": "HelloWorld.txt"
            },
            {
                "Id": "[Image ID]",
                "Url": "[Image Url + '?' + Token]",
                "FileName": "PlayFabLogo.png"
            }
        ]
    }
}

下書き UGC アイテムを作成する

"Type":"ugc" パラメーターを使用して CreateDraftItem API を呼び出すことで、“下書き” UGC アイテムを作成します。作成者は公開前に下書きアイテムをレビューおよびアクセスできます。下書きアイテムを作成するには、次が必要です。

X-EntityToken ヘッダーには、前の呼び出しからの EntityToken。
アイテムの CreatorEntityKey.Id には、前の呼び出しからの Entity.Id。
アイテムの sourceId にはタイトルの TitleId。

この呼び出しは次のようになります。

{
  "Item": {
   "Type": "ugc",
    "Title": {
      "NEUTRAL": "Neutral Title Test",
      "en-GB": "en-gb Title",
      "en-US": "en-us Title"
    },
    "Description": {
      "NEUTRAL": "Neutral Description Test",
      "en-GB": "en-gb Description",
      "en-US": "en-us Description"
    },
    "startDate": "2018-10-18T20:01:26.1520582Z"
  }
}

これにより、Id を含む作成された下書きアイテムが返されます。後で使用できるように Id を保存します。

       "Item": {
            "SourceEntity": {
                "Id": "1184A",
                "Type": "title",
                "TypeString": "title"
            },
            "SourceEntityKey": {
                "Id": "1184A",
                "Type": "title",
                "TypeString": "title"
            },
            "Id": "44857e2b-c93b-4054-80be-7890028201ff",
            "Type": "ugc",
            "Title": {
              "NEUTRAL": "Neutral Title Test",
              "en-GB": "en-gb Title",
              "en-US": "en-us Title"
            },
          ...
        }

プレイヤーの下書きアイテム ID を取得する

特定のプレイヤーの下書きアイテム ID を取得するには、GetEntityDraftItems API を使用できます。Title Entity はこの API を Entity パラメーターにプレイヤー ID を渡して呼び出すことができ、API はその特定のプレイヤーの下書きアイテムのリストを返します。Entity パラメーターを渡せるのは Title Entity のみです。プレイヤーエンティティは Entity パラメーターなしで API を呼び出すことができ、API は呼び出しを行っているプレイヤーが作成した下書きアイテムのリストを返します。

{
  "Count": 2,
  "Entity": {
    "Id": "C88F55C6A734B1DC",
    "Type": "title_player_account",
    "TypeString": "title_player_account"
  }
}

UGC アイテムを公開する

アイテムが下書き状態になったら、PublishDraftItem を使用して公開状態にプッシュできます。UGC アイテムが公開されると、検索可能になり、公開で利用可能になります。CreateDraftItem レスポンスから返されたアイテム Id を使用する必要があります。

{
"Id": "44857e2b-c93b-4054-80be-7890028201ff"
}

UGC アイテムの公開ステータスを取得する

アイテム Id を使用して、GetItemPublishStatus API を使用して UGC カタログ内のアイテムの公開ステータスを取得できます。

{
"Id": "44857e2b-c93b-4054-80be-7890028201ff"
}

可能な公開 Result の値は次のとおりです。

Unknown
Pending
Succeeded
Failed
Canceled

アイテムを再公開すると、公開されたアイテムが現在の下書きアイテムに合わせて更新されます。

検索を行う

公開呼び出しが成功すると、すべてのプレイヤーが公開カタログでアイテムにアクセスできます。SearchItems API は、提供されたパラメーターを使用して公開されたカタログ (UGC アイテムを含む) に対する検索を実行し、ページ分割された結果のセットを返します。Filter、OrderBy、および Select フィールドは、クエリ標準として OData を使用します。

{
  "Search": "Test",
  "Count": 2
}

XBOX Services

PlayFab

ユーザー生成コンテンツ (UGC) クイックスタート

ユーザー生成コンテンツ (UGC) クイックスタート

エンティティトークンを取得する

Blob URL を作成する

下書き UGC アイテムを作成する

プレイヤーの下書きアイテム ID を取得する

UGC アイテムを公開する

UGC アイテムの公開ステータスを取得する

検索を行う

関連項目

​ユーザー生成コンテンツ (UGC) クイックスタート

​エンティティ トークンを取得する

​Blob URL を作成する

​下書き UGC アイテムを作成する

​プレイヤーの下書きアイテム ID を取得する

​UGC アイテムを公開する

​UGC アイテムの公開ステータスを取得する

​検索を行う

​関連項目

ユーザー生成コンテンツ (UGC) クイックスタート

エンティティトークンを取得する

Blob URL を作成する

下書き UGC アイテムを作成する

プレイヤーの下書きアイテム ID を取得する

UGC アイテムを公開する

UGC アイテムの公開ステータスを取得する

検索を行う

関連項目