礼物配置指引

最近更新时间:2025-07-15 11:06:31

我的收藏

礼物系统简介

礼物相关信息由礼物、礼物分类、礼物与分类关系、语言信息四部分组成。四部分包含的信息如下:
礼物:包括了GiftId、礼物默认名称、礼物默认描述、礼物等级、礼物的虚拟货币价格、图标、自定义扩展信息。其中GiftId是礼物在系统中的唯一标识,是后续操作的对象。礼物的虚拟货币价格,用于礼物展示的“标价”,虚拟货币与实际支付金额对应关系需业务另外自行定义。
礼物分类:包括了 CategoryId、分类默认名称、分类默认描述、自定义扩展信息。与 GiftId 相同,GategoryId 为礼物分类在系统中的唯一标识,是后续操作的对象。
注意:
礼物分类信息并不包括礼物和分类的关系。
礼物与分类关系:用于描述一个分类下有哪些礼物
语言信息:礼物与礼物分类的名称与描述支持国际化,语言信息用于记录不同语言下礼物描述的翻译。
注意:
在使用 SDK 获取礼物列表时,如礼物或礼物分类未设置指定语言的名称和描述,则返回设置礼物时默认的礼物名称和描述。

礼物系统配置流程

组件中的礼物功能需要对应应用(SDKAppID)为 TUILiveKit 体验版或大规模直播版 方可使用,开通后再有序的添加礼物相关信息,下面给出礼物配置顺序:
1. 添加礼物和礼物分类
首先添加礼物和礼物分类,添加后会得到若干 GiftId 和 CategoryId,利用这些 Id可以进行后续操作,添加方法见 添加礼物添加礼物分类
2. 添加礼物分类与礼物关系
利用上一步得到的 GiftId 与 CategoryId,设置对应关系,操作方法见 添加礼物分类关系
3. 添加礼物与礼物分类的语言信息
这一步不是必要步骤,如果有国际化的需求可进行设置,操作方法见 添加礼物语言信息添加礼物分类语言信息
配置顺序如下图所示: