@thinkingai/ae-cli 1.0.28 → 6.0.16

package/wiki/te-docs/raw//345/256/242/346/210/267/347/253/257-sdk/openharmony//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,447 @@
+---
+code: openharmony_sdk_preset_properties
+name: "预置属性"
+wikiToken: QC6vwenmMirVUHkZa7Cc1tttnSn
+parentWikiToken: OC7JwBjzKiqT9Ck1WPAcpEaGnBd
+updateTime: 1776262489000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=zh-CN&code=openharmony_sdk_preset_properties
+---
+
+## 一、 所有事件带有的预置属性
+以下预置属性，是 OpenHarmony SDK 中所有事件（包括自动采集事件）都会带有的预置属性
+
+<lark-table rows="23" cols="5" column-widths="243,116,100,146,306">
+
+  <lark-tr>
+    <lark-td>
+      **属性名**
+    </lark-td>
+    <lark-td>
+      **中文名**
+    </lark-td>
+    <lark-td>
+      **属性类型** {align="center"}
+    </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>
+      服务端采集 {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>
+      服务端采集 {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>
+      服务端采集 {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>
+      服务端采集 {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>
+      服务端采集 {align="center"}
+    </lark-td>
+    <lark-td>
+      用户所在城市，根据 IP 地址生成
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #os_version
+    </lark-td>
+    <lark-td>
+      操作系统版本
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </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>
+      #manufacturer
+    </lark-td>
+    <lark-td>
+      设备制造商
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      初始化时采集一次 {align="center"}
+    </lark-td>
+    <lark-td>
+      用户设备的制造商，如 Apple，vivo 等
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #os
+    </lark-td>
+    <lark-td>
+      操作系统
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      初始化时采集一次 {align="center"}
+    </lark-td>
+    <lark-td>
+      如 Android、iOS、HarmonyOS 等
+    </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>
+      初始化时采集一次 {align="center"}
+    </lark-td>
+    <lark-td>
+      用户的设备 ID，iOS 取用户的 IDFV 或 UUID，Android 取 androidID
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #screen_height
+    </lark-td>
+    <lark-td>
+      屏幕高度
+    </lark-td>
+    <lark-td>
+      数值 {align="center"}
+    </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>
+      初始化时采集一次 {align="center"}
+    </lark-td>
+    <lark-td>
+      用户设备的屏幕高度，如 1080 等
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #device_model
+    </lark-td>
+    <lark-td>
+      设备型号
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      初始化时采集一次 {align="center"}
+    </lark-td>
+    <lark-td>
+      用户设备的型号，如 iPhone 8 等
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #device_type
+    </lark-td>
+    <lark-td>
+      设备类型
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      初始化时采集一次 {align="center"}
+    </lark-td>
+    <lark-td>
+      设备类型，如 "Tablet"、"Phone"
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #app_version
+    </lark-td>
+    <lark-td>
+      APP 版本
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      初始化时采集一次 {align="center"}
+    </lark-td>
+    <lark-td>
+      您的 APP 的版本
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #bundle_id
+    </lark-td>
+    <lark-td>
+      应用唯一标识
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      初始化时采集一次 {align="center"}
+    </lark-td>
+    <lark-td>
+      应用包名或进程名
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #lib
+    </lark-td>
+    <lark-td>
+      SDK 类型
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      初始化时采集一次 {align="center"}
+       {align="center"}
+    </lark-td>
+    <lark-td>
+      您接入 SDK 的类型，如 Android，iOS 等
+    </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>
+      初始化时采集一次 {align="center"}
+    </lark-td>
+    <lark-td>
+      您接入 SDK 的版本
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #network_type
+    </lark-td>
+    <lark-td>
+      网络状态
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      初始化时采集一次，网络状态变化时采集 {align="center"}
+    </lark-td>
+    <lark-td>
+      上传事件时的网络状态，如 WIFI、3G、4G 等
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #carrier
+    </lark-td>
+    <lark-td>
+      网络运营商
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      初始化时采集一次 {align="center"}
+       {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>
+      事件发生时采集 {align="center"}
+       {align="center"}
+    </lark-td>
+    <lark-td>
+      数据时间相对 UTC 时间的偏移小时数
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #install_time
+    </lark-td>
+    <lark-td>
+      程序安装时间
+    </lark-td>
+    <lark-td>
+      时间 {align="center"}
+    </lark-td>
+    <lark-td>
+      初始化时采集一次 {align="center"}
+    </lark-td>
+    <lark-td>
+      用户安装应用的时间，值来源于系统
+    </lark-td>
+  </lark-tr>
+  <lark-tr>
+    <lark-td>
+      #system_language
+    </lark-td>
+    <lark-td>
+      系统语言
+    </lark-td>
+    <lark-td>
+      文本 {align="center"}
+    </lark-td>
+    <lark-td>
+      初始化时采集一次 {align="center"}
+    </lark-td>
+    <lark-td>
+      用户设备的系统语言(ISO 639-1，即两位小写英文字母)，如 zh, en 等
+    </lark-td>
+  </lark-tr>
+</lark-table>
+
+## 二、获取预置属性
+可以调用 `getPresetProperties()` 方法获取预置属性。
+服务端埋点需要 App 端的一些预置属性时，可以通过此方法获取 App 端的预置属性，再传给服务端。
+```java
+TDAnalytics.getPresetProperties()
+
+/**
+{
+    "#os": "HarmonyOS",
+    "#os_version": 10,
+    "#bundle_id": "com.example.tdharmonyosdemo",
+    "#install_time": "2023-10-19 18:46:00.105",
+    "#manufacturer": "HUAWEI",
+    "#device_model": "NOH-AN00",
+    "#device_type": "phone",
+    "#screen_width": 1344,
+    "#screen_height": 2772,
+    "#system_language": "zh-Hans",
+    "#carrier": "中国电信",
+    "#app_version": "1.0.1",
+    "#device_id": "9811b90b-ee24-45c1-950a-77ee0ffc7a1c",
+    "#zone_offset": 8
+}
+*/
+
+```
+
+## 三、关闭预置属性
+在某些场景下，出于合规、实际业务需求等的考量，您也许期望禁止某些预置属性的采集。您可以在SDK初始化的时候配置`disablePresetProperties` 参数，用于配置需要禁用采集的属性数组。示例代码如下：
+```typescript
+let config = new TDConfig()
+config.appId = 'appId'
+config.serverUrl = 'url'
+config.disablePresetProperties =["#lib", "#lib_version", "#os", "#os_version", "#bundle_id", "#install_time", "#manufacturer", "#device_model",
+"#device_type", "#screen_width", "#screen_height","#system_language","#carrier","#app_version","#device_id","#network_type","#ip"]
+TDAnalytics.initWithConfig(context, config)
+```