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

[アーティクル]
07/13/2023

このガイドの目的は、直接的なサービスからサービスへの呼び出しを使用して、UGC をすぐに使用開始する方法を説明することです。ドラフトの UGC コンテンツアイテムに接続し、これらのアイテムを公開し、アイテムを検索して見つける方法の手順を追って紹介します。

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

UGC は、PlayFab エンティティと連携するように設計されているため、最初の手順では LoginWithCustomID を使用してエンティティトークンを取得します。サービスの呼び出しは以下のようになります。

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

ドラフト UGC アイテムを作成する

「ドラフトの」UGC アイテムを作成するには、"Type":"ugc"パラメーターを指定してCreateDraftItem API を呼び出します。下書きアイテムは、公開する前に、作成者がレビューできるように設計されています。ドラフトアイテムを作成するには以下が必要です。

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 を使用できます。タイトルエンティティは、Entity パラメーターのプレーヤー ID を使用してこの API を呼び出すことができ、API はその特定のプレーヤーのドラフトアイテムのリストを返します。タイトルエンティティのみが 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

アイテムを再公開すると、公開済みアイテムが現在のドラフトアイテムと一致するように更新されます。

単純な検索を行う

公開呼び出しが成功すると、パブリックカタログを介してすべてのプレーヤーがアイテムにアクセスできるようになります。 SearchItemsAPI は、指定されたパラメーターを使用して、発行済みカタログ (UGCアイテムを含む) に対して検索を実行し、ページ付けされた結果のセットを返します。 Filter、OrderBy、Select の各フィールドでは、クエリ標準として OData を使用します。

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