自定义事件上报(ReportEvent)
[Player Network SDK & MSDK] 上报自定义事件。其中 Adjust 渠道需要提前在 Adjust 控制面板注册 event,获取 event token,方能成功上报。
支持渠道:
- Adjust
- AppsFlyer
- Firebase
[仅限 MSDK] 渠道:
- Beacon
- TDM
[仅限 Player Network SDK] 渠道:
- INTL
- Garena
支持的平台
- Unity
- Unreal Engine
支持
Android, iOS, Windows
平台。支持
Android, iOS, Windows
平台。警告
Windows 平台只支持 INTL 渠道。
函数定义
- Unity
- Unreal Engine
void ReportEvent(
string eventName,
Dictionary<string, string> paramsDic,
string spChannels = "",
bool isRealTime = true);
static void ReportEvent(
const std::string &event_name,
std::map<std::string, std::string> ¶ms,
const std::string &specific_channel = "",
bool is_real_time = true,
const std::string &extra_json = "{}");
入参说明
- Unity
- Unreal Engine
参数名称 | 参数类型 | 说明 |
---|---|---|
eventName | string | 事件名 1. Adjust 渠道,要求填写 event token 来追踪事件 2. AppsFlyer 渠道,建议仅将小写字母数字字符(a-z 和 0-9)用于应用内事件名称 3. Facebook 渠道,事件和参数必须由 2至 40个字母数字字符组成,且每个参数值的长度不能超过 100个字符 4. Firebase 渠道,要求含 1至 40个字母数字字符或下划线。名称必须以字母字符开头。请注意,事件名称区分大小写,并且记录两个名称仅大小写不同的事件将导致两个不同的事件。 |
paramsDic | Dictionary<string, string> | 需要上报的参数 key-value 的形式 Adjust 渠道不会用到。可以传个空字典。 参数不能带有 | 符号。 |
spChannels | string | 指定渠道 1. 若无指定渠道,可填空字符串,空字符串默认上报已初始化的渠道,即 MSDKConfig.ini 或者INTLConfig.ini 配置的上报渠道。更多信息,请参见 MSDK 文件 或者 Player Network 文档。 2. 指定上报到某个渠道,例如 "Facebook"。 3. 指定上报到多个渠道,渠道之间用英文逗号“,”分隔,例如 "Facebook, Firebase"。 |
isRealTime | bool | 是否实时上报 |
参数名称 | 参数类型 | 说明 |
---|---|---|
event_name | std::string | 事件名 1. Adjust 渠道,要求填写 event token 来追踪事件 2. AppsFlyer 渠道,建议仅将小写字母数字字符(a-z 和 0-9)用于应用内事件名称 3. Facebook 渠道,事件和参数必须由 2至 40个字母数字字符组成,且每个参数值的长度不能超过 100个字符 4. Firebase 渠道,要求含 1至 40个字母数字字符或下划线。名称必须以字母字符开头。请注意,事件名称区分大小写,并且记录两个名称仅大小写不同的事件将导致两个不同的事件。 |
params | std::map <std::string, std::string> | 需要上报的参数 key-value 的形式 |
specific_channel | std::string | 指定渠道 1. 若无指定渠道,可填空字符串,空字符串默认上报已初始化的渠道,即 MSDKConfig.ini 或者INTLConfig.ini 配置的上报渠道。更多信息,请参见 MSDK 文件 或者 Player Network 文档。 2. 指定上报到某个渠道,例如 "Facebook"。 3. 指定上报到多个渠道,渠道之间用英文逗号“,”分隔,例如 "Facebook, Firebase"。 |
is_real_time | bool | 是否实时上报 |
extra_json | std::string | 扩展信息,必须是 JSON 结构 仅 Adjust 渠道上报关注此参数,若使用 Adjust partner parameter 则需使用此参数。代码示例:"{\"isPartnerParameters\":true}"。如果此字段为空,或者设置 false,则上报参数则会被设置到 Adjust 的 callback_params 中 |
代码示例
- Unity
- Unreal Engine
Dictionary<string, string> paramsDic = new Dictionary<string, string>();
// TODO: Add key-value pair
UnionAdapterAPI.GetReportService().ReportEvent("event", paramsDic);
std::map < std::string, std::string> _params_map
// TODO: Add key-value pair
GUA_NAMESPACE::GUAReportService::ReportEvent("Event", _params_map);