1. 预置事件

事件英文变量名事件显示名属性英文变量名事件属性显示名属性值类型属性值示例或说明触发时机备注
$AppStartApp 启动$is_first_time是否首次布尔值表示是否是首次启动 App,可参考文档新增用户及首日首次标记
  • iOS:启动 App 或从后台切换进入 App 时触发
  • Android:启动 App 并与上次退出 App间隔超过30s,或新装的首次启动
  • HarmonyOS:启动 App 触发

1Android/iOS SDK 通用性采集,开启AutoTrack接口将自动开启,文档请参考客户端 SDK 集成文档。


UTM广告系列参数,用来渠道追踪,参考文档:App 渠道追踪

$AppStart、$AppEnd 支持通过属性插件化进行属性修改。

$resume_from_background是否从后台唤醒布尔值
$screen_name页面名称字符串Activity 的包名.类名(仅 Android 端有,iOS 端的启动逻辑并不需要跳转到某个页面即可判断是否启动,因此 iOS 端启动时采集不到页面名称)
$title页面标题字符串Activity 的标题(仅 Android 端有,iOS 端的启动逻辑并不需要跳转到某个页面即可判断是否启动,因此 iOS 端启动时采集不到页面标题)
$AppEndApp 退出$event_duration事件时长数值特指本次 App 启动到 App退出的时长,单位为 秒
  • iOS:退出 App 或 App 进入后台时触发
  • Android:退到后台或关闭 App 等待 30 秒触发
  • HarmonyOS:退出 App 触发







$screen_name页面名称字符串Activity 的包名.类名(仅 Android 端有,iOS 端的退出逻辑并不需要跳转到某个页面即可判断是否退出,因此 iOS 端退出时采集不到页面名称)
$title页面标题字符串Activity 的标题(仅 Android 端有,iOS 端的退出逻辑并不需要跳转到某个页面即可判断是否退出,因此 iOS 端退出时采集不到页面标题)
$AppViewScreenApp 浏览页面$screen_name页面名称字符串Activity 的包名.类名(Android 端) / ViewController 的类名(iOS 端);可手动设置该属性的值

打开一个 Activity / ViewController 页面时触发(对于Android Fragment 默认不会触发浏览页面事件,如果采集,需要单独开启)

HarmonyOS 具体说明,参考:全埋点(HarmonyOS)

$title页面标题字符串

Activity 的标题(Android 端)/ViewController 的标题(iOS 端)

HarmonyOS SDK 不采集

$url页面地址字符串

自动采集的版本 Android:3.2.8,iOS:1.11.5 

HarmonyOS SDK 不采集

$referrer前向地址字符串自动采集的版本 Android:3.2.8,iOS:1.11.5 
$AppClickApp 元素点击$screen_name页面名称字符串Activity 的包名.类名(Android 端) / ViewController 的类名(iOS 端);可手动设置该属性的值

点击控件时触发

可采集大部分控件,如:

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 等

HarmonyOS 端:

具体说明,参考:全埋点(HarmonyOS)








$title页面标题字符串

Activity 的标题(Android 端)/ViewController 的标题(iOS 端)

HarmonyOS SDK 不采集

$element_position元素位置字符串

元素在模块中的位置,从 0 开始。
只有特殊控件下,该属性才会采集到值(比如 iOS 端的 UITableView 和 UICollectionView 等,Android 端的 ListView 等。对于采集不到该属性值的控件,该属性值在神策分析页面展示为「未知」。

HarmonyOS SDK 不采集

$element_id元素ID字符串

Android 端默认会获取;

iOS 端每个控件一般不会设置 ID,因此 iOS 端默认会不获取。可手动设置

HarmonyOS SDK 不采集

$element_content元素内容字符串

控件代码内设置的元素内容,如果一个控件中没有设置元素内容,或者控件类型为图片,则该属性采集不到值,在神策事件分析页面展示为 「未知」。因此如果发现某个按钮的内容采集不到值,需要和客户的研发同学确认下这个按钮控件的类型,以及是否有在代码中设置元素内容。


$element_type元素类型字符串

控件的类型,例如 Button

HarmonyOS SDK 不采集

$element_selector元素选择器字符串

该属性主要记录一个按钮在 APP 中的位置,神策的 App 点击图展示时会使用到此属性,业务人员无需关注此属性的取值逻辑。

HarmonyOS SDK 不采集

$element_path元素路径字符串

可视化全埋点功能会采集该属性的值,需要手动代码开启

HarmonyOS SDK 不采集

AppInstall / $AppInstall



App 激活 / App 安装后首次启动$browser浏览器名字符串通过 UA 解析出来的值需要调用 trackInstallation / trackAppInstall 接口采集采集该事件,且App 安装后首次打开才会触发,第二次打开不会再触发。




神策分析 Android SDK v4.3.6+、iOS SDK v2.1.14+ 增加 trackAppInstall 接口,调用该接口会采集 $AppInstall 事件

若用原记录的激活事件名不是 $AppInstall,需要使用虚拟事件将原激活事件和 $AppInstall 合并分析数据,具体咨询神策技术支持

需要 SDK 采集的相关属性,HarmonyOS SDK 暂不支持

$utm_source广告系列来源字符串需要使用神策 App 渠道追踪方法,渠道匹配成功之后,AppInstall 事件才会有 $utm 相关的属性,具体可参考神策的 App 渠道追踪

$utm_medium广告系列媒介字符串
$utm_term广告系列字词字符串
$utm_content广告系列内容字符串
$utm_campaign广告系列名称字符串
$ios_install_source/字符串

记录 App 精准匹配时的匹配字段,比如 IMEI、Android ID、Mac 地址、IDFA。

$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 权限时有此属性。 

AppCrashedApp 崩溃app_crashed_reason崩溃原因字符串只有在开启崩溃采集时才会采集APP 崩溃
$AppStartPassivelyApp 被动启动$app_stateApp状态字符串iOS 端会默认获取,Android 端不会获取iOS APP 被系统拉活iOS 端有此事件,Android 和 HarmonyOS 端没有。
$resume_from_background是否从后台唤醒布尔值
$is_first_time是否首次布尔值表示是否是首次启动 App,可参考文档新增用户及首日首次标记
$AppRemoteConfigChanged远程控制配置变化$app_remote_config远程控制配置信息字符串获取远程配置,SDK 加载配置生效后,采集该事件,并采集对应的控制信息,用于问题排查SDK 获取到远程配置

Android SDK 4.4.1+

iOS SDK 2.1.8+

HarmonyOS SDK 不支持

$AppDeeplinkLaunch深度链接唤醒 App$deeplink_url 深度链接地址字符串唤醒 App 的 DeepLink 链接

App 被 DeepLink 唤醒时

用于分析 App 被 DeepLink 唤醒的相关数据;该事件中的 $utm_xxx、$latest_utm_xxx 属性,SDK 端无法直接采集,需要依赖后端补充

Android SDK 4.2.1+

iOS SDK 2.1.2+

HarmonyOS SDK 不支持

$utm_source 等 5 个属性广告系列来源等字符串
$latest_utm_source 等 5 个属性最近一次广告系列来源等字符串
$AppDeeplinkMatchedResult深度链接匹配结果$deeplink_url 深度链接地址字符串唤醒 App 的 DeepLink 链接 SDK 请求解析 DeepLink 的配置完成后触发该事件

Android SDK 4.2.1+

iOS SDK 2.1.2+

HarmonyOS SDK 不支持

$event_duration事件时长数值
$deeplink_options深度链接参数字符串网页端配置的深度链接参数
$deeplink_match_fail_reason深度链接匹配失败原因字符串
$utm_source 等 5 个属性广告系列来源等字符串
$AppPushClickApp 推送点击$app_push_msg_title推送消息标题字符串
推送被点击时触发



Android  SDK v5.1.0+

Android 插件 v3.3.4+

iOS SDK v2.5.3+

HarmonyOS SDK 不支持

$app_push_msg_content推送消息内容字符串
$app_push_service_name第三方推送服务商字符串

可能的取值有:JPush

$app_push_channelApp 推送通道字符串

可能的取值有:HUAWEI、OPPO、vivo、Xiaomi、Meizu

$sf 开头的属性神策营销云相关的属性
仅在点击神策营销云下发的推送时会带有这些属性,详细信息参考此文档
$ABTestTriggerA/B 测试$abtest_experiment_id具体的试验 ID字符串
命中试验时触发

Android SDK v4.3.6+
iOS SDK v2.1.14+

armonyOS SDK v0.0.5 及以上版本支持

$abtest_experiment_group_id具体的试验分组 ID字符串
$is_control_group是不是分群用户布尔值表示分群用户/ 随机流量用户
$AppPageLeave页面离开$event_duration事件时长数值在页面离开不可见时触发页面离开事件,并计算浏览时长,此处特指页面浏览的时长离开页面后,上报页面离开事件

Android  SDK v5.4.2+

iOS SDK v3.1.5+

HarmonyOS SDK 暂不支持

$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

$PlanPopupDisplay




弹窗展示

$sf_msg_title

弹窗标题字符串
弹窗展示时触发

需集成 SensorsFocus SDK ,参考弹窗触达集成

HarmonyOS SDK 暂不支持

$sf_msg_content

弹窗内容字符串

$sf_succeed

消息发送成功布尔值true/false true 代表成功

$sf_fail_reason

弹窗失败原因字符串如弹窗成功,显示未知
$PlanPopupClick弹窗点击$sf_msg_element_type弹窗按钮类型字符串弹窗元素类型:普通按钮、文字链接、图片链接、关闭 icon、蒙层点击弹窗时触发

需集成 SensorsFocus SDK ,参考弹窗触达集成

HarmonyOS SDK 暂不支持

$sf_msg_element_action弹窗按钮行为字符串弹窗点击行为:跳转、预置行为, web 只有 URL跳转,App只有 URL、自定义跳转和复制、关闭
$sf_msg_element_content弹窗按钮文案字符串
$sf_msg_action_id点击行为 ID字符串
$sf_msg_image_url图片链接字符串图片链接(图片 CDN 存储地址)
$sf_close_type关闭按钮类型字符串关闭按钮类型,只有关闭行为有:关闭蒙层、弹窗右上关闭icon、弹窗下部关闭 icon、底部按钮(设置为关闭弹窗的按钮)

2. 所有事件都有的预置属性

属性名属性类型默认显示名说明备注
$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/iOSAndroid SDK v5.2.5 鸿蒙系统采集值为 Android
$lib_version字符串SDK版本SDK 版本
$manufacturer字符串设备制造商设备制造商Android SDK v5.2.2 取值全部大写
$brand字符串设备品牌设备品牌

Android SDK v5.2.2 及以上支持

HarmonyOS  SDK 支持


$model字符串设备型号设备型号
$os字符串操作系统操作系统Android SDK v5.2.5 新增鸿蒙系统采集
$os_version字符串操作系统版本操作系统版本Android SDK v5.2.5 新增鸿蒙系统操作版本采集
$referrer_title字符串前向页面标题

前一个页面标题

Android SDK v4.4.7 及以上版本支持,v6.0.0 版本及以上默认开启,v6.0.0 以下通过 SAConfigOptions 中 enableReferrerTitle 配置开启

iOS SDK v2.2.5 版本支持,通过 SAConfigOptions 中 enableReferrerTitle 配置开启;v4.0.0 及以上版本,默认开启

HarmonyOS SDK 暂不支持

$screen_height数值屏幕高度屏幕高度(iOS 端是逻辑分辨率,开发中的点像素;Android 采集的是物理像素点,例如 Android 手机分辨率是 1920 x 1080,采集到的就是这个值。)
$screen_width数值屏幕宽度屏幕宽度(iOS 端是逻辑分辨率,开发中的点像素;Android 采集的是物理像素点,例如 Android 手机分辨率是 1920 x 1080,采集到的就是这个值。)
$wifi布尔值是否 WiFi事件触发时是否为 WiFiHarmonyOS SDK 暂不支持
$carrier字符串运营商名称事件触发时设备 SIM 卡的运营商名称,如果 Android 没有获取 READ_PHONE_STATE 权限,或者未插卡,则无法获取运营商名称;如果 iOS 未插卡,则无法获取运营商名称

iOS 16.4 及以上版本,iOS SDK 无法采集运营商信息。即,iOS 16.4 及以上系统,iOS SDK 所有事件,都没有预置属性 $carrier。

参考:iOS & iPadOS 16.4 Release Notes

HarmonyOS SDK 暂不支持

Android SDK v6.8.0 及以上,不支持运营商自动采集

$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字符串设备 IDAndroid 端主要取 Android ID ,iOS 端先尝试获取 IDFA,如果获取不到,则取 IDFV,具体取值逻辑可参考文档 如何准确的标识用户

Android SDK 1.7.1 版本支持,在 Android v6.2.0 ~ v6.2.5 范围的版本取值为 $anonymization_id
iOS SDK 1.10.18 版本支持,在 iOS v4.2.0 ~ v4.2.3 范围的版本取值为 $anonymization_id

$screen_orientation字符串屏幕方向

只有在开启 enableTrackScreenOrientation: 时才会采集

Android/iOS 1.10.1 版本支持


$latitude数值GPS 信息

纬度*106

只有在开启 enableTrackGPSLocation: 时才会采集

Android/iOS 1.10.1 版本支持

Android & HarmonyOS 端需要手动传入

$longitude数值GPS 信息

经度*106   

只有在开启 enableTrackGPSLocation: 时才会采集

Android/iOS 1.10.1 版本支持

Android & HarmonyOS 端需要手动传入

$geo_coordinate_system字符串坐标系只有在开启 enableTrackGPSLocation: 时才会采集

Android v5.2.2 版本支持

iOS v2.6.4 版本支持

iOS 端默认为 WGS84

Android & HarmonyOS 端需要手动传入

$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 命令可联系神策运维同学执行

HarmonyOS SDK 暂不支持

3. 追踪并进行渠道匹配和回传时的预置事件属性

属性名属性类型默认显示名说明备注
$channel_device_info字符串记录渠道匹配的设备信息

App 渠道追踪自定义事件时进行渠道匹配,可以调用 trackChannelEvent:properties: 对待匹配的事件进行追踪,后台匹配到渠道信息后会将结果回传到渠道商。该字段记录用于渠道匹配的设备信息,比如 IMEI、Android ID、Mac 地址、IDFA。具体使用,可以参考 SDK 的 API 文档。

SA 1.15+ 版本后支持
$is_channel_callback_event布尔值是否进行渠道匹配回调App 渠道追踪自定义事件时进行渠道匹配,可以调用 trackChannelEvent:properties: 对待匹配的事件进行追踪,后台匹配到渠道信息后会将结果回传到渠道商。具体使用,可以参考 SDK 的 API 文档。

SA 1.15+ 版本支持;

默认只有第一次触发渠道追踪自定义事件时,该属性的值为 ture,表示匹配成功会,会给广告商回调渠道数据。后续再次触发该事件时,该属性值为 false。

4. 预置用户属性

属性名属性类型默认显示名说明备注
$first_visit_timeDatetime(时间)首次访问时间 调用 trackInstallation / trackAppInstall 接口后,新用户首次启动App, 会给此属性赋值该属性是在调用 trackInstallation / trackAppInstall 接口时设置的, 一般标记在匿名 ID (Android ID/IDFA)的用户身上,如果登录 ID 和匿名 ID 没有关联成功,则登录 ID 用户的该属性值没值。
$utm_source字符串首次广告系列来源

这些属性是依赖于调用 trackInstallation / trackAppInstall 接口,且使用 APP 渠道追踪,在匹配成功后,渠道链接中包含的对应渠道信息( utm_ 参数)会被写入用户表,渠道追踪匹配模式和渠道匹配关键字则记录匹配的渠道方式,以及通过哪个关键字匹配上的

HarmonyOS SDK  暂不支持

$utm_medium字符串首次广告系列媒介
$utm_term字符串首次广告系列字词
$utm_content字符串首次广告系列内容
$utm_campaign字符串首次广告系列名称
$utm_matching_type字符串渠道追踪匹配模式

$matched_key

字符串渠道匹配关键字
$matching_key_list字符串渠道匹配关键字列表

渠道匹配关键字列表,包含所有可能用于渠道匹配的 key 

HarmonyOS SDK  暂不支持

同上,且 SA 1.14+ 版本支持,渠道匹配关键字列表,包含所有可能用于渠道匹配的 关键字

5. 其他

属性名属性类型默认显示名说明备注
$lib_plugin_versionListSDK 插件版本号 该属性是用于记录神策分析各插件的版本号,例如: Android 插件;采集示例:$lib_plugin_version:["android_plugin:4.2"]Android SDK v4.3.5+,Android 插件 v3.2.14+,才会采集该属性;