上报事件
游戏使用的每个 SDK 插件的版本必须一致,包括 launcher 使用的 SDK 版本。如果游戏需要升级一个插件或同时访问不同版本的 SDK,请联系 Player Network 助手。
Player Network 数据洞察服务可上报 Player Network 数据的预定义事件,以及游戏数据的标准和自定义事件。通过数据通道发送这些事件即可实现数据上报。
前提条件
要查看和分析事件数据,需先配置至少一个分析平台。业务可选择开启 Player Network 控制台 的数据报表功能查看数据,请联系 Player Network 助手部署数据。
Player Network 数据洞察服务目前还支持以下分析平台,需要单独进行配置:
- DataBrain
- AiX
- Adjust
- AppsFlyer
- Firebase
- Garena
有关配置步骤,请参见 教程,或参考各平台的官方文档。
步骤1:配置 SDK
在 INTLConfig.ini 配置文件的 ANALYTICS_REPORT_CHANNEL
字段,添加需要上报的数据平台。
[ANALYTICS]
ANALYTICS_REPORT_CHANNEL = INTL,AppsFlyer,Adjust,Facebook,Firebase,Garena
ANALYTICS_REPORT_CHANNEL
字段指定所需上报平台的名称。“INTL” 代表 Player Network 平台,支持的第三方平台包括 Adjust
、AppsFlyer
、Facebook
、Firebase
和 Garena
。如果有多个上报渠道,请用逗号分隔。
有关其他高级配置,请参见以下章节,详细了解可以配置的报告字段和分析字段。
Player Network SDK 上报
字段 | 说明 | 备注 |
---|---|---|
REPORT_ENABLE | 是否开启上报 默认:1,开启 | 选填 |
REPORT_COMPRESS_ENABLE | 是否需要压缩 默认:1,压缩 | 选填 |
REPORT_KV_MAX_LOCAL_FILE_NUM | KV 日志的落地文件最大数量 默认:10 | 选填 |
REPORT_KV_MAX_LOCAL_FILE_SIZE | KV 日志的落地文件大小 单位:字节 默认:262144 | 选填 |
REPORT_KV_TIME_INTERVAL | KV 日志的上报时间间隔 单位:秒 默认:5 | 选填 |
REPORT_BIN_ENABLE | 是否开启二进制日志的文件上报 默认:1,开启 | 选填 |
REPORT_BIN_SEG_SIZE | 二进制日志的文件分片大小 单位:字节 默认:32768 | 选填 |
REPORT_BIN_MAX_LOCAL_FILE_NUM | 二进制日志的落地文件最大数量 | 选填 |
REPORT_BIN_MAX_LOCAL_FILE_SIZE | 二进制日志的最大文件大小 单位:字节 | 选填 |
REPORT_BIN_TIME_INTERVAL | 二进制日志的上报时间间隔 单位:秒 默认:10 | 选填 |
REPORT_SRC_ID | 默认数据上报的来源 ID 默认:1000 | 选填 |
REPORT_LIFECYCLE_ENABLE | 是否随着生命周期变化上报 默认:1,开启,切换到前后台会触发上报请求 | 选填 |
PING_TIMEOUT | 收集网络质量时 ping 的超时 单位:秒 默认:1 | 选填 |
REPORT_DISABLE_COLLECT_METHOD | 禁止上报的 Method ID, 以逗号 (,) 隔开 默认为空(全部上报) 建议填 501,703,706,721,724,731,732,902 | 选填 |
REPORT_DISABLE_COLLECT_EVENT_NAME | 禁用报告事件的名称,用逗号 (,) 隔开 默认值:sdk_update_start | 选填 |
REPORT_UA_DATA_ENABLE | 当前仅支持 Windows 是否启用 UA 上报功能 0:禁用 1:启用 默认:1,启用 | 选填 |
REPORT_UA_DATA_SHORT_CODE_FILTER | 当前仅支持 Windows 配置 UA 短码过滤列表 在列表中的短码会直接上报 (多个短码以英文字符 (,) 隔开) 默认:空字符串 | 选填 |
Player Network SDK 分析
字段 | 说明 | 备注 |
---|---|---|
ANALYTICS_REPORT_CHANNEL | 数据上报的渠道INTL 是 Player Network SDK 的自有渠道 如果接入了 LI PASS, ANALYTICS_REPORT_CHANNEL 配置项必须要开启 INTL | 必填 |
ANALYTICS_CRASH_CHANNEL | Crash 的上报渠道 | 必填 |
ANALYTICS_AUTH_REPORT_ENABLE | 是否自动上报注册和登录事件 可以联系 [killuachen(陈聪聪)] 确认此配置 默认:1,开启(V1.18.00 及以前版本默认关闭) | 选填 |
ANALYTICS_FIREBASE_IS_DELAY | Firebase 是否延迟初始化,如果开关开启,则需要在启动方法中手动调用初始化方法 默认:0 | 选填 |
步骤2:准备上报事件
在使用任何数据洞察功能之前,请通过调用 InitAnalytics
接口初始化数据洞察服务。然后使用要跟踪的设备信息名称调用 IsDeviceInfoCollectEnable
接口检查特定设备信息的收集是否已启用。
iOS IDFA 授权
在 iOS 14.5 及更高版本中,Apple 要求应用程序在收集 IDFA 时获得用户许可,以加强对 iOS 用户的隐私管理。
- 在 iOS 的 "AppTrackingTransparency.framework "中添加依赖关系。
- 在
Info.plist
文件中,为显示的玩家同意提示文本和配置添加NSUserTrackingUsageDescription
。 - 调用
static void RequestTrackingAuthorization();
来实现获取玩家同意收集 IDFA 的提示。- 此界面专为 iOS 设计并使用 Xcode 12 或更高版本开发,与运行 iOS 14.5 或更高版本的设备兼容。
- 该界面会发出一次性请求,系统会保存用户的选择。除非用户卸载并重新安装应用程序,否则不会再出现任何通知。
Android 设备的 Google 广告 ID
AD_ID
权限(<uses-permission android:name="com.google.android.gms.permission.AD_ID"/>
)是收集 Google 广告 ID 所必需的。使用广告 ID 的 Android 13 (API 33) 应用程序必须在 Google Play 控制台中声明这一点。您需要在 Google Play 控制台 > 策略 > 应用程序内容 > 广告 ID 中打开开关。
Player Network SDK 默认开启 AD_ID
采集。如需撤销可将以下配置添加到 AndroidManifest.xml
文件中:
<uses-permission android:name="com.google.android.gms.permission.AD_ID" tools:node="remove" />
有关 Google Advertising ID 的更多信息,请参见 Advertising ID 和 AdvertisingIdClient.Info 。
步骤3:上报事件
调用 ReportFunnel
接口上报预定义事件的数据,以便在漏斗分析中计算用户转换率。
- Unity
- Unreal Engine
int error_code = 0;
INTLAPI.ReportFunnel(FINTLFunnelStep.kStartAppLaunch, error_code);
int error_code = 0;
UINTLSDKAPI::ReportFunnel(step_name, error_code);
调用 ReportFunnelCustomEvent
接口上报自定义事件的数据,以便在漏斗分析中计算用户转换率。
- Unity
- Unreal Engine
string l1_event_name = "l1_event_name";
string l2_event_name = "l2_event_name";
int error_code = 0;
INTLAnalytics.ReportFunnelCustomEvent(l1_event_name,l2_event_name, error_code);
FString l1_event_name = "l1_event_name";
FString l2_event_name = "l2_event_name";
int error_code = 0;
UINTLSDKAPI::ReportFunnelCustomEvent(l1_event_name, l2_event_name, error_code);;
步骤4:验收数据
为确保所有上报数据准确无误,请:
- 验证关键字段和值字段是否与上报的数据一致,包括大小写、下划线和间距。
- 检查在上报过程中是否丢失了关键字段或值字段。