無料アイテム

仕組み

無料アイテムとは、仮想通貨や実際通貨を消費することなく、ユーザーが獲得できるアイテムです。

無料アイテムは、以下のシナリオで利用可能です：

• ゲーム内アイテムの販売 — 仮想アイテム、仮想通貨パッケージ、バンドル
• ゲームおよび DLC をゲームキーで販売

使用事例：

• プロジェクトのマイルストーンや記念日などの特別な日に、ユーザーのロイヤルティへの報酬として無料アイテムを提供。
• ベースゲームをすでに購入したユーザー向けに、ロイヤルティ報酬として無料アドオンを提供。
• 新規ユーザー獲得のため、ウェブストアで無料のスターターパックを提供。

無料の仮想アイテム、仮想通貨、およびバンドルは、認証されたユーザーのみが利用可能です。無料ゲームキーは、認証済みユーザーと未認証ユーザーの両方が利用可能です。無料アイテムの数量制限の設定は、認証されたユーザーに限定されます。

無料アイテムを設定

2. Create manually をクリックし、ドロップダウンリストから Virtual items を選択します。

3. General settings セクションで、次を指定します：
   1. SKU
   2. アイテムを属させるグループ（複数可、任意）
   3. 名前
   4. 短い説明
   5. 詳細説明 — 追加する場合は対応するトグルをオン（任意）

4. Media セクションで、画像または動画を 1 件以上アップロードします（任意）。デバイスから直接、またはリンク経由で追加できます。エクソーラのサイトビルダーで作成したストアでは、すべてのアイテムカードに Main としてマークされたファイルが表示され、残りのファイルはメディアギャラリー付きのアイテムカードでのみ表示されます。Main としてマークされたファイルは、カタログ取得 API コールのレスポンスでも返されます。

5. Price settings セクションで Free item を選択します。

6. 購入可能なアイテム数を制限するには：
   1. Limits セクションでトグルをオンにし、数量を指定します。
   2. 制限のリセット頻度を設定します。ドロップダウンリストから期間を選択します：
      1. Daily
      2. Weekly
      3. Monthly
      4. Custom interval。間隔はストアでのアイテムの表示開始日時から計算されます。
      5. No regular refresh
   3. 選択した期間に対応するパラメーターを指定して、リセットスケジュールを設定します。

7. アイテムの表示期間制限を設定する（任意）：

   1. Add specific display period セクションでトグルをオンにします。
   2. タイムゾーン、開始日時、終了日時を指定します。

   表示終了日時を設定しない場合は、No end date トグルをオンにします。

8. 次のいずれかの方法で属性を設定します（任意）：
   1. JSON形式で属性とその値を追加
   2. 属性とその値を手動で作成し、アイテムに関連付け

9. Create をクリックします。
10. 表示されたウィンドウで、アイテムのステータス を選択し、Continue をクリックします。

作成したアイテムは All items セクションに表示されます。

API で設定

アイテムを無料に設定するには、以下の管理者のAPIコールを実行する際、リクエスト本文に“is_free”: trueを渡してください。

• 仮想アイテムを作成 または 仮想アイテムを更新
• ゲームを作成、ID でゲームを更新、または SKU でゲームを更新
• 仮想通貨を作成 または 仮想通貨を更新
• 仮想通貨パッケージを作成 または 仮想通貨パッケージを更新
• バンドルを作成 または バンドルを更新 無料アイテムをユーザーが受け取れる数を制限する場合は、アイテムの作成または更新 API コールで次のパラメーターを渡します：
  • limits（数量を指定）
  • limits.recurrent_schedule（制限のリセット頻度を指定）

ストアでのアイテムの表示期間制限や、地域別制限も設定できます。

無料アイテムをカタログに表示

無料アイテムの表示は、サイトビルダーかAPIか、どの方法で実装しているかによって異なります。

サイトビルダーで表示

ウェブサイトに無料アイテムを表示するには：

1. 無料アイテムを作成します。
   2. パブリッシャーアカウントのプロジェクトで、Storefronts > Websites セクションに移動します。
   3. 対象サイトのペインで Open Site Builder をクリックします。

   

2. モバイルゲーム用のアカウントのプロジェクトで、Web Shop セクションに移動します。
3. 対象サイトのペインをクリックします。

4. サイトに複数のページがある場合は、必要なページを選択します：
   1. ビルダー上部の現在のページタイトルをクリックします。
   2. ドロップダウンリストから目的のページを選択します。
5. Store セクションの Item type フィールドで、無料アイテムのタイプを選択し、必要に応じてグループを指定します。
6. アイテムカードのレイアウトを設定します。
7. すべての変更を行い、サイトの公開準備ができたら：
   1. サイトビルダー右上の Publish をクリックします。
   2. 公開するページにチェックを入れます。
   3. Publish をクリックします。

サイトを公開すると、無料アイテムのセクションが利用可能になります。アイテムが表示されない場合は、ステータスが Available に設定され、時間ベースの表示制限が有効になっていないことを確認してください。

API 経由で無料アイテム情報を取得

カタログを API で構成している場合、無料アイテムのデータはCatalog サブセクションの次の API コールで返されます：

• 仮想アイテム一覧を取得
• 仮想通貨一覧を取得
• 仮想通貨パッケージ一覧を取得
• バンドル一覧を取得
• ゲーム一覧を取得

無料アイテムをユーザーに付与

無料アイテムを含む注文の処理方法は、購入時にカートを使用するかどうかによって異なります。

ユーザーがカートを使わずにアイテムを購入する場合は、指定した無料アイテムで注文を作成 API コールを使用します。

ユーザーがカートを使用してアイテムを購入する場合、以下のようなシナリオが想定されます：

• ユーザーのカートに有料と無料のアイテムが両方含まれている場合は、注文作成 API コール 特定のカート内のすべてのアイテムで注文を作成 または 現在のカート内のすべてのアイテムで注文を作成 を使用します。この場合、ユーザーは決済 UI で支払いを完了します。
• ユーザーのカートに無料アイテムのみが含まれている場合は、無料カートで注文を作成 または 特定の無料カートで注文を作成 API コールを使用します。この場合、決済 UI は使用しません。

  どちらの場合も、エクソーラはアイテム付与に使用するアイテムデータを含む 注文の支払い成功 ウェブフックを送信します。無料アイテムの場合、このウェブフック内の order.invoice_id パラメーターは null に設定されます。

無料アイテムの注文オブジェクト例：

 1{
 2  "method": "POST",
 3  "url": "https://mybestgame.com/xsolla/notification",
 4  "body": {
 5    "items": [
 6      {
 7        "sku": "gift_direct_game_reward-supercoin",
 8        "type": "virtual_currency",
 9        "is_pre_order": false,
10        "quantity": 500,
11        "amount": "0",
12        "promotions": [
13
14        ]
15      },
16      {
17        "sku": "package-500_supercoin",
18        "type": "bundle",
19        "is_pre_order": false,
20        "quantity": 1,
21        "amount": "0",
22        "promotions": [
23
24        ]
25      },
26      {
27        "sku": "xsolla-giveaway_offer_11_14_22",
28        "type": "bundle",
29        "is_pre_order": false,
30        "quantity": 1,
31        "amount": "0",
32        "promotions": [
33
34        ]
35      }
36    ],
37    "notification_type": "order_paid",
38    "order": {
39      "id": 12345678,
40      "mode": "default",
41      "currency_type": "unknown",
42      "currency": null,
43      "amount": "0",
44      "status": "paid",
45      "platform": "xsolla",
46      "comment": null,
47      "invoice_id": null,
48      "promotions": [
49
50      ]
51    },
52    "user": {
53      "external_id": "1234567812345678",
54      "email": null
55    }
56  },
57  "headers": {
58    "Authorization": "Signature 3b840ccefea111dcdfd111db1fdc6df969a3ec11",
59    "Accept": "application/json",
60    "Content-Type": "application/json"
61  },
62  "type": "webhook_payment",
63  "callback_parameters": {
64    "order_id": 12345678
65  }
66}

プロジェクトの統合設定に基づき、アイテムは以下のいずれかの方法でユーザーに付与されます：

• PlayFab を統合している場合、仮想通貨およびアイテムはユーザーの PlayFab インベントリに自動付与されます。
• カスタムの配信システムを使用している場合、すべての仮想アイテムと仮想通貨はお客様側で付与します。バックエンドで注文データを受け取れるよう、ウェブフックハンドラーの設定を推奨します。必要なデータは 注文の支払い成功 ウェブフックに含まれています。 詳細は、注文状況の追跡を設定を参照してください。