App SDK 预置事件和预置属性
|
收藏
预置事件
事件英文变量名 | 事件显示名 | 属性英文变量名 | 事件属性显示名 | 属性值类型 | 属性值示例或说明 | 触发时机 | 备注 |
---|---|---|---|---|---|---|---|
$AppStart | App 启动 | $预置属性 | 启动 App 或从后台切换进入 App 时触发 | manufacturer Android/iOS SDK 通用性采集,开启AutoTrack接口将自动开启,文档请参考客户端 SDK 集成文档。
| |||
$is_first_time | 是否首次 | 布尔值 | 表示是否是首次启动 App,可参考文档新增用户及首日首次标记 | ||||
$resume_from_background | 是否从后台唤醒 | 布尔值 | |||||
$screen_name | 页面名称 | 字符串 | Activity 的包名.类名(仅 Android 端有,iOS 端的启动逻辑并不需要跳转到某个页面即可判断是否启动,因此 iOS 端启动时采集不到页面名称) | ||||
$title | 页面标题 | 字符串 | Activity 的标题(仅 Android 端有,iOS 端的启动逻辑并不需要跳转到某个页面即可判断是否启动,因此 iOS 端启动时采集不到页面标题) | ||||
$AppEnd | App 退出 | $预置属性 | 退出 App 或 App 进入后台时触发 | ||||
$event_duration | 停留时长 | 数值 | 本次 App 启动到 App退出的时长,单位为 秒 | ||||
$screen_name | 页面名称 | 字符串 | Activity 的包名.类名(仅 Android 端有,iOS 端的退出逻辑并不需要跳转到某个页面即可判断是否退出,因此 iOS 端退出时采集不到页面名称) | ||||
$title | 页面标题 | 字符串 | Activity 的标题(仅 Android 端有,iOS 端的退出逻辑并不需要跳转到某个页面即可判断是否退出,因此 iOS 端退出时采集不到页面标题) | ||||
$AppViewScreen | App 浏览页面 | $预置属性 | 打开一个 Activity / ViewController 页面时触发(对于Android Fragment 默认不会触发浏览页面事件,如果采集,需要单独开启) | ||||
$screen_name | 页面名称 | 字符串 | Activity 的包名.类名(Android 端) / ViewController 的类名(iOS 端);可手动设置该属性的值 | ||||
$title | 页面标题 | 字符串 | Activity 的标题(Android 端)/ViewController 的标题(iOS 端) | ||||
$url | 页面地址 | 字符串 | 自动采集的版本 Android:3.2.8,iOS:1.11.5 | ||||
$referrer | 前向地址 | 字符串 | 自动采集的版本 Android:3.2.8,iOS:1.11.5 | ||||
$AppClick | App 元素点击 | $预置属性 | 点击控件时触发 Android 端: CheckBox、RadioButton、button、SwitchCompat、Spinner、TextView、ImageView、ImageButton、SeekBar、RatingBar、RadioGroup、Menultem、ExpandableListView、Dialog、ListView、GridView、TabHost 等 iOS 端: UIButton、UIBarButtonItem、UISwitch、UISlider、UISegment、UIPageControl、UIStepper、UILabel + 手势、UIImageView + 手势、UIAlertController、UIMenu 等 | ||||
$screen_name | 页面名称 | 字符串 | Activity 的包名.类名(Android 端) / ViewController 的类名(iOS 端);可手动设置该属性的值 | ||||
$title | 页面标题 | 字符串 | Activity 的标题(Android 端)/ViewController 的标题(iOS 端) | ||||
$element_position | 元素位置 | 字符串 | 元素在模块中的位置,从 0 开始。 只有特殊控件下,该属性才会采集到值(比如 iOS 端的 UITableView 和 UICollectionView 等,Android 端的 ListView 等。对于采集不到该属性值的控件,该属性值在神策分析页面展示为「未知」。 | ||||
$element_id | 元素ID | 字符串 | Android 端默认会获取; iOS 端每个控件一般不会设置 ID,因此 iOS 端默认会不获取。可手动设置 | ||||
$element_content | 元素内容 | 字符串 | 控件代码内设置的元素内容,如果一个控件中没有设置元素内容,或者控件类型为图片,则该属性采集不到值,在神策事件分析页面展示为 「未知」。因此如果发现某个按钮的内容采集不到值,需要和客户的研发同学确认下这个按钮控件的类型,以及是否有在代码中设置元素内容。 | ||||
$element_type | 元素类型 | 字符串 | 控件的类型,例如 Button | ||||
$element_selector | 元素选择器 | 字符串 | 该属性主要记录一个按钮在 APP 中的位置,神策的 App 点击图展示时会使用到此属性,业务人员无需关注此属性的取值逻辑。 | ||||
$element_path | 元素路径 | 字符串 | 可视化全埋点功能会采集该属性的值,需要手动代码开启 | ||||
AppInstall / $AppInstall | App 激活 / App 安装后首次启动 | $预置属性 | 需要调用 trackInstallation / trackAppInstall 接口采集采集该事件,且App 安装后首次打开才会触发,第二次打开不会再触发。 | 神策分析 Android SDK v4.3.6+、iOS SDK v2.1.14+ 增加 trackAppInstall 接口,调用该接口会采集 $AppInstall 事件 若用原记录的激活事件名不是 $AppInstall,需要使用虚拟事件将原激活事件和 $AppInstall 合并分析数据,具体咨询神策技术支持 | |||
$browser | 浏览器名 | 字符串 | 通过 UA 解析出来的值 | ||||
$utm_source | 广告系列来源 | 字符串 | 需要使用神策 App 渠道追踪方法,渠道匹配成功之后,AppInstall 事件才会有 $utm 相关的属性,具体可参考神策的 App 渠道追踪。 | ||||
$utm_medium | 广告系列媒介 | 字符串 | |||||
$utm_term | 广告系列字词 | 字符串 | |||||
$utm_content | 广告系列内容 | 字符串 | |||||
$utm_campaign | 广告系列名称 | 字符串 | |||||
$ios_install_source | / | 字符串 | 记录 App 精准匹配时的匹配字段,比如 IMEI、Android ID、Mac 地址、IDFA。在 App 端采集数据时,会上传此字段,但是在 extractor 模块会将该字段去掉不入库。因此该属性不会入库。 | ||||
$utm_matching_type | 渠道追踪匹配模式 | 字符串 | 在 App 端采集事件时默认没有该属性,而是在 extractor 模块添加,是App 渠道追踪匹配成功时,记录渠道匹配成功的模式,比如设备指纹模糊匹配,设备标识精准匹配,如果没有匹配成功,该属性值在事件分析页面展示为「未知」。 | ||||
$matched_key | 渠道匹配关键字 | 字符串 | 在 App 端采集事件时默认没有该属性,而是在 extractor 模块添加,是App 渠道追踪匹配成功时,记录匹配关键字段,比如是用 IMEI 匹配成功的,则记录 md5 后的IMEI,如果是用 IP_UA 的方式匹配成功的,则记录为 IP_UA。如果没有匹配成功,该属性值在事件分析页面展示为「未知」。 | ||||
$matching_key_list | 渠道匹配关键字列表 | 字符串 | SA 1.14 版本后支持;在 App 端采集事件时默认没有该属性,而是在 extractor 模块添加,是记录该激活事件所有可匹配的关键字,比如 md5 后的 IMEI,Android ID,oaid ,IP_UA 等。在匹配的时候,会按照这些关键字的优先级,和点击广告时记录的关键字进行匹配。 | ||||
$channel_active_period_day | 有效激活窗口期(天) | 数值 | 记录窗口期配置的信息,因窗口期变化造成的激活变化也可进行溯源。 | ||||
$channel_attribute_period_hour | 激活归因窗口期(小时) | 数值 | |||||
asa_iad_info | Apple 搜索广告归因数据 | 字符串 | Android 无此属性; iOS 集成广告 SDK , iOS 系统版本大于等于 10.0 且开启 IDFA 权限时有此属性; | ||||
asa_adservices_info | Apple 搜索广告归因数据 | 字符串 | Android 无此属性; iOS 集成广告 SDK , iOS 系统版本大于等于 14.3 且没有 IDFA 权限时有此属性。 | ||||
AppCrashed | App 崩溃 | $预置属性 | 只有在开启崩溃采集时才会采集 | APP 崩溃 | |||
app_crashed_reason | 崩溃原因 | 字符串 | |||||
$AppStartPassively | App 被动启动 | $预置属性 | iOS APP 被系统拉活 | iOS 端有此事件,Android 端没有。 | |||
$app_state | App状态 | 字符串 | iOS 端会默认获取,Android 端不会获取 | ||||
$resume_from_background | 是否从后台唤醒 | 布尔值 | |||||
$is_first_time | 是否首次 | 布尔值 | 表示是否是首次启动 App,可参考文档新增用户及首日首次标记 | ||||
$AppRemoteConfigChanged | 远程控制配置变化 | $预置属性 | 获取远程配置,SDK 加载配置生效后,采集该事件,并采集对应的控制信息,用于问题排查 | SDK 获取到远程配置 | Android SDK 4.4.1+ iOS SDK 2.1.8+ | ||
$app_remote_config | 远程控制配置信息 | 字符串 | |||||
$AppDeepLinkLaunch | 深度链接唤醒 App | $预置属性 | App 被 DeepLink 唤醒时 | 用于分析 App 被 DeepLink 唤醒的相关数据;该事件中的 $utm_xxx、$latest_utm_xxx 属性,SDK 端无法直接采集,需要依赖后端补充 Android SDK 4.2.1+ iOS SDK 2.1.2+ | |||
$deeplink_url | 深度链接地址 | 字符串 | 唤醒 App 的 DeepLink 链接 | ||||
$utm_source 等 5 个属性 | 广告系列来源等 | 字符串 | |||||
$latest_utm_source 等 5 个属性 | 最近一次广告系列来源等 | 字符串 | |||||
$AppDeeplinkMatchedResult | 深度链接匹配结果 | $预置属性 | SDK 请求解析 DeepLink 的配置完成后触发该事件 | Android SDK 4.2.1+ iOS SDK 2.1.2+ | |||
$deeplink_url | 深度链接地址 | 字符串 | 唤醒 App 的 DeepLink 链接 | ||||
$event_duration | 事件时长 | 数值 | |||||
$deeplink_options | 深度链接参数 | 字符串 | 网页端配置的深度链接参数 | ||||
$deeplink_match_fail_reason | 深度链接匹配失败原因 | 字符串 | |||||
$utm_source 等 5 个属性 | 广告系列来源等 | 字符串 | |||||
$AppPushClick | App 推送点击 | $预置属性 | 推送被点击时触发 | ||||
$app_push_msg_title | 推送消息标题 | 字符串 | |||||
$app_push_msg_content | 推送消息内容 | 字符串 | |||||
$app_push_service_name | 第三方推送服务商 | 字符串 | 可能的取值有:JPush | ||||
$app_push_channel | App 推送通道 | 字符串 | 可能的取值有:HUAWEI、OPPO、vivo、Xiaomi、Meizu | ||||
$sf 开头的属性 | 神策营销云相关的属性 | 仅在点击神策营销云下发的推送时会带有这些属性,详细信息参考此文档 | |||||
$ABTestTrigger | A/B 测试 | $预置属性 | 命中试验时触发 | Android SDK v4.3.6 及以上版本 iOS SDK v2.1.14 及以上版本 | |||
$abtest_experiment_id | 具体的试验 ID | 字符串 | |||||
$abtest_experiment_group_id | 具体的试验分组 ID | 字符串 | |||||
$is_control_group | 是不是分群用户 | 布尔值 | 表示分群用户/ 随机流量用户 | ||||
$AppPageLeave | 页面离开 | $预置属性 | 离开页面后,上报页面离开事件 | Android SDK v5.4.2 及以上版本 iOS SDK v3.1.5 及以上版本 | |||
$event_duration | 页面浏览时长 | 数值 | 在页面离开不可见时触发页面离开事件,并计算浏览时长 | ||||
$screen_name | 页面名称 | 字符串 | Activity 的包名.类名(Android 端) / ViewController 的类名(iOS 端);可手动设置该属性的值 | ||||
$title | 页面标题 | 字符串 | Activity 的标题(Android 端)/ViewController 的标题(iOS 端) | ||||
$url | 页面地址 | 字符串 | 自动采集的版本 Android:3.2.8,iOS:1.11.5 | ||||
$referrer | 前向地址 | 字符串 | 自动采集的版本 Android:3.2.8,iOS:1.11.5 |
所有事件都有的预置属性
属性名 | 属性类型 | 默认显示名 | 说明 | 备注 |
---|---|---|---|---|
$app_id | 字符串 | 应用唯一标识 | App 的唯一标识 | Android SDK 4.1.0 版本支持 iOS SDK 2.0.9 版本支持 |
$app_name | 字符串 | 应用名称 | 应用的名称 | Android SDK v4.2.8 版本支持 iOS SDK 2.1.8 版本支持 |
$app_version | 字符串 | 应用版本 | APP 的应用版本 | |
$lib | 字符串 | SDK类型 | SDK 类型,比如 Android/iOS | Android SDK v5.2.5 鸿蒙系统采集值为 Android |
$lib_version | 字符串 | SDK版本 | SDK 版本 | |
$manufacturer | 字符串 | 设备制造商 | 设备制造商 | Android SDK v5.2.2 取值全部大写 |
$brand | 字符串 | 设备品牌 | 设备品牌 | Android SDK v5.2.2 新增属性,只有 Android 端采集 |
$model | 字符串 | 设备型号 | 设备型号 | |
$os | 字符串 | 操作系统 | 操作系统 | Android SDK v5.2.5 新增鸿蒙系统采集 |
$os_version | 字符串 | 操作系统版本 | 操作系统版本 | Android SDK v5.2.5 新增鸿蒙系统操作版本采集 |
$referrer_title | 字符串 | 前向页面标题 | 前一个页面标题 | Android SDK 4.4.7 版本支持 iOS SDK 2.2.5 版本支持 默认不采集,可以通过 SAConfigOptions 中 enableReferrerTitle 配置开启 开启后在 $AppClick 和 $AppViewScreen 事件中采集该属性 |
$screen_height | 数值 | 屏幕高度 | 屏幕高度(iOS 端是逻辑分辨率,开发中的点像素;Android 采集的是物理像素点,例如 Android 手机分辨率是 1920 x 1080,采集到的就是这个值。) | |
$screen_width | 数值 | 屏幕宽度 | 屏幕宽度(iOS 端是逻辑分辨率,开发中的点像素;Android 采集的是物理像素点,例如 Android 手机分辨率是 1920 x 1080,采集到的就是这个值。) | |
$wifi | 布尔值 | 是否 WiFi | 事件触发时是否为 WiFi | |
$carrier | 字符串 | 运营商名称 | 事件触发时设备 SIM 卡的运营商名称,如果 Android 没有获取 READ_PHONE_STATE 权限,或者未插卡,则无法获取运营商名称;如果 iOS 未插卡,则无法获取运营商名称 | iOS SDK v4.8.3 开始不再采集 |
$network_type | 字符串 | 网络类型 | 事件触发时的网络类型,如果 SDK 没有获取网络类型的权限,或者手机为飞行模式、未插卡且没有连接 WiFi等情况,则无法获取网络类型。 | |
$timezone_offset | 数值 | 时区偏移量 | App 或系统的时区 | Android SDK 4.1.0 版本支持 iOS SDK 2.0.9 版本支持 |
$is_first_day | 布尔值 | 是否首日访问 | 表示是否是首日触发事件,此属性可用于筛选新老用户,具体取值逻辑可参考文档 新增用户及首日首次标记 | Android SDK 1.6.27 版本支持 iOS SDK 1.6.29 版本支持 |
$is_login_id | 布尔值 | 是否登录 ID | 数据入库时判断添加 | |
$ip | 字符串 | IP | 后端通过解析 HTTP 请求而得到 | |
$country | 字符串 | 国家 | 由 IP 解析得到 | |
$province | 字符串 | 省份 | ||
$city | 字符串 | 城市 | ||
$device_id | 字符串 | 设备ID | Android 端主要取 Android ID ,iOS 端先尝试获取 IDFA,如果获取不到,则取 IDFV,具体取值逻辑可参考文档 如何准确的标识用户 |
|
$screen_orientation | 字符串 | 屏幕方向 | 只有在开启 enableTrackScreenOrientation: 时才会采集 | Android/iOS 1.10.1 版本支持 |
$latitude | 数值 | GPS信息 | 纬度*106 只有在开启 enableTrackGPSLocation: 时才会采集 | Android/iOS 1.10.1 版本支持 Android 端需要手动传入 |
$longitude | 数值 | GPS信息 | 经度*106 只有在开启 enableTrackGPSLocation: 时才会采集 | Android/iOS 1.10.1 版本支持 Android 端需要手动传入 |
$geo_coordinate_system | 字符串 | 坐标系 | 只有在开启 enableTrackGPSLocation: 时才会采集 | Android v5.2.2 版本支持 iOS v2.6.4 版本支持 iOS 端默认为 WGS84 Android 端需要手动传入 |
$anonymization_id | 字符串 | 匿名化 ID | 经过 base64 混淆后的 $device_id | Android v6.2.0 ~ v6.2.5 版本支持 iOS v4.2.0 ~ v4.2.3 版本支持 SDG v0.8.11738 + SCA 命令可联系神策运维同学执行 |
追踪并进行渠道匹配和回传时的预置事件属性
属性名 | 属性类型 | 默认显示名 | 说明 | 备注 |
---|---|---|---|---|
$channel_device_info | 字符串 | 记录渠道匹配的设备信息 | App 渠道追踪自定义事件时进行渠道匹配,可以调用 - | SA 1.15+ 版本后支持 |
$is_channel_callback_event | 布尔值 | 是否进行渠道匹配回调 | App 渠道追踪自定义事件时进行渠道匹配,可以调用 - trackChannelEvent:properties: 对待匹配的事件进行追踪,后台匹配到渠道信息后会将结果回传到渠道商。具体使用,可以参考 SDK 的 API 文档。 | SA 1.15+ 版本支持; 默认只有第一次触发渠道追踪自定义事件时,该属性的值为 ture,表示匹配成功会,会给广告商回调渠道数据。后续再次触发该事件时,该属性值为 false。 |
预置用户属性
属性名 | 属性类型 | 默认显示名 | 说明 | 备注 |
---|---|---|---|---|
$first_visit_time | Datetime(时间) | 首次访问时间 | 调用 trackInstallation / trackAppInstall 接口后,新用户首次启动App, 会给此属性赋值 | 该属性是在调用 trackInstallation / trackAppInstall 接口时设置的, 一般标记在匿名 ID (Android ID/IDFA)的用户身上,如果登录 ID 和匿名 ID 没有关联成功,则登录 ID 用户的该属性值没值。 |
$utm_source | 字符串 | 首次广告系列来源 | 这些属性是依赖于调用 trackInstallation / trackAppInstall 接口,且使用 APP 渠道追踪,在匹配成功后,渠道链接中包含的对应渠道信息( utm_ 参数)会被写入用户表,渠道追踪匹配模式和渠道匹配关键字则记录匹配的渠道方式,以及通过哪个关键字匹配上的 | |
$utm_medium | 字符串 | 首次广告系列媒介 | ||
$utm_term | 字符串 | 首次广告系列字词 | ||
$utm_content | 字符串 | 首次广告系列内容 | ||
$utm_campaign | 字符串 | 首次广告系列名称 | ||
$utm_matching_type | 字符串 | 渠道追踪匹配模式 | ||
$matched_key | 字符串 | 渠道匹配关键字 | ||
$matching_key_list | 字符串 | 渠道匹配关键字列表 | 渠道匹配关键字列表,包含所有可能用于渠道匹配的 key | 同上,且 SA 1.14+ 版本支持,渠道匹配关键字列表,包含所有可能用于渠道匹配的 关键字 |
其他
属性名 | 属性类型 | 默认显示名 | 说明 | 备注 |
---|---|---|---|---|
$lib_plugin_version | List | SDK 插件版本号 | 该属性是用于记录神策分析各插件的版本号,例如: Android 插件;采集示例:$lib_plugin_version:["android_plugin:4.2"] | Android SDK v4.3.5+,Android 插件 v3.2.14+,才会采集该属性; |
注:本文档内容为神策产品使用和技术细节说明文档,不包含适销类条款;具体企业采购产品和技术服务内容,以商业采购合同为准。