预置事件和属性

为了帮助开发者更快速的集成SDK,了解采集哪些用户行为和属性,我们预置了一些事件、事件属性和用户属性。

部分默认自动采集,Android、iOS、JS 和 小程序端略有差异;非默认采集的字段,如有需要的,可以直接使用预置字段作为事件 ID、属性 ID 进行上报,以便数据集成时,能够自动生成预置看板。

以下表格中涉及标识为 Y/N/- 的含义

  • Y 表示相应平台默认自动采集

  • N 表示相应平台不默认采集

  • - 表示相应平台不支持采集该事件或属性

除了预置的事件和属性ID会以$开头,其他自定义的事件ID和属性ID,须注意命名方式:仅支持字母、数字和下划线,不能以数字或下划线开头,上限125个半角字符。

预置事件

1. Event 类事件,用于行为计算的事件

事件ID

事件显示名称

事件说明

Android

iOS

JS

小程序

$startup

启动

APP启动 / 打开网站

Y

Y

Y

Y

$end

关闭

APP关闭

Y

Y

-

-

$pageview

浏览页面

浏览APP/网站页面

Y

Y

Y

Y

$push_receiver_success

消息推送成功

设备收到推送消息时触发

N

N

-

-

$push_click

点击推送消息

设备点击了推送消息时触发

N

N

-

-

$push_process_success

成功处理push消息

成功处理push消息

N

N

-

-

$webstay

视区停留

停留在可视区域

-

-

N

-

$app_click

App点击事件

App热图点击事件

N

N

-

-

$web_click

Web点击事件

Web热图点击事件

-

-

N

-

其中 $webstay 用于记录用户停留在可视区域,分析浏览深度线,$app_click$web_click 用于记录点击网页/APP页面,用于分析点击位置热图、点击元素热图,所以这三个事件不会作为单独的事件去分析,即不会出现在分析模型中事件的选项中,也不会计入任意事件的计算。

2. Profile 系列事件,用于描述用户

事件ID

事件说明

Android

iOS

JS

小程序

$alias

关联身份

N

N

N

N

$profile_set

设置用户信息,覆盖写

N

N

N

N

$profile_set_once

设置用户信息,有则不进行任何操作

N

N

N

N

$profile_increment

增加或减少用户信息中的数字类型的属性

N

N

N

N

$profile_delete

删除用户信息

N

N

N

N

$profile_append

数组属性添加值

N

N

N

N

$profile_unset

设置用户信息中的某个属性为空

N

N

N

N

Profile 系列的事件用户上报用户属性,所以同样不会作为单独的事件去分析,即不会出现在分析模型中事件的选项中,也不会计入任意事件的计算。

除了上述预置事件之外,更多业务相关的事件,需要自定义埋点上报。

预置事件属性

事件属性描述事件发生的方式和内容,是分析过程中的维度。

不同事件共同拥有的属性,e.g. 平台、应用版本、操作系统等,我们称之为通用属性;也会各自独有的事件属性,e.g. 浏览页面事件 $pageview 会有 $url、$title 等属性。

1. Event 事件通用属性

属性ID

属性显示名称

数据类型

属性说明

Android

iOS

JS

小程序

$platform

平台

字符串

应用平台,枚举取值:Android、iOS、Web/H5、小程序

Y

Y

Y

Y

$app_version

应用版本

字符串

应用版本,e.g. V1.0

Y

Y

-

-

$device_type

设备类型

字符串

设备类型,e.g. PC、移动设备

N

N

N

N

$manufacturer

设备制造商

字符串

制造厂商, e.g. 小米

Y

Y

-

-

$brand

设备品牌

字符串

设备品牌,e.g. 华为荣耀

Y

Y

Y

Y

$model

设备型号

字符串

设备型号,e.g. iPhone8、小米4

Y

Y

Y

Y

$os

操作系统

字符串

操作系统,e.g.Window、MacOS

Y

Y

Y

Y

$os_version

操作系统版本

字符串

操作系统版本,e.g.Windows 10

Y

Y

Y

Y

$browser

浏览器

字符串

浏览器名称,e.g. Chrome

-

-

Y

Y

$browser_version

浏览器版本

字符串

浏览器版本,e.g. Chrome 62.23.23

-

-

Y

Y

$network

网络类型

字符串

网络类型,e.g. WIFI、2G、3G、4G

Y

Y

-

Y

$carrier_name

运营商

字符串

接入运营商名称,e.g. 中国联通

Y

Y

-

-

$screen_width

屏幕宽度

整数型

屏幕宽度/屏幕分辨率,e.g. 1920

Y

Y

Y

Y

$screen_height

屏幕高度

整数型

屏幕高度/屏幕分辨率,e.g. 768

Y

Y

Y

Y

$is_login

是否是注册用户

布尔

是否是注册用户

Y

Y

Y

Y

$ip

IP

字符串

IP地址

N

N

N

N

$country

国家

字符串

事件发生时所在国家,

e.g. 中国、美国

N

N

N

N

$province

省份

字符串

事件发生时所在省份,

e.g. 北京、上海、福建

N

N

N

N

$city

城市

字符串

事件发生时所在城市,

e.g. 北京、厦门

N

N

N

N

$utm_campaign_id

活动ID

字符串

根据添加的内容自动生成,

标识一次活动

Y

Y

Y

Y

$utm_campaign

活动/广告名称

字符串

特定的推广活动,e.g. 双11推广

Y

Y

Y

Y

$utm_medium

活动/广告媒介

字符串

推广类型,e.g. SEM,cpc

Y

Y

Y

Y

$utm_source

活动/广告来源

字符串

推广来源,e.g. 今日头条

Y

Y

Y

Y

$utm_content

活动/广告内容

字符串

广告内容,e.g. 优惠信息

Y

Y

Y

Y

$utm_term

活动/广告关键字

字符串

广告关键字,e.g. 用户画像

Y

Y

Y

Y

$is_first_day

是否安装后首日访问

布尔

是否安装后首日访问

Y

Y

Y

Y

$channel

下载渠道

字符串

下载渠道,事件中携带

Y

Y

-

-

$lib

SDK类型

字符串

SDK类型,e.g. python、iOS等

Y

Y

Y

Y

$lib_version

SDK版本

字符串

SDK版本, e.g. :11.2.5

Y

Y

Y

Y

$time_zone

用户时区

字符串

用户时区,e.g.GMT+08:00

Y

Y

Y

Y

$web_crawler

爬虫

布尔

爬虫识别

-

-

Y

-

$language

语言

字符串

系统语言,e.g. zh-cn

Y

Y

Y

Y

$debug

Debug模式

整数型

标识数据处理方式

Y

Y

Y

Y

$session_id

SessionID

字符串

会话ID,e.g. 515950b8f1a6221c

Y

Y

Y

Y

$is_time_calibrated

是否与服务进行时间校准

布尔

true、false

Y

Y

Y

Y

$user_agent

UA

字符串

UA

-

-

Y

-

非自动采集的属性,会根据相应字段自动解析

$ip :通过服务端自动解析获取

$county:通过 IP 解析

$province:通过 IP 解析

$city :通过 IP 解析

$device_type:通过 UA 解析

部分自动采集的属性不会作为独立的属性用于分析

$debug:用于标识是否入库

  • 0:表示关闭 Debug 模式

  • 1:表示打开 Debug 模式,但该模式下发送的数据仅用于调试,不计入平台数据统计

  • 2:表示打开 Debug 模式,该模式下发送的数据可计入平台数据统计

$session_id:标识一次会话

$user_agent:UA,用于解析设备类型、浏览器、浏览器版本、操作系统、操作系统版本

2. 部分 Event 事件自身属性

$startup

属性ID

属性显示名称

数据类型

属性说明

Android

iOS

JS

小程序

$is_first_time

是否安装后首次访问

布尔

是否安装后首次访问

Y

Y

Y

Y

$is_from_background

是否从后台唤醒

布尔

是否从后台唤醒恢复

Y

Y

-

-

$end

属性ID

属性显示名称

数据类型

属性说明

Android

iOS

JS

小程序

$duration

使用时长

数值

从启动到关闭的使用时长

Y

Y

-

-

$pageview

属性ID

属性显示名称

数据类型

属性说明

Android

iOS

JS

小程序

$url

页面URL(含参)

字符串

页面完整路径

Y

Y

Y

Y

$url_domain

页面URL

字符串

去参的页面URL

-

-

N

-

$title

页面标题

字符串

页面标题

Y

Y

Y

-

$referrer

页面来源

字符串

页面来源

-

-

Y

Y

$referrer_domain

页面来源域名

字符串

页面来源域名

-

-

Y

-

$traffic_source_type

流量来源类型

字符串

流量来源类型,数据处理

-

-

N

-

$search_engine

搜索引擎

字符串

标识搜索引擎来源

-

-

N

-

$search_keyword

搜索关键词

字符串

标识搜索词来源

-

-

N

-

$social_media

社交媒体

字符串

标识社交媒体来源

-

-

N

-

$social_share_from

社交媒体分享来源

字符串

标识微信来源,e.g. 朋友圈、单聊

-

-

N

-

$scene

场景值

字符串

标识小程序的场景值,e.g 顶部搜索框的搜索结果页

-

-

-

N

$scene_type

场景值类型

字符串

标识小程序场景值类型

-

-

-

N

$pagename

自定义页面名称

字符串

用户自定义页面名称

N

N

N

N

$startup_time

启动时间

日期

yyyy-MM-dd hh:mm:ss.SSS

-

-

Y

Y

其中 $startup_time 仅用于数据校准,不会出现在分析模型中

$url_domain, $traffic_source_type, $search_engine 等非自动采集的属性,系统会根据url 和 referer 自动解析

$push_receiver_success

属性ID

属性显示名称

数据类型

属性说明

Android

iOS

JS

小程序

$action_type

操作类型

整数型

点击消息通知后的操作类型

N

N

-

-

$action

操作

字符串

点击消息通知后的操作

N

N

-

-

$utm_campaign_id

活动ID

字符串

根据添加的内容自动生成,标识一次活动

N

N

-

-

$utm_campaign

活动/广告名称

字符串

特定的推广活动,e.g. 双11推广

N

N

-

-

$utm_medium

活动/广告媒介

字符串

推广类型,e.g. SEM,cpc

N

N

-

-

$utm_source

活动/广告来源

字符串

推广来源,e.g. 今日头条

N

N

-

-

$utm_content

活动/广告内容

字符串

广告内容,e.g. 优惠信息

N

N

-

-

$utm_term

活动/广告关键字

字符串

广告关键字,e.g. 用户画像

N

N

-

-

$push_click

属性ID

属性显示名称

数据类型

属性说明

Android

iOS

JS

小程序

$action_type

操作类型

整数型

点击消息通知后的操作类型

N

N

-

-

$action

操作

字符串

点击消息通知后的操作

N

N

-

-

$utm_campaign_id

活动ID

字符串

根据添加的内容自动生成,标识一次活动

N

N

-

-

$utm_campaign

活动/广告名称

字符串

特定的推广活动,e.g. 双11推广

N

N

-

-

$utm_medium

活动/广告媒介

字符串

推广类型,e.g. SEM,cpc

N

N

-

-

$utm_source

活动/广告来源

字符串

推广来源,e.g. 今日头条

N

N

-

-

$utm_content

活动/广告内容

字符串

广告内容,e.g. 优惠信息

N

N

-

-

$utm_term

活动/广告关键字

字符串

广告关键字,e.g. 用户画像

N

N

-

-

$push_process_success

属性ID

属性显示名称

数据类型

属性说明

Android

iOS

JS

小程序

$action_type

操作类型

整数型

点击消息通知后的操作类型

N

N

-

-

$action

操作

字符串

点击消息通知后的操作

N

N

-

-

$utm_campaign_id

活动ID

字符串

根据添加的内容自动生成,标识一次活动

N

N

-

-

$utm_campaign

活动/广告名称

字符串

特定的推广活动,e.g. 双11推广

N

N

-

-

$utm_medium

活动/广告媒介

字符串

推广类型,e.g. SEM,cpc

N

N

-

-

$utm_source

活动/广告来源

字符串

推广来源,e.g. 今日头条

N

N

-

-

$utm_content

活动/广告内容

字符串

广告内容,e.g. 优惠信息

N

N

-

-

$utm_term

活动/广告关键字

字符串

广告关键字,e.g. 用户画像

N

N

-

-

$webstay

属性ID

属性显示名称

数据类型

属性说明

Android

iOS

JS

小程

$url

页面URL

字符串

页面URL/页面完整路径

-

-

N

-

$title

页面标题

字符串

页面标题

-

-

N

-

$referrer

页面来源

字符串

页面来源

-

-

N

-

$viewport_width

视区宽度

数值

视区宽度

-

-

N

-

$viewport_position

视区距顶部的位置

数值

视区距顶部的位置

-

-

N

-

$viewport_height

视区高度

数值

视区高度

-

-

N

-

$event_duration

视区停留时间

数值

视区停留时间

-

-

N

-

$app_click、$web_click

属性ID

属性显示名称

数据类型

属性说明

Android

iOS

JS

小程序

$page_width

页面宽度

浮点型

热图页面宽度

Y

Y

Y

$page_height

页面高度

浮点型

热图页面高度

Y

Y

Y

-

$click_x

点击X坐标

浮点型

热图点击X坐标

Y

Y

Y

-

$click_y

点击Y坐标

浮点型

热图点击Y坐标

Y

Y

Y

-

$url

页面URL

字符串

点击热图时页面URL

Y

Y

Y

-

$element_x

元素X坐标

浮点型

点击元素X坐标

Y

Y

Y

-

$element_y

元素Y坐标

浮点型

点击元素Y坐标

Y

Y

Y

-

$element_path

元素路径

字符串

热图元素路径

Y

Y

Y

-

$element_name

元素名称

字符串

热图元素名称

-

Y

-

-

$element_type

元素类型

字符串

热图元素类型

Y

Y

Y

-

$element_content

元素内容

字符串

热图元素的内容

Y

Y

Y

-

$element_clickable

是否可以点击元素

整数型

是否可以点击元素

Y

Y

Y

-

3. Profile 系列事件属性

$alias

属性ID

属性显示名称

数据类型

属性说明

Android

iOS

JS

小程序

$lib

SDK类型

字符串

SDK类型,e.g. python、iOS等

Y

Y

Y

Y

$is_login

是否是注册用户

布尔

true/false

Y

Y

Y

Y

$lib_version

SDK版本

字符串

SDK版本,e.g.11.2.5

Y

Y

Y

Y

$platform

平台

字符串

JS/iOS/Android/Wechat

Y

Y

Y

Y

$debug

debug模式

整数型

debug模式

Y

Y

Y

Y

$original_id

设备id

字符串

上一个id

Y

Y

Y

Y

$profile_set

属性ID

属性显示名称

数据类型

属性说明

Android

iOS

JS

小程序

$lib

SDK类型

字符串

SDK类型,e.g. python、iOS

Y

Y

Y

Y

$is_login

是否是注册用户

布尔

true/false

Y

Y

Y

Y

$lib_version

SDK版本

字符串

SDK版本 e.g. 11.2.5

Y

Y

Y

Y

$platform

平台

字符串

JS/iOS/Android/Wechat

Y

Y

Y

Y

$debug

debug模式

整数型

debug模式

Y

Y

Y

Y

预置用户属性

属性ID

属性显示名称

数据类型

属性说明

Android

iOS

JS

小程序

distinct_id

唯一ID

字符串

服务端自动生成

N

N

N

N

xwho

用户ID

字符串

Y

Y

Y

Y

xwhen

用户属性更新时间

日期时间

Y

Y

Y

Y

$idfv

IDFV

字符串

IDFV

-

Y

-

-

$idfa

IDFA

字符串

IDFA

-

Y

-

-

$mac

MAC

字符串

MAC

Y

-

-

-

$imei

IMEI

字符串

IMEI

Y

-

-

-

$getui

个推ID

字符串

个推推送ID

N

N

-

-

$jpush

极光ID

字符串

极光推送ID

N

N

-

-

$baidu

百度ID

字符串

百度推送ID

N

N

-

-

$xiaomi

小米ID

字符串

小米推送ID

N

N

-

-

$email

邮箱

字符串

邮箱

N

N

N

N

$platform

最后一次使用平台

字符串

最后一次使用平台

Y

Y

Y

Y

$lib

SDK类型

字符串

SDK类型,e.g. python、iOS等

Y

Y

Y

Y

$lib_version

SDK版本

字符串

SDK版本,e.g. 11.2.5

Y

Y

Y

Y

$country

所在国家

字符串

用户所在国家

N

N

N

N

$province

所在省份

字符串

用户所在省份

N

N

N

N

$city

所在城市

字符串

用户所在城市

N

N

N

N

$is_login

是否是注册用户

布尔值

true,false

Y

Y

Y

Y

$signup_time

注册时间

日期时间

注册时间

N

N

N

N

$first_visit_time

首次访问时间

日期时间

首次访问时间

Y

Y

Y

Y

$time_zone

用户时区

字符串

GMT+08:00

Y

Y

Y

Y

$first_visit_language

首次访问语言

字符串

zh-cn

Y

Y

Y

Y