ae-tracking 0.1.0

package/wiki/te-docs/raw//346/216/245/345/205/245/346/214/207/345/215/227//345/256/242/346/210/267/347/253/257-sdk/macos.md

@@ -0,0 +1,317 @@
+---
+code: macos_sdk_installation
+name: "macOS"
+wikiToken: FNr7wvZGCiD2nEkoGzWcUEXOn0g
+parentWikiToken: FTcTwinIOi3OiRkK4MPc2Ex7neg
+updateTime: 1745310913000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v5.0&lan=zh-CN&code=macos_sdk_installation
+---
+# macOS
+
+::: tip 提示 
+
+ 在接入前，请先阅读接入前准备。
+
+macOS SDK 要求最低系统版本为 OSX 10.11
+
+:::
+
+**最新版本: **v3.0.4
+
+**更新时间:** 2024-08-01
+
+**资源下载: **源代码
+
+**Beta版本: **v3.0.5-beta.1
+
+::: tip 注意
+
+iOS SDK 从 v3.0.0 版本已适配 macOS 平台
+
+:::
+
+### 一、集成SDK
+
+使用 CocoaPods 安装 SDK
+
+1.创建并编辑 Podfile 内容（如果已有，直接编辑）：
+
+创建 Podfile，项目工程（`.xcodeproj`）文件同目录下命令行执行命令：
+
+```
+pod init
+```
+
+编辑 Podfile 的内容如下：
+
+```
+platform :osx, '10.10'
+target 'YourProjectTarget' do
+  pod 'ThinkingSDK'
+end
+```
+
+2.执行安装命令
+
+```
+pod install
+```
+
+3.导入成功，启动工程
+
+命令执行成功后，会生成 `.xcworkspace` 文件，说明您已成功导入 `SDK`。打开 `.xcworkspace` 文件以启动工程（注意：此时不能同时开启 `.xcodeproj` 文件
+
+### 二、初始化
+
+在主线程中完成初始化操作，示例代码如下:
+
+:::: el-tabs
+
+::: el-tab-pane label=Objective-C
+
+```
+#import <ThinkingSDK/ThinkingSDK.h>
+
+// SDK needs to be initialized on the main thread
+
+NSString *appid = @"APPID";
+NSString *url = @"SERVER_URL";
+    
+// the first way
+[TDAnalytics startAnalyticsWithAppId:appid serverUrl:url];
+    
+// the second way
+TDConfig *config = [[TDConfig alloc] init];
+config.appid = appid;
+config.serverUrl = url;
+[TDAnalytics startAnalyticsWithConfig:config];
+```
+
+:::
+
+::: el-tab-pane label=Swift
+
+```
+// SDK needs to be initialized on the main thread
+
+**let** appid = "APPID";
+**let** url = "SERVER_URL";
+
+// the first way
+TDAnalytics.start(withAppId: appid, serverUrl: url)
+
+// the second way
+**let** config = TDConfig(appId: appid, serverUrl: url)
+TDAnalytics.start(with: config)
+```
+
+:::
+
+::::
+
+参数说明:
+
+- `APPID`: 您的项目的 APPID，可通过在 AE 后台项目管理页面获取
+- `SERVER_URL`: 数据上传的 URL
+- 如果您对接的是云服务，填入: https://global-receiver-ta.thinkingdata.cn
+- 如果您使用私有化部署版本，请为数据采集地址绑定域名，并配置 HTTPS 证书：https://数据采集地址绑定域名
+### 三、常用功能
+
+在使用常用功能之前，建议你先了解用户识别规则；SDK默认会生成随机数作为访客ID，并持久化存储访客ID在本地；用户未登录之前，会以访客ID作为身份识别ID。注意:访客 ID 在用户重新安装 App 以及更换设备时将会变更。
+
+#### 3.1 设置账号ID
+
+在用户进行登录时，可调用 `login:` 来设置用户的账号 ID， AE 平台将会以账号 ID 作为身份识别 ID，并且设置的账号 ID 将会在调用 `logout` 之前一直保留。多次调用 `login:` 将覆盖先前的账号 ID 。
+
+:::: el-tabs
+
+::: el-tab-pane label=Objective-C
+
+```
+// 用户的登录唯一标识，此数据对应上报数据里的#account_id，此时#account_id的值为TD
+[TDAnalytics login:@"TD"];
+```
+
+:::
+
+::: el-tab-pane label=Swift
+
+```
+// 用户的登录唯一标识，此数据对应上报数据里的#account_id，此时#account_id的值为TD
+TDAnalytics.login("TD")
+```
+
+:::
+
+::::
+
+<!-- unsupported block: 34 -->
+
+**该方法不会上传登录事件**
+
+#### 3.2  设置公共事件属性
+
+公共事件属性指的就是每个事件都会带有的属性，您可以调用 `setSuperProperties` 来设置公共事件属性，我们推荐您在发送事件前，先设置公共事件属性。对于一些重要的属性，譬如用户的会员等级、来源渠道等，这些属性需要设置在每个事件中，此时您可以将这些属性设置为公共事件属性。
+
+:::: el-tabs
+
+::: el-tab-pane label=Objective-C
+
+```
+NSDictionary *superProperties = @{
+    @"channel": @"ta",
+    @"age": @1,
+    @"isSuccess": @YES,
+    @"birthday": [NSDate date],
+    @"object": @{
+        @"key":@"value"
+    },
+    @"object_arr":@[
+        @{
+            @"key":@"value"
+        }
+    ],
+    @"arr": @[@"value"],
+};
+[TDAnalytics setSuperProperties:superProperties];
+```
+
+:::
+
+::: el-tab-pane label=Swift
+
+```
+var superProperties: [AnyHashable : Any] = [:]
+superProperties["channel"] = "ta" //字符串
+superProperties["age"] = 1 //数字
+superProperties["isSuccess"] = true //布尔
+superProperties["birthday"] = Date() //时间
+superProperties["object"] = [
+    "key": "value"
+] //对象
+superProperties["object_arr"] = [["key": "value"]] // 对象组
+superProperties["arr"] = ["value"] // 数组
+
+//设置公共事件属性
+TDAnalytics.setSuperProperties(superProperties)
+```
+
+:::
+
+::::
+
+公共事件属性将会被保存到缓存中，无需每次启动 App 时调用。如果调用 `setSuperProperties:` 设置了先前已设置过的公共事件属性，则会覆盖之前的属性。
+
+- 事件的属性是一个 `NSDictionary` 对象，其中每个元素代表一个属性。
+- Key 为该属性的名称，为字符串类型，规定只能以字母开头，包含数字，字母和下划线 "_"，长度最大为 50 个字符，对字母大小写不敏感，AE 会统一转化为小写字母
+- Value 为该属性的值，支持字符串、数字、布尔、时间、对象、对象组、数组
+- 如果您需要上传布尔型的属性，则请以 `@YES` 与 `@NO` 或 `[NSNumber numberWithBool:YES]` 与 `[NSNumber numberWithBool:NO]` 来赋值。**不可以使用** `@true`、 `@false`、 `@TRUE` 和 `@FALSE` 赋值布尔型数据。
+<!-- unsupported block: 34 -->
+
+**事件属性、用户属性的要求与公共事件属性保持一致**
+
+#### 3.3 发送事件
+
+您可以调用 `track` 来上传事件，建议您根据先前梳理的埋点文档来设置事件的属性以及发送信息的条件，此处以用户购买某商品作为范例：
+
+:::: el-tabs
+
+::: el-tab-pane label=Objective-C
+
+```
+// 上传购买商品事件
+NSDictionary *eventProperties = @{@"product_name": @"book"};
+[TDAnalytics track:@"product_buy" properties:eventProperties];
+```
+
+:::
+
+::: el-tab-pane label=Swift
+
+```
+// 上传购买商品事件
+**let** properties = ["product_name": "book"] **as** [String: **Any**]
+TDAnalytics.track("product_buy", properties: properties)
+```
+
+:::
+
+::::
+
+事件的名称是字符串类型，只能以字母开头，可包含数字，字母和下划线 "_"，长度最大为 50 个字符。
+
+#### 3.4 设置用户属性
+
+对于一般的用户属性，您可以调用 `user_set:` 来进行设置，使用该接口上传的属性将会覆盖原有的属性值，如果之前不存在该用户属性，则会新建该用户属性，类型与传入属性的类型一致，此处以设置用户名为例：
+
+:::: el-tabs
+
+::: el-tab-pane label=Objective-C
+
+```
+// "username" is "ThinkingData"
+[TDAnalytics userSet:@{@"username": @"ThinkingData"}];
+// "username" is "TA"
+[TDAnalytics userSet:@{@"username": @"TA"}];
+```
+
+:::
+
+::: el-tab-pane label=Swift
+
+```
+// 设置用户属性
+//此时"username"为"ThinkingData"
+TDAnalytics.userSet(["usernaame": "ThinkingData"])
+//此时"username"为"TA"
+TDAnalytics.userSet(["usernaame": "TA"])
+```
+
+:::
+
+::::
+
+### 四、最佳实践
+
+以下示例代码包含以上所有操作，我们推荐按照如下步骤使用:
+
+```
+if (授权隐私政策) {
+    // enable log
+    [TDAnalytics enableLog:NO];
+    
+    // SDK needs to be initialized on the main thread
+    NSString *appid = @"APPID";
+    NSString *url = @"SERVER_URL";
+    TDConfig *config = [[TDConfig alloc] init];
+    config.appid = appid;
+    config.serverUrl = url;
+    [TDAnalytics startAnalyticsWithConfig:config];
+    
+    [TDAnalytics login:@"TD"];
+    
+    NSDictionary *superProperties = @{
+        @"channel": @"ta",
+        @"age": @1,
+        @"isSuccess": @YES,
+        @"birthday": [NSDate date],
+        @"object": @{
+            @"key":@"value"
+        },
+        @"object_arr":@[
+            @{
+                @"key":@"value"
+            }
+        ],
+        @"arr": @[@"value"],
+    };
+    [TDAnalytics setSuperProperties:superProperties];
+    
+    NSDictionary *eventProperties = @{@"product_name": @"book"};
+    [TDAnalytics track:@"product_buy" properties:eventProperties];
+    
+    // "username" is "ThinkingData"
+    [TDAnalytics userSet:@{@"username": @"ThinkingData"}];
+}
+
+```

package/wiki/te-docs/raw//346/216/245/345/205/245/346/214/207/345/215/227//345/256/242/346/210/267/347/253/257-sdk/openharmony//345/220/210/350/247/204/346/214/207/345/215/227.md

@@ -0,0 +1,345 @@
+---
+code: openharmony_sdk_compliance
+name: "合规指南"
+wikiToken: VS7UwlrJaiOAzqk4oDhc4Qggnld
+parentWikiToken: CdewwjvM9irVHckq2lvctVPNnhf
+updateTime: 1768809398000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v5.0&lan=zh-CN&code=openharmony_sdk_compliance
+---
+# 合规指南
+
+### 一、最新SDK版本说明
+
+满足监管新规的最新SDK版本：1.7.6
+
+### 二、权限调用合规要求
+
+***权限名称***
+
+***权限说明***
+
+***使用目的***
+
+***权限申请时机***
+
+*ohos.permission.INTERNET*
+
+*允许使用Internet网络*
+
+*在使用上报数据功能时，用于访问网络数据*
+
+*SDK初始化或者调用上报数据接口时*
+
+*ohos.permission.GET_NETWORK_INFO*
+
+*允许应用获取网络信息*
+
+*在使用上报数据功能时，SDK 会根据网络状态选择是否发送数据*
+
+*SDK初始化时*
+
+*ohos.permission.STORE_PERSISTENT_DATA*
+
+*允许应用存储持久化的数据*
+
+*存储应用卸载之后需要保持不变的数据*
+
+*SDK初始化时*
+
+### 三、延迟初始化要求
+
+为了避免您的应用在未获取用户的同意前SDK提前处理用户的个人信息，SDK需要在用户同意 《隐私政策》后初始化。
+
+示例代码如下：
+
+```
+// 根据隐私协议判断是否开启数据采集
+if (授权隐私政策) {
+    TDAnalytics.init(context, "appId", "serverUrl")
+}
+```
+
+SDK初始化的时候会收集操作系统版本、设备制造商、操作系统、屏幕分辨率、设备型号、APP 版本、网络状态、网络运营商、应用安装时间、系统语言等信息，用于统计分析功能。
+
+### 四、SDK 可选个人信息的配置说明
+
+开发者可以通过 SDK 可选个⼈信息的配置示例说明进⾏配置。您可以在SDK初始化的时候配置`disablePresetProperties` 参数，配置需要禁用的设备信息数组。disablePresetProperties默认是空数组，就是默认会采集所有的预置属性，如果你需要禁用某一个预置属性，可以将需要禁用的预置属性添加到disablePresetProperties数组中。
+
+以下是SDK 中所有事件默认采集的预置属性：
+
+**属性名**
+
+**中文名**
+
+**属性类型**
+
+**采集时机**
+
+**说明**
+
+#ip
+
+IP 地址
+
+文本
+
+服务端采集
+
+用户的 IP 地址，AE 将以此获取用户的地理位置信息
+
+#country
+
+国家
+
+文本
+
+服务端采集
+
+用户所在国家，根据 IP 地址生成
+
+#country_code
+
+国家代码
+
+文本
+
+服务端采集
+
+用户所在国家的国家代码(ISO 3166-1 alpha-2，即两位大写英文字母)，根据 IP 地址生成
+
+#province
+
+省份
+
+文本
+
+服务端采集
+
+用户所在省份，根据 IP 地址生成
+
+#city
+
+城市
+
+文本
+
+服务端采集
+
+用户所在城市，根据 IP 地址生成
+
+#os_version
+
+操作系统版本
+
+文本
+
+初始化时采集一次
+
+iOS 11.2.2、Android 8.0.0 等
+
+#manufacturer
+
+设备制造商
+
+文本
+
+初始化时采集一次
+
+用户设备的制造商，如 Apple，vivo 等
+
+#os
+
+操作系统
+
+文本
+
+初始化时采集一次
+
+如 Android、iOS、HarmonyOS 等
+
+#device_id
+
+设备 ID
+
+文本
+
+初始化时采集一次
+
+用户的设备 ID，iOS 取用户的 IDFV 或 UUID，Android 取 androidID
+
+#screen_height
+
+屏幕高度
+
+数值
+
+初始化时采集一次
+
+用户设备的屏幕高度，如 1920 等
+
+#screen_width
+
+屏幕宽度
+
+数值
+
+初始化时采集一次
+
+用户设备的屏幕高度，如 1080 等
+
+#device_model
+
+设备型号
+
+文本
+
+初始化时采集一次
+
+用户设备的型号，如 iPhone 8 等
+
+#device_type
+
+设备类型
+
+文本
+
+初始化时采集一次
+
+设备类型，如 "Tablet"、"Phone"
+
+#app_version
+
+APP 版本
+
+文本
+
+初始化时采集一次
+
+您的 APP 的版本
+
+#bundle_id
+
+应用唯一标识
+
+文本
+
+初始化时采集一次
+
+应用包名或进程名
+
+#lib
+
+SDK 类型
+
+文本
+
+初始化时采集一次
+
+您接入 SDK 的类型，如 Android，iOS 等
+
+#lib_version
+
+SDK 版本
+
+文本
+
+初始化时采集一次
+
+您接入 SDK 的版本
+
+#network_type
+
+网络状态
+
+文本
+
+初始化时采集一次，网络状态变化时采集
+
+上传事件时的网络状态，如 WIFI、3G、4G 等
+
+#carrier
+
+网络运营商
+
+文本
+
+初始化时采集一次
+
+用户设备的网络运营商，如中国移动，中国电信等
+
+#zone_offset
+
+时区偏移
+
+数值
+
+事件发生时采集
+
+数据时间相对 UTC 时间的偏移小时数
+
+#install_time
+
+程序安装时间
+
+时间
+
+初始化时采集一次
+
+用户安装应用的时间，值来源于系统
+
+#system_language
+
+系统语言
+
+文本
+
+初始化时采集一次
+
+用户设备的系统语言(ISO 639-1，即两位小写英文字母)，如 zh, en 等
+
+例如您需要禁用#os（操作系统）、#os_version（操作系统版本），配置示例代码如下：
+
+```
+**let **config = **new **TDConfig()
+config.appId = 'appId'
+config.serverUrl = 'url'
+config.disablePresetProperties =["#os", "#os_version"]
+TDAnalytics.initWithConfig(context, config)
+```
+
+如果您需要禁用全部的预置属性，可以将所有的属性配置到disablePresetProperties数组中，示例代码如下：
+
+```
+**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)
+```
+
+### 五、隐私政策披露要求与示例说明
+
+在您接入、使用数数科技SDK服务前，我们要求您在隐私政策中向用户告知我们SDK的名称、SDK提供方名称、收集个人信息类型、使用目的、隐私政策链接，并获取用户的同意或取得其他合法性基础。您可以参考如下方式提供条款内容：
+
+**第三方SDK名称**：数数科技SDK
+
+**第三方公司名称**：数数信息科技(上海)有限公司
+
+**收集个人信息类型**：在《隐私政策》中收集和获得您的个人信息栏目中根据实际情况填写以下内容，当您在激活使用时，我们会通过数数科技SDK收集您的设备信息（IP 地址解析的位置信息、国家、国家代码、省份、城市、操作系统版本、设备制造商、操作系统、屏幕分辨率、设备型号、APP 版本、网络状态、网络运营商、应用安装时间、系统语言）。
+
+**个人信息收集时机：**SDK初始化时获取。
+
+**使用目的**：用于统计分析用户在 App 内的使用效果。
+
+**隐私政策链接：****https://docs-v2.thinkingdata.cn/?version=latest&lan=zh-CN&code=privacy_cn&anchorId=**
+
+### 六、最终用户授权同意的建议方式
+
+App ⾸次运⾏时应当有隐私弹窗，隐私弹窗中应公示简版隐私政策内容并附完整版隐私政策链接，并明 确提示最终⽤户阅读并选择是否同意隐私政策；隐私弹窗应提供同意按钮和拒绝同意的按钮，并由最终⽤户主动选择。
+
+建议通过弹窗的形式征求用户授权同意，弹窗内容中需包含数数科技SDK需要申请的权限和采集的用户相关信息。
+
+隐私政策授权弹窗示例：
+
+敏感个人信息授权弹窗示例：