奖励系统

词汇表

运行机制

奖励系统可以激励用户使用真实货币在商店中购买商品。如果用户是公会成员，其购买将为整个公会贡献奖励积分。

您可以创建个人和公会奖励链，并为用户购买的商品提供奖励。游戏可以包含多个任意类型的奖励链。每个奖励链最多可以包含31个步骤。您需要为每个等级设定完成所需的奖励积分数量。

您还可以创建个性化奖励链。通过个性化功能，可根据用户属性仅向特定授权用户群体显示奖励链。您可以为单个用户或公会设计个性化奖励链。

在奖励链的每个步骤中，用户可以获得1至10个奖励。公会中的每个成员在每个步骤也可以获得1至10个奖励。

您可以向用户发放以下类型的商品奖励：

• 虚拟物品
• 虚拟货币
• 虚拟货币套餐
• 捆绑包

为确保奖励系统正常运行，必须配置用户身份认证。对于未经身份认证的用户，个人和公会奖励链都会显示，但没有进度。已经过身份认证但不是公会成员的用户只能看到其个人奖励链。公会奖励链将显示为不可用。

用户流程

1. 用户访问网站。
2. 用户看到商品目录、奖励系统和每个商品可获得的奖励积分数量。
3. 用户进行登录。
4. 然后用户即可查看其在奖励系统中的当前进度。
5. 当用户进行购买时，其奖励链进度会相应提升。

如何获取

要设置奖励系统，需要以下详细信息：

• 奖励系统的开始和结束日期

• 用于推进个人和公会奖励链进度的奖励积分的图片、描述、SKU和名称
• 奖励积分数量
• 奖励链中的商品

请参阅下方示例。

奖励链：

描述	示例
名称	水晶碎片
说明文字	收集水晶碎片获得奖励。
SKU	ExampleSKU003
图片或图片URL

在己侧实现以下功能：

• 在商店中显示奖励系统的以下元素：
  • 购买目录中商品可获得的奖励积分数量
  • 奖励积分
  • 步骤
  • 奖励链
  • 已授权用户的奖励积分余额
  • 奖励
• 向艾克索拉登录管理器发送用户的公会数据

通过发布商帐户进行设置

在创建奖励链之前，需要创建奖励积分、奖励以及用户和公会可购买以获得奖励积分的商品。

创建奖励积分

要创建奖励积分：

1. 在发布商帐户中打开您的项目，前往LiveOps > 奖励部分。
2. 在奖励选项卡中，单击创建奖励积分。

3. 指定以下参数：
   • 添加图片（可选）。
   • 为奖励积分输入唯一的SKU。
   • 指明奖励积分是否用于公会。
   • 为奖励积分指定名称。

4. 单击下一步。
5. 选择虚拟物品的SKU并指定用户每次购买可获得的奖励积分数量。
6. 单击+添加所需物品数量。
7. 单击保存。

创建的奖励积分将显示在奖励链上方。公会奖励积分会相应标记。要更改特定奖励积分的设置，请在对应行中单击编辑。

创建奖励链

要创建奖励链：

1. 在发布商帐户中打开您的项目，前往LiveOps > 奖励部分。
2. 单击创建奖励。

3. 选择新奖励链类型 — 个人奖励链或公会奖励链。
4. 指定以下参数，如果选择个人奖励链：
   1. 指定奖励链名称。
   2. 填写描述。
   3. 在下拉列表中选择奖励积分。

如果选择公会奖励链：
1. 在公会类型下拉列表中选择公会类型。
2. 设置公会奖励链参数：
   1. 指定奖励链名称。
   2. 填写描述。
   3. 指定奖励链弹窗标题。
   4. 指定弹窗提示文本（说明用户如何为公会获得奖励）。
   5. 添加图片（可选）。
   6. 在下拉列表中选择奖励积分。

5. 单击下一步。
6. 单击添加新步骤。
7. 指定以下参数，然后单击保存：
   1. 步骤名称。
   2. 领取奖励所需的奖励积分数量。
   3. 该步骤所需的虚拟物品数量。
8. 单击下一步。

9. 如需个性化奖励链：

   1. 将个性化奖励链开关设为启用状态。
   2. 选择以下任一显示选项并单击下一步：
      • 向特定用户显示奖励链。启用后，奖励链仅向满足指定条件的授权用户显示。
      • 向不满足条件的用户显示奖励链。启用后，仅在未找到匹配的奖励链时显示（例如用户未授权或其属性与任何个性化链不匹配）。
   3. 如果选择向特定用户显示奖励链：
      1. 单击添加条件并设置个性化条件：
         • 用户属性指用户特征，如国家/地区或年龄。可在登录管理器部分配置属性。
         • 属性类型用于定义属性值的格式：字符串、数字或日期。
         • 比较运算符用于确定如何将用户属性值与指定条件进行比较，例如等于、大于、小于或包含。
         • 属性值是用于比较的具体值。例如，如果用户属性为年龄，属性类型为数字，比较运算符为大于，属性值为18，则奖励链将仅向18岁以上的用户显示。
      2. 要添加其他个性化条件，请单击添加条件。
   4. 单击下一步。

10. 创建所需数量的阶段步骤并单击保存。

11. 单击下一步。
12. 指定奖励链的有效期。
13. 如需在特定时间更新奖励链，请将将奖励链设置为可更新开关设置为开并指定更新模式。

14. 单击保存。

1. 在奖励目录中，选择奖励链。
2. 单击•••并从下拉列表中选择激活。

在建站器中设置奖励系统区块

要在建站器中向页面添加奖励系统区块：

1. 在发布商帐户中打开您的项目，然后前往商店 > 网站部分。
2. 在所需网站的窗格中，单击打开建站器。

3. 在网站模板中单击添加区块。
4. 在区块列表中选择奖励系统。

5. 在下拉列表中，选择已在建店器中配置的奖励链。

6. 自定义按钮和文本颜色（可选）。
7. 单击建站器右上角的预览查看奖励系统。单击发布以发布网站。

通过API调用进行设置

您可以使用奖励链和奖励积分方法组中管理子部分的方法来管理奖励系统。

1. 通过创建奖励积分API创建可用于获取奖励的奖励积分。
2. 使用设置商品的奖励积分API为特定商品分配奖励积分 — 用户购买这些商品后将获得相应的积分。

3. 通过创建奖励链API创建奖励系统。要创建个性化奖励链，请在attribute_conditions数组中传递显示条件。

   您可以指定当用户没有条件中定义的属性时，是否向其显示个性化奖励链。方法是在can_be_missing参数中传递true。

   您还可以定义一个在未找到匹配的个性化奖励链时向用户显示的奖励链。为此，请在is_always_visible参数中传递false。

4. 使用切换奖励链API激活奖励系统。

您也可以修改、禁用或删除奖励系统，以及移除商品的奖励积分。

在商店界面显示奖励系统的功能

显示奖励积分的功能

您可以在单个区块中选择多个奖励链，并选择它们的显示方式 — 一个接一个显示或以选项卡形式显示。您可以单独自定义每个奖励链的外观。

商品卡片仅显示已添加到网站的奖励链的奖励积分。但是，当用户购买商品时，公会成员将获得所有已激活奖励链的奖励积分，无论这些奖励链是否在网站上显示。

示例：

假设已设置两个奖励链：一个个人奖励链和一个公会奖励链。个人奖励链使用Crystal作为奖励积分，公会奖励链使用Magic Bubble作为奖励积分。

商品目录中有一件名为Sword的商品，并已分配奖励积分。当公会成员购买该商品时，将获得20个Crystals和40个Magic Bubbles。

当您在建站器中添加商店区块并选择包含Sword商品的类型和商品组时：

1. 如果尚未在网站中添加任何奖励链，Sword商品将不会显示任何奖励积分。
2. 如果仅添加并激活了个人奖励链，Sword商品将仅显示20个Crystals。
3. 如果仅添加并激活了公会奖励链，Sword商品将仅显示40个Magic Bubbles。
4. 如果同时添加并激活了个人和公会奖励链，Sword商品将同时显示20个Crystals和40个Magic Bubbles。

对于公会成员来说，40个Magic Bubbles将显示为激活值。

对于非公会成员用户来说，40个Magic Bubbles将显示为锁定值。

定义用户公会

艾克索拉不会创建公会或存储公会成员信息。您需要在己侧实现公会系统，并通过用户属性传递公会相关数据。

要确保正确发送和处理公会数据：

1. 在登录管理器中设置属性方案。添加clan_id属性。

登录管理器中的属性方案示例：

 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. 实现发送用户公会数据：

• 通过用户ID进行身份认证时，在网页商城Webhook的用户验证Webhook响应中传递用户的公会：
• 要添加或刷新clan_id属性，请传递包含clan_id属性键的attributes对象数组。

Webhook响应示例：

 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}

• 如果用户已退出公会且尚未加入其他公会，则需要在removing_keys字段中传递clan_id值。

Webhook响应示例：

 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更新用户的公会。