You need to enable JavaScript to run this app.
导航

APP预置事件及属性

最近更新时间2024.03.28 16:31:02

首次发布时间2023.01.17 15:44:28

背景信息
  • 预置事件公共属性即为所有事件均有的公共属性。
    在APP端中可进一步细分为Android端、iOS端。其中:
  • 特定预置事件独有的事件属性即为预置事件属性。
    在APP端中可进一步细分为Android端、iOS端。其中:
  • 用户属性相关的内容可参见预置用户属性

预置事件公共属性
  • 事件/属性类型说明:Android端/iOS端都有的事件公共属性。
  • 上报机制:SDK 默认每 60s 打包事件进行批量上报。

通用预置事件公共属性

属性名

属性展示名

SaaS/私有化支持情况

字段类型

数据来源

属性说明或示例

$is_login

是否登录

Saas

SaaS-云原生:int
SaaS-字节云:String

服务端生成

是否登录

is_login

是否登录

私有化

String

服务端生成

是否登录

$is_first_day

是否首日访问

Saas/私有化

int

服务端生成

此属性表示目标事件和首个事件发生在同一天。
与新老用户(user_is_new)属性的功能类似。

  • 新老用户(user_is_new):目标事件和首个事件发生在同一周期。比如在柱形图中,周期就是用户所选的时间范围。
  • 新老用户(user_is_new)和是否首日访问($is_first_day)最主要的区别在于前者受所选时间周期的影响,而后者不受影响,因此后者在不同的图表类型中得到的计算结果有更好的一致性,建议使用是否首日访问($is_first_day)来判断新老用户。

$event_name

事件名

Saas/私有化

String

服务端生成

事件的名称

$event_time

事件发生时间

Saas/私有化

DateTime

服务端生成

事件触发的客户端时间

$user_register_time

注册时间

Saas(SaaS云原生场景下暂不支持)

DateTime

服务端生成

用户首次事件出现的时间(私有化里是用户属性first_event_time)

network_type

网络类型

SaaS-云原生/私有化(saas-字节云里是用户属性)

String

系统 API

当前网络类型,示例: wifi

aid

私有化

String

用户传入

app_id

app_version

软件版本

SaaS-云原生/私有化(saas-字节云里是事件属性)

String

系统 API

APP 版本号,系统API获取。

bddid

设备ID

SaaS-字节云

String

服务端生成

app_channel

渠道

SaaS-云原生/私有化

String

用户传入

渠道,用户手动设置;火山云环境用户可在事件属性中查找。

loc_country_id

国家

SaaS云原生/私有化(saas-字节云里是用户属性)

String

根据client_ip的值进行行政区的推断。示例: 中国

language

系统语言

SaaS云原生/私有化(saas-字节云里是用户属性)

String

系统 API

系统语言,APP侧从系统API获取、小程序侧从getSystemInfo获取的。

os_name

操作系统

SaaS云原生/私有化(saas-字节云里是用户属性)

String

固定值

操作系统

os_version

系统版本

SaaS云原生/私有化(saas-字节云里是用户属性)

String

系统 API

系统版本,APP侧从系统API获取、Web侧从ua解析的、小程序侧从getSystemInfo获取的。

platform

平台类型

SaaS云原生/私有化(saas-字节云里是用户属性)

String

固定值

平台

region

系统地区

SaaS云原生/私有化(saas-字节云不支持)

String

系统 API

系统地区

resolution

分辨率

SaaS云原生/私有化(saas-字节云里是用户属性)

String

系统 API

屏幕分辨率,APP侧从系统API获取、小程序侧从getSystemInfo获取的

sdk_lib

SDK类型

SaaS云原生/私有化(saas-字节云里是用户属性)

String

固定值

SDK 类型,示例: ios

sdk_version

SDK版本

SaaS云原生/私有化(saas-字节云里是用户属性)

String

固定值

SDK 版本号

$latest_search_keyword

搜索引擎关键字

Saas-云原生

String

当符合前置条件时(当前页面地址和refer来源地址域名不相同),地址中带有keyword=xxx时,默认设置,如www.toutiao.com/xxx?keyword=sss,则此值为sss。没有则不设置。

timezone

时区

私有化

String

系统 API

系统时区

$latest_traffic_source_type

最近一次流量来源类型

Saas-云原生

String

用户手动设置。

Android特有

Android端特有、iOS不支持的事件公共属性。

属性名

属性展示名

SaaS/私有化支持情况

字段类型

数据来源

属性说明或示例

device_brand

手机品牌

Saas-云原生/私有化

String

系统 API

示例:iPhone

cpu_abi

cpu架构对应的abi

Saas-云原生/私有化

String

系统 API

app_version_minor

四位版本号

SaaS-云原生/私有化

String

用户传入

iOS从系统API获取build号,Android需手动设置。

app_language

软件语言

Saas-字节云,属于用户属性

String

用户传入

app_region

软件地区

Saas-云原生/私有化

String

用户传入

network_carrier

运营商

SaaS-云原生/私有化

String

系统 API

运营商信息

iOS特有

iOS端特有的事件公共属性。

属性名

属性展示名

SaaS/私有化支持情况

字段类型

数据来源

属性说明或示例

app_version_minor

四位版本号

Saas-云原生/私有化

String

系统 API

Build 号,iOS从系统API获取build号,Android需手动设置。

app_language

软件语言

私有化,Saas-字节云里是用户属性,SaaS-云原生不支持

String

用户传入,系统 API

用户手动设置。未传入会用系统语言兜底

app_region

软件地区

Saas-云原生/私有化(saas-字节云不支持)

String

用户传入,系统 API

用户手动设置。未传入会用系统地区兜底

预置事件及事件属性

预置的事件及对应事件特有的事件属性。其中也分所有预置事件均有的事件属性,和对应事件特有的事件属性。

所有预置事件均有的事件属性

属性名

属性展示名

SaaS/私有化支持情况

字段类型

数据来源

属性说明或示例

$screen_orientation

Saas/私有化

Number

系统 API

事件发生的本地时间

$longitude

地理位置经度

Saas/私有化

Number

用户传入,系统 API

Andoid 仅支持用户传入,iOS 支持自动获取

$latitude

地理位置纬度

Saas/私有化

Number

用户传入

Andoid 仅支持用户传入,iOS 支持自动获取

$geo_coordinate_system

Saas/私有化

String

用户传入

Andoid 仅支持用户传入,iOS 支持自动获取

$app_version

软件版本

Saas/私有化

String

系统 API

应用启动事件(app_launch)

事件名

事件说明

属性名

属性展示名

SaaS/私有化支持

属性值类型

属性描述

触发时机

app_launch

应用启动

$is_first_time

是否首次访问

Saas

string

每个用户的第一次launch事件会添加该属性值为true,其他launch没有该属性

  • 当用户启动App(进入前台)的时候,产生一个 launch 事件。
  • 当切换用户时,会结束上一次会话并重新产生一个新的 launch 事件。

session_id

会话ID

Saas(私有化中为事件公共属性)

string

session_duration

本次打开应用的会话时长

Saas/私有化

int

session 时长,基于设备位于前台的时长求和统计,单位为秒,在app_launch里无该属性或值为0。

$page_title

页面标题

SaaS-字节云/私有化

string

$page_key

页面名称

SaaS-字节云/私有化

string

$resume_from_background

是否从后台恢复

SaaS-字节云/私有化

string

应用退出事件(app_terminate)

事件名

事件说明

属性名

属性展示名

SaaS/私有化支持

属性值类型

属性描述

触发时机

app_terminate

应用退出

session_id

会话ID

Saas(私有化中为事件公共属性)

string

会话ID

  • 当用户停止使用App(进入后台),会产生一个 terminate 事件,Android 中进入后台会停留 30s 才会触发,iOS 中是进入后台立即触发。
  • 当切换用户时,会结束上一次会话产生一次 terminate 事件。

session_duration

本次打开应用的会话时长

SaaS/私有化

int

session 时长,基于设备位于前台的时长求和统计,单位为秒。

$page_title

页面标题

SaaS/私有化

string

$page_key

页面名称

SaaS/私有化

string

全埋点事件(bav2b_)

事件名

事件说明

属性

属性值类型

属性描述

bav2b_page

页面访问

page_key

string

页面唯一标识

refer_page_key

string

is_back

int

page_title

string

页面的标题

page_path

string

页面的路径

referrer_page_path

string

refer_page_title

string

$is_rn

int

判定是否 RN 页面

$rn_root_tag

int

RN页面唯一编号

$is_flutter

int

是否使用flutter全埋点

$bav2b_page_leave

页面离开

$page_duration

int

页面时长

page_key

string

页面唯一标识

page_title

string

页面的标题

$is_rn

int

判定是否 RN 页面

$is_flutter

int

是否使用flutter全埋点

$rn_root_tag

int

RN页面唯一编号

bav2b_click

元素点击

page_key

string

页面唯一标识

element_path

string

唯一标识控件,xPath的字符串

positions

string数组

元素在每层列表中的位置,可能为2-2 0-1

texts

string数组

元素文案,是个数组,数组中每个文案长度上限200字符

element_width

string

元素宽度,单位同header.resolution

element_height

string

元素高度,单位同header.resolution

touch_x

int

点击位置相对元素左边界的距离,单位同header.resolution

touch_y

int

点击位置相对元素上边界的距离,单位同header.resolution

page_title

string

页面的标题

element_id

string

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

element_type

string

元素类型,控件的类型,例如 Button

$is_rn

int

判定是否 RN 页面

$is_flutter

int

是否使用flutter全埋点

$rn_root_tag

int

RN页面唯一编号

$bav2b_exposure

元素曝光

page_key

string

页面唯一标识

element_path

string

唯一标识控件,xPath的字符串

positions

string数组

元素在每层列表中的位置,可能为2-2 0-1

texts

string数组

元素文案,是个数组,数组中每个文案长度上限200字符

element_width

string

元素宽度,单位同header.resolution

element_height

string

元素高度,单位同header.resolution

page_title

string

页面的标题

element_id

string

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

element_type

string

元素类型,控件的类型,例如 Button

$exposure_type

int

曝光类型

$bav2b_slide

滑动事件

$direction

int

滑动方向

$offsetX

float

横向偏移

$offsetY

float

纵向偏移

page_key

string

页面唯一标识

element_path

string

唯一标识控件,xPath的字符串

element_width

string

元素宽度,单位同header.resolution

element_height

string

元素高度,单位同header.resolution

page_title

string

页面的标题

element_id

string

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

element_type

string

元素类型,控件的类型,例如 Button

应用崩溃事件(crash)

事件名

事件说明

属性

属性展示名

SaaS/私有化支持

属性值类型

属性描述

$crash

检测应用发生 Crash 时产生,目前 Android 支持 Java 层的 Exception,iOS 支持 NSException。

$is_backstage

是否后台

SaaS/私有化

string

是否后台

$event_time

事件发生时间

SaaS/私有化

datetime

崩溃时间

$crash_thread

崩溃线程

SaaS/私有化

string

崩溃线程

$crash_process

崩溃进程

SaaS/私有化

string

崩溃进程

$detailed_stack

详细堆栈

SaaS/私有化

string

详细堆栈

$os_version

  • Android 未上报

系统版本

SaaS/私有化

string

系统版本

$app_version

  • Android 未上报

软件版本

SaaS/私有化

string

软件版本

$device_model

  • Android 未上报

设备机型

SaaS/私有化

string

设备机型

$resolution

  • Android 未上报

分辨率

SaaS/私有化

string

分辨率

$app_channel

  • Android 未上报

渠道

SaaS/私有化

string

渠道

$cpu

  • Android 未上报

CPU架构

SaaS/私有化

string

CPU架构

$session_duration

  • Android 未上报

使用时长(秒/毫秒)

SaaS/私有化

  • SaaS-云原生:string
  • SaaS-字节云/私有化:int

使用时长(毫秒)

$rom

  • Android 未上报

ROM

SaaS/私有化

string

ROM

Android特有事件及属性

暂无。

iOS特有事件及属性

iOS端特有的预置事件及对应的事件属性。

事件名

事件说明

属性名

属性展示名

SaaS/私有化支持

属性值类型

属性描述

$app_launch_passively

被动启动

$resume_from_background

是否从后台恢复

SaaS-字节云/私有化

bool

是否从后台恢复

其他事件/属性

跨端事件及属性

跨端事件为各个端均有的事件,当前涉及的跨端事件及属性详情请参见跨端预置属性

AB曝光事件

事件名

事件说明

属性

属性值类型

属性描述

abtest_exposure

AB 实验曝光

ab_sdk_version

string

AB 实验的 vid

保留属性名

属性名

属性展示名

SaaS/私有化支持情况

属性值类型

$target_uuid_list

主动事件UUID列表

仅私有化

list

$inactive

是否为被动事件

string

$inline

是否为关系事件

string

$source_uuid

主动事件UUID

string

$inactive

是否为被动事件

string

aid

int

__param_from_special

string