integrationlatest接入文档 / 预置属性
预置属性
一、所有事件的预置属性
以下预置属性,是小程序/小游戏 SDK 中所有事件(包括自动采集事件)都会带有的预置属性
| 属性名 | 中文名 | 属性类型 | 说明 |
|---|---|---|---|
#ip | IP 地址 | 文本 | 用户的 IP 地址,AE 将以此获取用户的地理位置信息 |
| #country | 国家 | 文本 | 用户所在国家,根据 IP 地址生成 |
| #country_code | 国家代码 | 文本 | 用户所在国家的国家代码(ISO 3166-1 alpha-2,即两位大写英文字母),根据 IP 地址生成 |
| #province | 省份 | 文本 | 用户所在省份,根据 IP 地址生成 |
| #city | 城市 | 文本 | 用户所在城市,根据 IP 地址生成 |
| #device_model | 设备型号 | 文本 | 用户设备的型号,如 iPhone 8 等 |
| #device_id | 设备 ID | 文本 | 用户的设备 ID,取初始化时生成的 UUID |
| #screen_height | 屏幕高度 | 数值 | 用户设备的屏幕高度,如 1920 等 |
| #screen_width | 屏幕宽度 | 数值 | 用户设备的屏幕高度,如 1080 等 |
| #manufacturer | 设备制造商 | 文本 | 用户设备的制造商,如 Apple,vivo 等 |
| #os_version | 操作系统版本 | 文本 | iOS 11.2.2、Android 8.0.0 等 |
| #os | 操作系统 | 文本 | 如 Android、iOS 等 |
| #network_type | 网络状态 | 文本 | 上传事件时的网络状态,如 WIFI、3G、4G 等 |
| #lib | SDK 类型 | 文本 | 您接入 SDK 的类型,如 MP(小程序)、MG(小游戏)等 |
| #lib_version | SDK 版本 | 文本 | 您接入 SDK 的版本 |
| #scene | 场景值 | 数值 | 小程序小游戏启动时传入的场景值 |
| #mp_platform | 小程序平台 | 文本 | 标识应用所在的平台 |
| #zone_offset | 时区偏移 | 数值 | 数据时间相对 UTC 时间的偏移小时数 |
| #system_language | 系统语言 | 文本 | 用户设备的系统语言(ISO 639-1,即两位小写英文字母),如 zh, en 等 |
二、自动采集事件的预置属性
以下预置属性,是各个自动采集事件中所特有的预置属性
- 小程序启动(ta_mp_show)的预置属性
| 属性名 | 中文名 | 属性类型 | 说明 |
|---|---|---|---|
| #url_path | 页面路径 | 文本 | 小程序启动被展示页面的路径 |
#start_reason | 应用启动来源 | 文本 | 内容为JSON字符串,是从getLaunchOptionsSync接口获取的参数 |
- 小程序隐藏(ta_mp_hide)的预置属性
| 属性名 | 中文名 | 属性类型 | 说明 |
|---|---|---|---|
| #duration | 事件时长 | 数值 | 表示本次启动ta_mp_show到隐藏ta_mp_hide的持续时长,单位是秒 |
- 小程序页面浏览(ta_mp_view)的预置属性
| 属性名 | 中文名 | 属性类型 | 说明 |
|---|---|---|---|
| #url_path | 页面路径 | 文本 | 页面路径,也就是被展示页面的路径 |
| #referrer | 前向路径 | 文本 | 被展示页面之前页面的路径,也就是跳转前路径,如果是启动小程序时展示的首页,则取值为“直接打开” |
- 小程序页面转发分享(ta_mp_share)的预置属性
| 属性名 | 中文名 | 属性类型 | 说明 |
|---|---|---|---|
| #url_path | 页面路径 | 文本 | 小程序被转发时所在的页面路径 |
三、获取预置属性
服务端埋点需要 App 端的一些预置属性时,可以通过此方法获取 客户端 端的预置属性,再传给服务端。
//获取属性对象
var presetProperties = TDAnalytics.getPresetProperties();
//生成事件预置属性
var properties = presetProperties.toEventPresetProperties();
/*
{
"#device_model":"iPhone 5",
"#device_id":"3204487163-1624513721217",
"#screen_width":320,
"#screen_height":568,
"#os":"iOS",
"#os_version":"10.0.1",
"#network_type":"wifi",
"#zone_offset":8,
"#manufacturer":"Apple"
}
*/
//获取某个预置属性
var os=presetProperties.os;//os类型,如Android
var osVersion=presetProperties.osVersion;//系统版本号
var networkType=presetProperties.networkType;//网络类型
var manufacture=presetProperties.manufacturer;//设备制造商
var deviceModel=presetProperties.deviceModel;//设备型号
var screenWidth=presetProperties.screenWidth;//屏幕宽度
var screenHeight=presetProperties.screenHeight;//屏幕高度
var deviceId=presetProperties.deviceId;//设备ID
var zoneOffset=presetProperties.zoneOffset;//时区偏移值
IP,国家城市信息由服务端解析生成,客户端不提供接口获取这些属性
这篇文档对你有帮助吗?

