報酬チェーンを作成する

仕組み

報酬システムは、ユーザーが実際通貨を使ってストア内で購入を行うよう促す仕組みです。購入ごとにユーザーはバリューポイントを獲得し、報酬チェーンを進めていきます。ユーザーがクランに所属している場合、その購入によって獲得したバリューポイントはクラン全体に加算されます。

購入ごとに獲得するバリューポイントを持つ報酬チェーンの例：

用語集

前提条件

ユーザーがバリューポイントを獲得するために購入できるアイテムをストアに含めてください。

クラン報酬チェーンを作成する前に、ユーザークランを設定してください。

バリューポイントを作成する

バリューポイントを作成するには：

1. パブリッシャーアカウントでプロジェクトを開き、LiveOps > Canvasセクションに移動します。

2. バリューポイントリストエリアで、+ アイコンをクリックします。

3. バリューポイントのタイプを選択します — 個人バリューポイントまたはクランバリューポイント。バリューポイントのタイプは作成時に定義され、後から変更することはできません。

4. イメージを追加します（任意）。

5. 名前を入力します。

6. ユニークなバリューポイントSKUを入力します。

7. 次へをクリックします。

8. バリューポイントを割り当てます：

   1. 影響を受けるアイテムを追加をクリックします。

   2. アイテムを選択し、各アイテムの購入に対してユーザーが受け取るバリューポイントの数を指定します。

   3. 選択をクリックします。

   ストアにまだアイテムが含まれていない場合は、現在の設定を保存して後でこのステップに戻ることができます。

9. 次へをクリックします。

10. バリューポイントの設定を確認します。

11. 作成をクリックします。

報酬チェーンを作成する

報酬チェーンを作成します。

1. パブリッシャーアカウントでプロジェクトを開き、LiveOps > Canvasセクションに移動します。
2. 次のいずれかの方法で報酬を作成します：
   1. ツールバーで+アイコンをクリックし、報酬チェーンを選択します。
   2. 報酬チェーンリストエリアで+アイコンをクリックします。
   3. キャンバス上の任意の場所でコンテキストメニューを開き、報酬チェーンを選択します。

3. チェーンタイプを選択します — 個人報酬チェーンまたはクラン報酬チェーン。報酬チェーンのタイプは作成時に定義され、後から変更することはできません。

4. 基本的なチェーンパラメータを指定します：

   1. 個人報酬チェーンを選択した場合：
      1. 報酬チェーン名を指定します。
      2. 説明を提供します。
   2. クラン報酬チェーンを選択した場合：
      1. クランタイプドロップダウンリストで、クランのタイプを選択します。
      2. 報酬チェーン名を指定します。
      3. 説明を提供します。
      4. 報酬チェーンポップアップヘッダーのタイトルを指定します。
      5. ツールチップテキスト（ユーザーがクランのために報酬を得るために必要なこと）を指定します。
      6. 報酬ポップアップ画像を追加します（任意）。

5. 次へをクリックします。

6. バリューポイントを設定します — 新しいバリューポイントを作成するか、既存のものから選択します。

7. 次へをクリックします。

8. チェーンの各ステップに報酬を追加します。単一のステップに報酬を追加するには：

   1. 新しいステップを追加をクリックします。

   2. このステップの報酬としてユーザーが受け取るアイテムを選択し、各アイテムの数量を指定します。

   3. アイテムを追加をクリックします。

9. ステップのリストで、報酬を請求するために必要なバリューポイントの量を指定します。各後続ステップに割り当てられるバリューポイントは、前のステップよりも高くなければなりません。最大制限は、ステップごとに100,000バリューポイントです。

10. チェーン内の報酬の順序を変更するには、☰アイコンを使用して行を希望の位置にドラッグします（任意）。

11. 各ステップに報酬を追加した後、次へをクリックします。

12. 報酬チェーンの有効期間を指定します：タイムゾーン、開始日、終了日。終了日を指定しない場合は、終了日なしボックスにチェックを入れます。

注意

別の報酬チェーンの有効期間を追加するには、期間を追加をクリックしてください。チェーンに複数の有効期間がある場合、それぞれに終了日を指定する必要があります。チェーンは、指定された分の最後の秒に終了します。例えば、終了時刻を12:00に設定した場合、チェーンは12:00:59まで有効です。

同じバリューポイントを複数の報酬チェーンで使用する場合、1つのチェーン期間が終了してから次の開始までに少なくとも15分を空けてください。バリューポイントとステップの進行状況は、毎時 :00、:15、:30、:45 に実行されるバックグラウンドジョブによってリセットされます（正確な期間終了時ではありません）。次の期間がこれらの時間より早く開始されると、ユーザーは以前の残高を保持している可能性があります。ステップの進行状況をすぐにリセットしたい場合は、報酬チェーンをリセットする API メソッドを呼び出してください。

13. 報酬チェーンの進行状況を自動的にリセットするには、バリューポイントをリセットするトグルをオンにします。

14. 報酬チェーンを特定の時間に更新したい場合は、報酬チェーンを更新可能にするトグルをオンにし、更新スケジュールを指定します。

15. 報酬チェーンをパーソナライズしたい場合：

    1. パーソナライズされた報酬チェーントグルをオンにします。

    2. チェーン表示オプションのいずれかを選択します：

       • 適格ユーザーに表示 — この場合、チェーンは指定された条件を満たす認証されたユーザーにのみ表示されます。

       • 不適格ユーザーに表示 — このようなチェーンでは、パーソナライズ条件を指定する必要はありません — デフォルトで適用されます。これは、未認証ユーザーに表示されることを意味し、認証されたユーザーに一致するパーソナライズされた報酬チェーンが見つからない場合にも表示されます。

    3. 適格ユーザーに表示オプションを選択した場合、条件を指定します：

       1. ユーザー属性タイプを指定します — 文字列、数値、または日付。

       2. ドロップダウンリストからユーザー属性を選択します。

       3. 比較演算子を選択します。

       4. ユーザー属性値を指定します。

    4. 条件を追加するには、条件を追加をクリックし、表示されるフィールドに入力します（任意）。

16. 次へをクリックします。

17. チェーンを確認します。

18. チェーンをすぐにアクティブにする場合（任意）、アクティブステータスで作成トグルをオンにします。

19. 作成をクリックします。

注意

アクティブなチェーンは編集できません。プロモーションの設定を変更するには、まず非アクティブにしてください。

チェーンをアクティブ化または非アクティブ化する方法は次のとおりです：

• 報酬チェーンカードから
• 報酬チェーンリストから
• チェーンを編集中に

報酬システムの表示

サイトビルダー経由での表示

報酬システムを正しく機能させるために、ユーザー認証を設定する必要があります。未認証ユーザーには、個人用とクラン用の両方の報酬チェーンが進行状況なしで表示されます。

クランに所属していない認証されたユーザーには、個人用の報酬チェーンのみが表示されます。クラン報酬チェーンは「利用不可」として表示されます。

サイト上に報酬チェーンを表示するには：

1. パブリッシャーアカウントのプロジェクトで、ストアフロント > ウェブサイトセクションに移動します。
2. 対象サイトを選択し、「サイトビルダーを開く」をクリックします。
3. サイトに複数のページが含まれている場合は、必要なページを選択してください：
   1. ビルダー上部にある現在のページタイトルをクリックします。
   2. ドロップダウンリストから必要なページを選択してください。
4. ビルダーのメインエリアで、新しいブロックを追加したい場所を選び、「ブロックを追加」をクリックします。
5. ブロックリストで「報酬システム」を選択します。

6. ドロップダウンリストから、報酬チェーンを選択します。

7. ボタンとテキストの色をカスタマイズできます（任意）。
8. チェーンをプレビューするには、ビルダーの右上隅にある「プレビュー」をクリックしてください。

9. 変更を適用するには、サイトを公開します：
   1. サイトビルダーの右上隅で「公開」をクリックします。
   2. 公開したいページ名の横にあるチェックボックスをオンにします。
   3. 「公開」をクリックします。

サイトビルダーでのバリューポイント表示詳細

単一のブロック内で複数の報酬チェーンを選択し、それらを縦に並べて表示するか、タブで表示するかを選択できます。各報酬チェーンの外観は個別にカスタマイズ可能です。

アイテムカードには、サイトに追加された報酬チェーンのバリューポイントのみが表示されます。ただし、ユーザーがアイテムを購入すると、クランメンバーはサイトに表示されているかどうかにかかわらず、すべてのアクティブな報酬チェーンのバリューポイントを受け取ります。

例：

現在、2つの報酬チェーンが設定されています：1つは個別の報酬チェーンで、Crystalという名称のバリューポイントを持ち、もう1つはククラン向けの報酬チェーンで、Magic Bubbleという名称のバリューポイントを持っています。

アイテムカタログには、Swordという名称のアイテムがあり、バリューポイントが割り当てられています。クランメンバーがこのアイテムを購入すると、Crystalsを20個とMagic Bubblesを40個受け取ります。

ビルダー内でストアブロックを追加し、Swordアイテムを含むアイテムのタイプとグループを選択した時：

1. サイトに報酬チェーンが追加されていない場合、Swordアイテムにはバリューポイントは表示されません。
2. 個別の報酬チェーンのみが追加されアクティブになっている場合、SwordアイテムにはCrystalsが20個だけ表示されます。
3. クラン用報酬チェーンのみが追加されアクティブになっている場合、SwordアイテムにはMagic Bubblesが40個だけ表示されます。
4. 個別およびクラン向けの報酬チェーンの両方がサイトに追加され、有効になっている場合、SwordアイテムにはCrystals20個とMagic Bubbles40個の両方が表示されます。

クランメンバーには、40個のMagic Bubblesがアクティブな値として表示されます。

クランに所属していないユーザーには、40個のMagic Bubblesがロックされた値として表示されます。

APIコール経由での報酬チェーン表示

1. アプリケーションのUIに、報酬チェーンのステップを表示するための要素を実装します。
2. 報酬チェーンとバリューポイントグループにある以下のクライアントサイドAPIコールを使用して、チェーンを操作するためのロジックを実装してください：

3. アイテムがユーザーに正しく付与されていることを確認してください。

ユーザークランのセットアップ

サイトビルダーを使用していない場合は、クラン報酬チェーンが正しく機能するように、エクソーラログインのユーザー属性において、ユーザーのクラン情報を渡す必要があります。

1. ログインの属性スキーマのセットアップします。

 1{
 2	"$schema": "https://json-schema.org/draft/2020-12/schema",
 3	"additionalProperties": false,
 4	"description": "JSON Schema example for user attributes. Not the actual schema.",
 5	"properties": {
 6
 7		"clan_id": {
 8			"description": "name of clan",
 9			"type": "string"
10		},
11		"custom-id": {
12			"description": "custom-id of a user.",
13			"type": "number"
14		},
15		"had_ban": {
16			"description": "Whether the user was banned.",
17			"type": "boolean"
18		},
19		"last_purchase": {
20			"description": "Date of user's last purchase.",
21			"type": "string"
22		},
23	},
24	"required": [],
25	"title": "Example",
26	"type": "object"
27}

2. clan_id属性を追加または更新するには、属性更新メソッドを使用し、リクエスト本文のattributes配列内にクランの値としてclan_idを含めて渡してください。

 1{
 2  "user": {
 3    "id": "1234567890",
 4    "picture": "https://example.com",
 5    "name": "test-name"
 6  },
 7  "attributes": [
 8    {
 9     "key": "clan_id",
10     "value": "beetles"
11    }
12  ]
13}

エクソーラログインによる認証を使用している場合は、現在のユーザーのクランを更新するAPIを呼び出して、ユーザーのクラン情報を更新してください。属性に新しいクランが含まれている場合、ユーザーは以前のクランの報酬チェーンから未請求の報酬を受け取り、クランの所属情報が更新されます。ユーザーが以前クランのメンバーであったが、現在は所属していない場合、そのクランメンバーシップは取り消されます。このメソッドからの応答には、ユーザーがすでに請求した報酬が含まれます。

ウェブショップ向けのセットアップ仕様

属性スキーマを設定した後、ユーザーのクランデータを渡す処理を実装します。

ユーザーIDで認証する場合は、認証時にウェブショップでのユーザー検証ウェブフックのウェブフックへの応答で以下のようにユーザーのクラン情報を渡します：

• clan_id属性を追加または更新するには、clan_id属性キーを持つattributesオブジェクトの配列を渡します。

ウェブフック応答の例：

 1{
 2  "user": {
 3    "id": "1234567890",
 4    "picture": "https://example.com",
 5    "name": "test-name"
 6  },
 7  "attributes": [
 8    {
 9     "key": "clan_id",
10     "value": "beetles"
11    }
12  ]
13}

• ユーザーがクランを脱退し、別のクランに加入していない場合は、clan_idの値をremoving_keysフィールドに渡す必要があります。

ウェブフック応答の例：

 1{
 2  "user": {
 3    "id": "1234567890",
 4    "picture": "https://example.com",
 5    "name": "test-name"
 6  },
 7  "removing_keys": [
 8    {
 9      "key": "clan_id"
10    }
11  ]
12}

API経由でのセットアップ仕様

カスタムID経由での認証するAPIを使用している場合は、ユーザー認証時に現在の属性値を直接渡すことができます。