友達へのギフト

仕組み

この機能では、仮想通貨、仮想アイテム、ゲームキー、サブスクリプションなどのパッケージを実際通貨で購入し、ゲーム内の友人にプレゼントすることができます。支払いが完了すると、贈り主はレシートを受け取り、受け取り側にはギフトの詳細が記載されたメールが届きます。贈り主は自分のデータを隠すことで、匿名でギフトを送ることができます。

Note: 仮想通貨や仮想アイテムのパッケージをプレゼントで購入できるのは、エクソラ側のユーザーデータストレージが無効になっているプロジェクトのみです。

使用に適した方

  • Buy Buttonが統合され、仮想アイテム/仮想通貨/ゲームキーモジュールが有効になっているパートナー。
  • サブスクリプションが統合されているパートナー。

Info: この機能は、Checkout APIを使用しているプロジェクトでのみ利用できます。プロジェクト設定 > 統合設定に移動し、Commerce APIを統合するメソッドトグルがオフに設定されていることを確認します。

使用するには

この機能を有効にするには:

  1. 仮想通貨パッケージ仮想アイテムゲームキーパッケージ、またサブスクリプションを構成します。
  2. 次のいずれかの方法で友達リストを送信する方法を選択して実装します:API メソッド経由またはトークン経由
  3. 成功した購入ウェブフックpurchase.giftパラメータ処理を実装します。
  4. アカウントマネージャーに連絡して、セットアップを完了させてください。

トークン経由で友達リストを送信する

贈り主が提案されたリストから受取人を選択できるようにするには、ユーザーの友人のリストをトークンを取得するリクエストpurchase.gift.friends パラメータとして渡します。受信したリストをアプリに表示します。リストに1人のユーザーしか含まれていない場合、このユーザーは自動的にギフトの受取人として定義されます。

贈り主に関する情報を追加するには、トークンを取得するリクエストにpurchase.gift.giver_idpurchase.gift.messagepurchase.gift.hide_giver_from_receiverパラメータを渡してください。

ユーザーへのギフトとしての仮想通貨のトークンの例:

Copy
Full screen
Small screen
"purchase":{
   "virtual_currency":{
       "quantity":100
   },
   "description":{
       "value":"Test Purchase"
   },
   "gift":{
       "giver_id":"John Smith",
       "message":"GG WP",
       "hide_giver_from_receiver" : true,
       "friends": [
       {
        "id": "123",
        "name": "captain",
        "email": "captain@ship.com"
       }]
   }
}

ユーザーへのギフトとしてのサブスクリプションのトークンの例:

Copy
Full screen
Small screen
"purchase": {
  "gift": {
    "giver_id": "John Smith",
    "message": "GG WP",
    "hide_giver_from_receiver": true,
    "friends": [
    {
      "id": "123",
      "name": "captain",
      "email": "captain@ship.com"
    }
    ]
  }
}

APIリクエストで友達のリストを渡す

友達のリストを渡すためのAPIを実装して署名を形成します。署名を付けるには:

  1. パブリッシャーアカウント>プロジェクト設定> ウェブフックウェブフックURLを指定していることを確認します。
  2. リクエスト署名を生成します。
  3. APIリクエストの処理中に、生成された署名とsignパラメータで渡された署名が一致していることを確認してください。

リクエストの例:

Copy
Full screen
Small screen
$ curl -v 'https://your.webhook.url?notification_type=friends_list&user=user_id&query=frien&offset=10&limit=20&sign=12dfg3f5gdsf4g5s6dfg2sdg1' \
-X GET \
-u merchant_id:merchant_api_key

応答の例:

Copy
Full screen
Small screen
[
  {
  "friends": [
      {
        "id": "1",
        "name": "John Carter",
        "email": "carter@xsolla.com",
        "image_url": "https://partner/link/doctor.jpg"
      },
      {
        "id": "2",
        "name": "John Smith",
        "email": "smith@xsolla.com",
        "image_url": "https://partner/link/cook.jpg"
      }
    ],
  "total": 10
  }
]