integrationlatest接入文档 / 预置属性
预置属性
一、所有事件的预置属性
以下预置属性,是 JavaScript SDK 中所有事件(包括自动采集事件)都会带有的预置属性
| 属性名 | 中文名 | 属性类型 | 说明 |
|---|---|---|---|
| #ip | IP 地址 | 文本 | 用户的 IP 地址,AE 将以此获取用户的地理位置信息 |
| #country | 国家 | 文本 | 用户所在国家,根据 IP 地址生成 |
| #country_code | 国家代码 | 文本 | 用户所在国家的国家代码(ISO 3166-1 alpha-2,即两位大写英文字母),根据 IP 地址生成 |
| #province | 省份 | 文本 | 用户所在省份,根据 IP 地址生成 |
| #city | 城市 | 文本 | 用户所在城市,根据 IP 地址生成 |
| #device_id | 设备 ID | 文本 | 用户的设备 ID |
| #screen_height | 屏幕高度 | 数值 | 用户设备的屏幕高度,如 1920 等 |
| #screen_width | 屏幕宽度 | 数值 | 用户设备的屏幕高度,如 1080 等 |
#lib | SDK 类型 | 文本 | 您接入 SDK 的类型,如 JavaScript 等 |
| #lib_version | SDK 版本 | 文本 | 您接入 SDK 的版本 |
| #os | 操作系统 | 文本 | 如Android、iOS等 |
| #browser | 浏览器类型 | 文本 | 用户使用的浏览器类型,如 Chrome,Firefox 等 |
| #browser_version | 浏览器版本 | 文本 | 用户使用的浏览器的版本,如 Chrome 61.0,Firefox 57.0 等 |
| #zone_offset | 时区偏移 | 数值 | 数据时间相对 UTC 时间的偏移小时数 |
| #system_language | 系统语言 | 文本 | 用户系统设置的语言 |
#ua | 用户当前的代理信息 | 文本 | 能够识别客户使用的操作系统及版本、CPU 类型、浏览器及版本、浏览器渲染引擎、浏览器语言、浏览器插件等。 |
#utm | 广告系列来源属性 | 文本 | 用户来源的广告信息,其中包含广告来源,广告媒介等信息 |
二、自动采集事件的预置属性
| 属性名 | 中文名 | 属性类型 | 说明 |
|---|---|---|---|
| #url | 页面地址 | 文本 | 当前页面的地址 |
| #url_path | 页面路径 | 文本 | 当前页面的路径 |
| #referrer | 前向地址 | 文本 | 跳转前页面的地址 |
| #referrer_host | 前向域名 | 文本 | 跳转前页面的域名 |
| #title | 页面标题 | 文本 | 当前页面的标题 |
三、 获取预置属性
服务端埋点需要 App 端的一些预置属性时,可以通过此方法获取 客户端 端的预置属性,再传给服务端。
//获取属性对象
var presetProperties = ta.getPresetProperties();
//生成事件预置属性
var properties = presetProperties.toEventPresetProperties();
/*
{
"#os":"Mac OS X",
"#screen_width":1920,
"#screen_height":1080,
"#browser":"chrome",
"#browser_version":"91.0.4472.114",
"#device_id":"17a3858fafd9b4-0693d07132e2d1-34657600-2073600-17a3858fafea9b",
"#zone_offset":8
}
*/
//获取某个预置属性
var os = presetProperties.os;//os类型,如Android
var screenWidth = presetProperties.screenWidth;//屏幕宽度
var screenHeight = presetProperties.screenHeight;//屏幕高度
var browser = presetProperties.browser;//浏览器类型
var browserVersion = presetProperties.browserVersion;//浏览器版本号
var deviceId = presetProperties.deviceId;//设备ID
var zoneOffset = presetProperties.zoneOffset;//时区偏移值
IP,国家城市信息由服务端解析生成,客户端不提供接口获取这些属性
四、关闭预置属性采集
在某些场景下,出于合规、实际业务需求等的考量,您也许期望禁止某些预置属性的采集。您可以在初始化的时候传入disablePresetProperties字段,类型是Array,添加的字段对应的预置属性将不会上传。如屏蔽"#os", "#lib", "#lib_version", "#url", "#url_path"等预置属性,配置如下:
var config = {
appId: "APP_ID",
serverUrl: "https://YOUR_SERVER_URL/sync_js",
batch:true,
autoTrack: {
pageShow: true,
pageHide: true,
},
disablePresetProperties:['#os','#lib_version','#lib','#screen_height','#screen_width','#browser','#browser_version',
'#system_language','#ua','#utm','#referrer','#referrer_host','#url','#url_path','#title','#element_type']
};
window.ta = thinkingdata;
ta.init(config);
如果您屏蔽设备ID的情况下,需要使用首次事件,请务必填写first_check_id属性
这篇文档对你有帮助吗?

