@thinkingai/ae-cli 1.0.28 → 6.0.16

package/wiki/te-docs/raw//345/256/242/346/210/267/347/253/257-sdk//346/270/270/346/210/217/345/274/225/346/223/216/layaair//350/277/233/351/230/266/346/214/207/345/215/227//351/242/204/347/275/256/345/261/236/346/200/247.md

@@ -0,0 +1,406 @@
+---
+code: laya_sdk_preset_properties
+name: "预置属性"
+wikiToken: DMqZwQ99BiC53vkE30ochUY7nqd
+parentWikiToken: UGaFwQQPEi69XukGdVocvRTSnjh
+updateTime: 1776262602000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=zh-CN&code=laya_sdk_preset_properties
+---
+
+### 一、所有事件带有的预置属性
+<quote-container>
+各个平台采集的预置属性会有一定的差异，具体可以参考如下文档: [Android平台](https://thinkingdata.feishu.cn/wiki/XV9VwubUfipDxdkCdzocbJOhnvy) 、 [iOS平台](https://thinkingdata.feishu.cn/wiki/DKycwSlK6ikO4ckfsqOcvh7Sn6b)  
+</quote-container>
+
+**小游戏平台所有事件都会带有的预置属性:**
+
+<lark-table rows="19" cols="4" column-widths="243,243,100,243">
+
+  <lark-tr>
+    <lark-td>
+      **属性名**
+    </lark-td>
+    <lark-td>
+      **中文名**
+    </lark-td>
+    <lark-td>
+      **属性类型** {align="center"}
+    </lark-td>
+    <lark-td>
+      **说明**
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #ip
+    </lark-td>
+    <lark-td>
+      IP 地址
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      用户的 IP 地址，AE 将以此获取用户的地理位置信息
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #country
+    </lark-td>
+    <lark-td>
+      国家
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      用户所在国家，根据 IP 地址生成
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #country_code
+    </lark-td>
+    <lark-td>
+      国家代码
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      用户所在国家的国家代码(ISO 3166-1 alpha-2，即两位大写英文字母)，根据 IP 地址生成
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #province
+    </lark-td>
+    <lark-td>
+      省份
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      用户所在省份，根据 IP 地址生成
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #city
+    </lark-td>
+    <lark-td>
+      城市
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      用户所在城市，根据 IP 地址生成
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #device_model
+    </lark-td>
+    <lark-td>
+      设备型号
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      用户设备的型号，如 iPhone 8 等
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #device_id
+    </lark-td>
+    <lark-td>
+      设备 ID
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      用户的设备 ID，取初始化时生成的 UUID
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #screen_height
+    </lark-td>
+    <lark-td>
+      屏幕高度
+    </lark-td>
+    <lark-td>
+      数值 {align="center"}
+    </lark-td>
+    <lark-td>
+      用户设备的屏幕高度，如 1920 等
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #screen_width
+    </lark-td>
+    <lark-td>
+      屏幕宽度
+    </lark-td>
+    <lark-td>
+      数值 {align="center"}
+    </lark-td>
+    <lark-td>
+      用户设备的屏幕高度，如 1080 等
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #manufacturer
+    </lark-td>
+    <lark-td>
+      设备制造商
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      用户设备的制造商，如 Apple，vivo 等
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #os_version
+    </lark-td>
+    <lark-td>
+      操作系统版本
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      iOS 11.2.2、Android 8.0.0 等
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #os
+    </lark-td>
+    <lark-td>
+      操作系统
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      如 Android、iOS 等
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #network_type
+    </lark-td>
+    <lark-td>
+      网络状态
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      上传事件时的网络状态，如 WIFI、3G、4G 等
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #lib
+    </lark-td>
+    <lark-td>
+      SDK 类型
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      您接入 SDK 的类型，如 MG（小游戏）
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #lib_version
+    </lark-td>
+    <lark-td>
+      SDK 版本
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      您接入 SDK 的版本
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #scene
+    </lark-td>
+    <lark-td>
+      场景值
+    </lark-td>
+    <lark-td>
+      数值 {align="center"}
+    </lark-td>
+    <lark-td>
+      微信小游戏启动时传入的场景值
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #mp_platform
+    </lark-td>
+    <lark-td>
+      小游戏平台
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      标识应用所在的平台
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #zone_offset
+    </lark-td>
+    <lark-td>
+      时区偏移
+    </lark-td>
+    <lark-td>
+      数值 {align="center"}
+    </lark-td>
+    <lark-td>
+      数据时间相对 UTC 时间的偏移小时数
+    </lark-td>
+  </lark-tr>
+</lark-table>
+
+### 二、自动采集事件的预置属性
+以下预置属性，是各个自动采集事件中所特有的预置属性
+- 小程序启动（ta_mp_show）的预置属性
+
+<lark-table rows="3" cols="4" column-widths="243,243,100,243">
+
+  <lark-tr>
+    <lark-td>
+      **属性名**
+    </lark-td>
+    <lark-td>
+      **中文名**
+    </lark-td>
+    <lark-td>
+      **属性类型** {align="center"}
+    </lark-td>
+    <lark-td>
+      **说明**
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #url_path
+    </lark-td>
+    <lark-td>
+      页面路径
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      小程序启动被展示页面的路径
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #start_reason
+    </lark-td>
+    <lark-td>
+      应用启动来源
+    </lark-td>
+    <lark-td>
+      文本
+    </lark-td>
+    <lark-td>
+      内容为JSON字符串，是从`getLaunchOptionsSync`接口获取的参数
+    </lark-td>
+  </lark-tr>
+</lark-table>
+
+- 小游戏隐藏（ta_mg_hide）的预置属性
+
+<lark-table rows="2" cols="4" column-widths="243,243,100,243">
+
+  <lark-tr>
+    <lark-td>
+      **属性名**
+    </lark-td>
+    <lark-td>
+      **中文名**
+    </lark-td>
+    <lark-td>
+      **属性类型** {align="center"}
+    </lark-td>
+    <lark-td>
+      **说明**
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #duration
+    </lark-td>
+    <lark-td>
+      事件时长
+    </lark-td>
+    <lark-td>
+      数值 {align="center"}
+    </lark-td>
+    <lark-td>
+      表示本次启动 `ta_mg_show` 到隐藏 `ta_mg_hide` 的持续时长，单位是秒
+    </lark-td>
+  </lark-tr>
+</lark-table>
+
+### 三、获取预置属性
+服务端埋点需要 App 端的一些预置属性时，可以通过此方法获取 客户端 端的预置属性，再传给服务端。
+```javascript
+//获取属性对象
+TDAnalytics.getPresetPropertiesAsync((presetProperties)=>{
+    //生成事件预置属性
+    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;//时区偏移值
+```
+
+<quote-container>
+IP，国家城市信息由服务端解析生成，客户端不提供接口获取这些属性
+</quote-container>