Economy v2 のサブスクリプション

サブスクリプションを使用すると、耐久財への期間ベースのアクセスを付与できます。サブスクリプション内のアイテムは、GetInventoryItems を呼び出した後、プレイヤーのインベントリでアンパックされます。

この記事は仮想サブスクリプション、つまりゲーム内に存在するサブスクリプションに焦点を当てています。

サブスクリプションの作成

サブスクリプションを作成するには、まずゲーム内でアクセス/購入可能にしたい公開済みのカタログアイテム、Currency、またはユーザー生成コンテンツ (UGC) があることを確認する必要があります。サブスクリプションを作成する前にカタログをセットアップするには、Economy V2 のクイックスタートを参照してください。

Game Manager

Economy > Catalog (V2) に移動します。
Subscriptions タブで New Subscription を選択します。

API

CreateDraftItem API を使用してサブスクリプションを作成できます。サブスクリプションを作成する CreateDraftItem API リクエストの例:

{
  "Item": {
   "Type": "subscription",
    "Title": {
      "NEUTRAL": "Holiday Skins Pass"
    },
    "StartDate": "2023-03-07T00:01:00.0000000Z",
    "ItemReferences":[
      {
        "Id":"{{GlowingGlovesItemID}}",
        "Amount": 1
      }, 
      {
        "Id":"{{ShinyShoesItemID}}", 
        "Amount": 1
      }
    ],
        "PriceOptions": {
          "Prices": [
        {
            "UnitDurationInSeconds":604800,
              "Amounts": [
                {
                    "ItemId": "{{DiamondItemID}}",
                    "Amount": 5
                },
                {
                    "ItemId": "{{GoldItemID}}",
                    "Amount": 10
                }
                ]
        },      
        {
            "UnitDurationInSeconds":2628000,
              "Amounts": [
                {
                    "ItemId": "{{DiamondItemID}}",
                    "Amount": 7
                },
                {
                    "ItemId": "{{GoldItemID}}",
                    "Amount": 12
                }
                ]
        } ]
          }
        },
  "Publish": true
}

上記の Holiday Skins Pass サブスクリプションは、Glowing Gloves と Shiny Shoes の 2 つのアイテムを、2 つの異なる有効期間に対する 2 つの価格ポイントで付与します。最初の 5 個の Diamond と 10 個の Gold の価格セットではサブスクリプションが 1 週間有効となり、2 つ目の 7 個の Diamond と 12 個の Gold の価格セットではサブスクリプションが 1 か月間有効となります。期間は秒単位で設定する必要があることに注意してください。これにより、サブスクリプションが作成および公開されたことを示すレスポンスが返されるはずです。

{
  "code": 200,
    "status": "OK",
    "data": {
        "Item": {
            "Id": "{{NewlyCreatedSubscriptionItemID}}",
            "Type": "subscription",
            "AlternateIds": [],
            "Title": {
                "NEUTRAL": "Holiday Skins Pass"
            },
    ...
}

インベントリ内のサブスクリプション

サブスクリプションは、ID、StackId、有効期限、表示プロパティを含むプレイヤーのインベントリコレクションに存在します。サブスクリプション内のすべての要素は、Add、Subtract、Update などを使用して他のアイテムと同様に変更できます。 Type フィルターと共に GetInventoryItems を使用して、プレイヤーが現在保有しているすべてのサブスクリプションを取得できます。

{ 
    "Entity": {
        "Type": "title_player_account", 
        "Id": "ID" 
    }, 
    "CollectionId": "default", 
    "Filter": "type eq 'subscription'"
}

**Sample Response**

{
    "code": 200,
    "status": "OK",
    "data": {
        "Items": [
            {
                "Id": "{{SubscriptionID}}",
                "StackId": "default",
                "DisplayProperties": {},
                "Type": "subscription",
                "ExpirationDate": "2023-08-27T23:59:59Z"
            }
        ],
        "ETag": "1/Mw=="
    }
}

期限切れではないサブスクリプションは、読み取り時にアンパックされます。アンパックされたアイテムには想定される ID、およびサブスクリプション ID とそのサブスクリプションの StackId で構成された一意の複合 StackId が付きます。数量はサブスクリプションのアイテム参照で構成された数量に設定されます。これらのアンパックされたアイテムは変更不可であり、Add、Subtract、Update などを使用して変更することはできません。

{ 
    "Entity": {
        "Type": "title_player_account", 
        "Id": "ID" 
    }, 
    "CollectionId": "default", 
    "Filter": "StackId eq 'SubscriptionItemID:default'"
}

**Sample Response**

{
    "code": 200,
    "status": "OK",
    "data": {
        "Items": [
            {
                "Id": "{{GlowingGlovesItemID}}",
                "StackId": "{{SubscriptionID:default}}",
                "DisplayProperties": {},
                "Amount": 1,
                "Type": "catalogItem"
            },
            {
                "Id": "{{ShinyShoesItemID}}",
                "StackId": "{{SubscriptionID:default}}",
                "DisplayProperties": {},
                "Amount": 1,
                "Type": "catalogItem"
            }
        ],
        "ETag": "1/NQ=="
    }
}

サブスクリプションのアンパックはフィルタリングとページングの前に行われるため、サブスクリプションアイテムはコレクション内の他のアイテムと同様に確実にフィルターおよびページングできます。 UpdateInventoryItems、AddInventoryItems、および SubtractIventoryItems を使用して、プレイヤーのサブスクリプションの有効期限を更新できます。以下の UpdateInventoryItems API 呼び出しは、サブスクリプションの有効期限を更新します。

{
   "Entity": { 
      "Type": "title_player_account", 
      "Id": "{{ID}}" 
    }, 
  "CollectionId": "default", 
   "Item": { 
        "Id": "{{SubscriptionID}}", 
        "StackId": "default",
        "DisplayProperties": {},
        "Type": "subscription",
        "ExpirationDate": "2023-03-27T23:59:59Z" 
    } 
} 

以下の AddInventoryItems API 呼び出しは、DurationInSeconds パラメーターを増やすことで有効期限を延長します。

{
    "Entity": { 
        "Type": "title_player_account", 
        "Id": "{{ID}}" 
    }, 
    "CollectionId": "default", 
    "Item": { 
        "Id": "{{SubscriptionID}}" 
    }, 
    "DurationInSeconds":2628000 
} 

以下の SubtractInventoryItems API 呼び出しは、DurationInSeconds パラメーターを減らすことで有効期限を短縮します。

{
    "Entity": { 
        "Type": "title_player_account", 
        "Id": "{{ID}}" 
    }, 
    "CollectionId": "default", 
    "Item": { 
        "Id": "{{SubscriptionID}}" 
    }, 
    "DurationInSeconds":60 
} 

XBOX Services

PlayFab

サブスクリプションの作成

Game Manager

API

インベントリ内のサブスクリプション

​サブスクリプションの作成

​Game Manager

​API

​インベントリ内のサブスクリプション

サブスクリプションの作成

Game Manager

API

インベントリ内のサブスクリプション