react-native-quicktracking-analytics-module 1.0.0-beta.3 → 1.0.1

package/README.md

@@ -1,8 +1,8 @@
-# 集成
-QT React Native 埋点SDK是基于Quick Tracking 原生客户端SDK上的扩展，封装了埋点常用的api，如全局属性、页面属性、自定义事件等，需要分别在RN、Android、iOS三端做集成。
+# 集成说明
+> QuickTracking React Native SDK是基于QuickTracking 原生客户端埋点SDK上的扩展，封装了QT埋点常用的api，如全局属性、页面属性、自定义事件等，需要分别在RN、Android、iOS三端做集成。
 
-## React Native 集成
-### 下载npm包到项目中
+# React Native SDK集成
+## 下载npm包到项目中
 ```bash
 # npm
 npm install react-native-quicktracking-analytics-module
@@ -13,20 +13,18 @@ yarn add react-native-quicktracking-analytics-module
 # pnpm
 pnpm add react-native-quicktracking-analytics-module
 ```
-
-### 引入QT类
+## 引入SDK环境变量
 ```tsx
 import { QT } from "react-native-quicktracking-analytics-module";
 ```
-
-## Android 集成
+## Android 基座集成
 ### 进入控制台
 进入QT后台，点击“管理控制台”
-![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2022/png/220937/1646903919683-276177f8-42a7-4f6e-87aa-fff88ae87a77.png#clientId=u468f5541-19bf-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=790&id=EZloP&margin=%5Bobject%20Object%5D&name=image.png&originHeight=1580&originWidth=2878&originalType=binary&ratio=1&rotation=0&showTitle=false&size=2103957&status=done&style=none&taskId=ua2f5b36f-3995-47d2-909b-a42abba8f55&title=&width=1439)
+![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2022/png/220937/1646903919683-276177f8-42a7-4f6e-87aa-fff88ae87a77.png#clientId=u468f5541-19bf-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=790&id=VqtE7&margin=%5Bobject%20Object%5D&name=image.png&originHeight=1580&originWidth=2878&originalType=binary&ratio=1&rotation=0&showTitle=false&size=2103957&status=done&style=none&taskId=ua2f5b36f-3995-47d2-909b-a42abba8f55&title=&width=1439)
 
 ### 集成应用
 找到需要集成埋点的应用：进入“应用列表”，选择所需组织，点击操作中的“详情或者去集成”
-![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2022/png/220937/1646904230482-8878cb3e-71d7-4514-a6a8-4e0b6b2322c0.png#clientId=u468f5541-19bf-4&crop=0&crop=0.1396&crop=1&crop=1&from=paste&height=788&id=dcFuI&margin=%5Bobject%20Object%5D&name=image.png&originHeight=1576&originWidth=2880&originalType=binary&ratio=1&rotation=0&showTitle=false&size=1188843&status=done&style=none&taskId=uc344d9e4-34d9-4702-9b3a-fcec5a8a04c&title=&width=1440)
+![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2022/png/64356327/1668567046473-aab9b13d-38fe-4e33-bd03-e5bedc69b0e4.png#clientId=uf7b76841-8b1b-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=602&id=ub77f00bf&margin=%5Bobject%20Object%5D&name=image.png&originHeight=1204&originWidth=2562&originalType=binary&ratio=1&rotation=0&showTitle=false&size=646074&status=done&style=none&taskId=ube368388-293d-4ce2-a7ad-9aca1566a87&title=&width=1281)
 
 ### Maven地址配置
 在工程 build.gradle 配置脚本中 buildscript 和 allprojects 段中添加 sdk maven 仓库地址
@@ -151,19 +149,122 @@ QtConfigure.init(this,"appkey","unknown",UMConfigure.DEVICE_TYPE_PHONE, "");
 ```
 
 
-## iOS集成
-注意您的ruby版本，MacOS自带的Ruby为2.6.8，不符合RN项目需求。
-建议在本地终端中执行 ruby --version，并下载ruby包管理器，如rbenv或rvm等，改成ruby版本为RN需要的[版本](https://github.com/facebook/react-native/blob/main/template/_ruby-version)
+## iOS 基座集成
+### 使用CocoaPods集成
+进入iOS工程目录
+```shell
+ cd ios && pod install && cd ..
+```
+### SDK初始化并集成appKey
+为保证您的App在集成统计SDK之后，能够满足工信部相关合规要求，您应确保App首次冷启动时，在用户阅读您的《隐私政策》并取得用户授权之后，才调用正式初始化函数初始化统计SDK，此时SDK才会真正采集设备信息并上报数据。反之，如果用户不同意《隐私政策》授权，则不能调用初始化函数
+```objectivec
+- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
+{
+  ...
+  /** 初始化所有组件产品
+     @param appKey 开发者在QT申请的appkey.
+     @param channel 渠道标识，可设置nil表示"App Store".
+ */
+  [QTConfigure initWithAppkey:@"应用的appKey" channel:@"安装渠道"];
+  ...
+  return YES;
+}
+```
+一旦App获取到《隐私政策》的用户授权，后续的App冷启动，开发者应该保证调用到初始化函数。
+### 配置收数域名
+```objectivec
+#import <QTCommon/UMConfigure.h>
+
+- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
+{
+  ...
+  /** 设置上报统计日志的主域名和备用域名。此函数必须在SDK初始化函数调用之前调用。
+    @param primaryDomain 传日志的主域名收数地址,参数不能为null或者空串。例如：https://www.umeng.com
+    @param standbyDomain 上传日志备用域名收数地址,参数可以为null或者空串，若此参数为空，SDK内部会自动将主域名设置为备用域名。
+  */
+
+  [QTConfigure setCustomDomain:@"主收数域名" standbyDomain:@"备用收数域名"];
+  ...
+  return YES;
+}
+```
+### 按需引入日志组件
+引入统计所需组件库（在更新SDK时，您可以直接使用 pod update 命令进行直接更新）
+```objectivec
+pod 'UMCCommonLog'
+```
+Podfile示例
+![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2022/png/281773/1668518339815-d4ccb536-a399-4341-ba2c-902dcf24b1da.png#clientId=uf686b11a-7b20-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=564&id=u6a3e4c24&margin=%5Bobject%20Object%5D&name=image.png&originHeight=571&originWidth=751&originalType=binary&ratio=1&rotation=0&showTitle=false&size=80695&status=done&style=none&taskId=ub00bc826-f430-4519-9921-c4040b208a7&title=&width=741.5)
+开启日志打印
+```objectivec
+#import <QTCommon/UMConfigure.h>
+#import <UMCommonLog/UMCommonLogHeaders.h>
+
+- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
+{
+  ...
+  [UMCommonLogManager setUpUMCommonLogManager];
+  [QTConfigure setLogEnabled:YES];
+  ...
+  return YES;
+}
+```
+### 埋点验证配置
+添加您的 URL Scheme 到项目中，URL Scheme 位于项目设置 target -> 选项卡 Info - > URL Types。
+填入的scheme：atm.yourappkey。
+![image.png](https://intranetproxy.alipay.com/skylark/lark/0/2022/png/281773/1668518096477-d9471acb-e7d0-4bba-8590-15891559b6b6.png#clientId=uf686b11a-7b20-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=412&id=ub7bbb0cc&margin=%5Bobject%20Object%5D&name=image.png&originHeight=823&originWidth=1366&originalType=binary&ratio=1&rotation=0&showTitle=false&size=127257&status=done&style=none&taskId=u9c88f1a5-85f6-4db1-a079-1dbef87724e&title=&width=683)
+在AppDelegate中调用函数[QTMobClick handleUrl:url]来接收 URL
+```objectivec
+- (BOOL)application:(UIApplication *)application openURL:(nonnull NSURL *)url options:(nonnull NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options
+{
+    if ([QTMobClick handleUrl:url]) {
+        return YES;
+    }
+    return YES;
+}
 
+```
+# 埋点API
+## SDK初始化
+### 预初始化
+SDK预初始化函数不会采集设备信息，也不会向QT后台上报数据。
 
+preInit预初始化函数耗时极少，不会影响App首次冷启动用户体验。
+
+注意：该函数仅在Android环境调用，需要手动判断 Platform.OS === 'android'
+```typescript
+function preInit(appKey: string): void
+```
+| 参数 | 含义 |
+| --- | --- |
+| appKey | QT后台提供的唯一应用key值 |
+
+### 正式初始化
+务必调用，请务必在用户同意隐私政策后，再初始化SDK。
+```typescript
+function init(appKey: string): void
+```
+| 参数 | 含义 |
+| --- | --- |
+| appKey | QT后台提供的唯一应用key值 |
+
+
+### 示例
+```typescript
+const initSDK = () => {
+  if (Platform.OS === 'android') {
+      QT.preInit('appkey', 'quicktracking');
+  }
+  QT.init('appkey', 'quicktracking');
+};
+```
 
 
-# 埋点
 ## 用户账号上报
 ### 用户登录
 该值的上传对应产品中“登录用户”：计算“登录用户”数，就是计算下述API上传值的去重数
 ```typescript
-function profileSignIn(ID: string, provider?: string) {}
+function profileSignIn(ID: string, provider?: string): void
 ```
 | 参数 | 含义 |
 | --- | --- |
@@ -175,24 +276,19 @@ function profileSignIn(ID: string, provider?: string) {}
 ### 用户登出
 账号登出时需调用此接口，调用之后不再发送账号相关内容。
 ```typescript
-function profileSignOff(ID: string, provider?: string)
+function profileSignOff(): void
 ```
 
 示例：
 ```typescript
-  const profileSignIn = () => {
-    QT.profileSignIn('用户ID');
-  };
-
-  const profileSignOff = () => {
-    QT.profileSignOff();
-  };
+QT.profileSignIn('用户ID');
+QT.profileSignOff();
 ```
 
 ## 用户属性上传
 使用事件编码固定为"$$_user_profile"的自定义事件上传，该事件所携带的事件属性会被作为用户属性放在用户表中。
 ```typescript
-function sendEvent(eventId: string, params: any)
+function sendEvent(eventId: string, params: any): void
 ```
 | 参数 | 含义 |
 | --- | --- |
@@ -216,31 +312,34 @@ QT.sendEvent("$$_user_profile", user);
 全局属性为每一个事件都会携带的属性
 ### 注册全局属性
 ```java
-function registerGlobalProperty(globalProperty: any) {}
+function registerGlobalProperty(globalProperty: any): void
 ```
 | 参数 | 含义 |
 | --- | --- |
-| globalProperty | 要注册的全局属性，定义为“属性名:属性值”的“<键-值>”对 |
+| globalProperty | 要注册的全局属性，定义为“属性名:属性值”的“<键-值>”对。为单层对象结构，不支持多层嵌套。 |
 
 **注意：**
 
 1. 属性名、string类型的属性值，只支持大小写字母、数字及下划线。
-2. 在Android中，不支持JavaScript的boolean类型，需要手动在JS中转为0、1。
+2. 在Android中，属性值不支持JavaScript的boolean类型，需要手动在JS中转为0、1。
 3. 在Android中，对于全局属性值为null或undefined的场景，底层Android sdk会过滤这个全局属性字段，如需要空值分析场景，需自定义默认空值
 4. 在iOS中，全局属性值不支持null和undefined，需要手动过滤。
 
 示例：
 ```typescript
 QT.registerGlobalProperty({
-      name: 'MyApp',
-      description: 'this is a app',
-	 }
-);
+    name: 'MyApp',
+    description: 'this is a app',
+    aBoolean: 1, //boolean类型需传为0或1,
+    aNull: '', //null或undefined类型需传空字符串
+    //默认为number类型，对于返回值为null或undefined场景，需业务自定义数值型默认空值
+    aNumber: 66,
+});
 ```
 
 ### 删除特定的全局属性
 ```java
-function unRegisterGlobalProperty(propertyName: string) {}
+function unregisterGlobalProperty(propertyName: string): void
 ```
 | 参数 | 含义 |
 | --- | --- |
@@ -253,7 +352,7 @@ function unRegisterGlobalProperty(propertyName: string) {}
 
 ### 获取特定的全局属性
 ```java
-function getGlobalProperty(propertyName: string) {}
+ async function getGlobalProperty(propertyName: string): Promise<any>
 ```
 | 参数 | 含义 |
 | --- | --- |
@@ -261,12 +360,23 @@ function getGlobalProperty(propertyName: string) {}
 
 示例：
 ```typescript
- QT.getGlobalProperty('name'); // 获取全局属性name，返回 {name: "MyApp"}
+ await QT.getGlobalProperty('name'); // 获取全局属性name，返回 {name: "MyApp"}
 ```
 
+### 获取所有全局属性
+```java
+ async function getGlobalProperties(propertyName: string): Promise<any>
+```
+
+示例：
+```typescript
+ await QT.getGlobalProperties(); // 获取所有全局属性
+```
+
+
 ### 清除所有全局属性
 ```java
-function clearGlobalProperties() {}
+function clearGlobalProperties(): void
 ```
 示例：
 ```tsx
@@ -277,8 +387,8 @@ QT.clearGlobalProperties(); // 所有全局属性都被清除（慎用）
 ## 页面浏览事件埋点
 开发者如果希望对页面路径和页面停留时长进行采集和统计。可以通过调用该接口手动埋点
 ```typescript
-function onPageStart(pageName: string) {}
-function onPageEnd(pageName: string) {}
+function onPageStart(pageName: string): void
+function onPageEnd(pageName: string): void
 ```
 | 参数 | 含义 |
 | --- | --- |
@@ -286,12 +396,8 @@ function onPageEnd(pageName: string) {}
 
 示例：
 ```typescript
-  const onPageStart = () => {
-    QT.onPageStart('MainPage');
-  };
-  const onPageEnd = () => {
-    QT.onPageEnd('MainPage');
-  };
+QT.onPageStart('MainPage');
+QT.onPageEnd('MainPage');
 ```
 注意：
 onPageStart 和 onPageEnd 必须成对调用。
@@ -305,21 +411,19 @@ onPageStart 和 onPageEnd 必须成对调用。
    * @param eventId 当前统计的事件ID
    * @param params 对当前事件的参数描述，定义为“参数名:参数值”的“<键-值>”对
    */
-  function sendEvent(eventId: string, params: any) {}
+  function sendEvent(eventId: string, params: any): void
 ```
 | 参数 | 含义 |
 | --- | --- |
 | eventId | 为当前统计的事件ID。 |
-| params | 对当前事件的参数描述，定义为“参数名:参数值”的“<键-值>对”。 |
+| params | 对当前事件的参数描述，定义为“参数名:参数值”的“<键-值>对”。为单层对象结构，不支持多层嵌套。 |
 
 **示例：**
 ```typescript
-const sendEvent = () => {
-  QT.sendEvent('my_event', {
-    name: 'app_name',
-    options: 'xxx',
-  });
-};
+QT.sendEvent('my_event', {
+  name: 'app_name',
+  options: 'xxx',
+});
 ```
 > **_备注：_**
 > - 多参数类型事件能满足原来计算事件/计数事件的分析场景；
@@ -334,19 +438,116 @@ const sendEvent = () => {
 2. 在Android中，对于全局属性值为null或undefined的场景，底层Android sdk会过滤这个全局属性字段，如需要空值分析场景，需自定义默认空值
 3. 在iOS中，全局属性值不支持null和undefined，需要手动过滤。
 
-## RN App中嵌入h5页面
-集成：
-桥接：
+## 桥接事件埋点
+桥接事件用于h5桥接RN的场景，使用此接口将H5日志发送至App中。
+```typescript
+
+  /**
+   * 桥接事件埋点
+   * @param data H5转发事件的日志体
+   */
+  function sendEventForH5(data: string): void
+```
+| 参数 | 含义 |
+| --- | --- |
+| data | H5转发事件的日志体 |
+
+**示例：**
+```typescript
+const content = data.nativeEvent.data;
+QT.sendEventForH5(content);
+```
 
+# RN App中嵌入h5页面（RN桥接模式）
+## H5集成 QuickTracking Web SDK
+该步骤请参考[QuickTrackingWeb SDK集成手册](https://help.aliyun.com/document_detail/428531.html)
+## 转发H5端发送的日志给React Native WebView
+```javascript
+<script charset="UTF-8">
+  ...
+  // sdk接入及配置部分
+  ...
+
+  //转发页面自定义事件（点击、元素曝光、其他）
+  aplus_queue.push({
+    action: 'aplus.aplus_pubsub.subscribe',
+    arguments: ['mw_change_hjlj', function (content) {
+      var eventData = content && content.what_to_send && content.what_to_send.hjljdataToUmNative;
+      if (/*iOS环境*/) {
+        window.ReactNativeWebView.postMessage(JSON.stringify(eventData), '*');
+      } else {
+        window.ReactNativeWebView.postMessage(JSON.stringify(eventData));
+      }
+    }]
+  })
+
+  aplus_queue.push({
+    action: 'aplus.aplus_pubsub.subscribe',
+    arguments: ['mw_change_pv', function (content) {
+      var pvData = content && content.what_to_send && content.what_to_send.pvdataToUmNative;
+      if (/*iOS环境*/) {
+        window.ReactNativeWebView.postMessage(JSON.stringify(pvData), '*');
+      } else {
+        window.ReactNativeWebView.postMessage(JSON.stringify(pvData));
+      }
+    }]
+  })
+</script>
+```
+## React Native WebView接收消息并调用QT SDK上报日志
+```javascript
+import * as React from 'react'
+import { WebView } from 'react-native-webview';
+import { QT } from 'react-native-quicktracking-analytics-module';
+import { Platform, SafeAreaView } from 'react-native';
+
+export default function WebPage() {
+  const onMessage = (data) => {
+    try {
+      const content = data.nativeEvent.data;
+      QT.sendEventForH5(content);
+    } catch (error) {
+      console.log('webview message error:', error);
+    }
+  };
+	...
+  return (
+    <SafeAreaView style={{ flex: 1 }}>
+    	<WebView
+      	...
+        onMessage={onMessage}
+      	...
+      />
+  	</SafeAreaView>
+	);
+}
+```
 # FAQ
-### 控制台提示[APLUS] -- jsbridge Android environment error, Umeng4Aplus =  undefined
+## Umeng4Plus为空
+控制台提示[APLUS] -- jsbridge Android environment error, Umeng4Aplus =  undefined
 Umeng4Plus是桥接的环境变量，若提示undefined，说明在原生端未接入桥接功能，请找负责Android或iOS的同学对接。
+## ruby版本过低
+进入项目时提示，Required ruby-2.7.5 is not installed. To install do: 'rvm install "ruby-2.7.5"'
+注意您的ruby版本，MacOS自带的Ruby为2.6.8，不符合RN项目需求。
+建议在本地终端中执行 ruby --version
+下载ruby包管理器，如rbenv或rvm等，改成ruby版本为RN需要的[版本](https://github.com/facebook/react-native/blob/main/template/_ruby-version)
+```shell
+rvm install 2.7.5
+rvm use 2.7.5
+```
+
+
+## 嵌入的html可以收发数，但Android端不能
+查看Android Manifest里有没有配置网络权限。
+# 参考
+> [QuickTracking Android SDK集成手册](https://help.aliyun.com/document_detail/260238.html)
+> [QuickTracking iOS SDK集成手册](https://help.aliyun.com/document_detail/260233.html)
+> [React Native Android 本地模块](https://reactnative.dev/docs/native-modules-android)
+> [React Native iOS 本地模块](https://reactnative.dev/docs/native-modules-ios)
+
+
 
 
-## 详细文档请参考
-1. [Quicktracking iOS 集成文档](https://help.aliyun.com/document_detail/260230.html)
-2. [Quicktracking Android 集成文档](https://help.aliyun.com/document_detail/260235.html)
-3. [QuickTracking H5 集成文档](https://help.aliyun.com/document_detail/252737.html)
 
 
 

package/android/src/main/java/com/reactnativequicktrackinganalyticsmodule/QuicktrackingAnalyticsModuleModule.java

@@ -23,6 +23,7 @@ import com.facebook.react.bridge.ReadableType;
 import com.facebook.react.module.annotations.ReactModule;
 
 import com.quick.qt.analytics.QtTrackAgent;
+import com.quick.qt.commonsdk.QtConfigure;
 import com.quick.qt.spm.SpmAgent;
 
 @ReactModule(name = QuicktrackingAnalyticsModuleModule.NAME)
@@ -54,6 +55,10 @@ public class QuicktrackingAnalyticsModuleModule extends ReactContextBaseJavaModu
       QtTrackAgent.onPageEnd(pageName);
     }
 
+    @ReactMethod
+    public void onEvent(String eventID) {
+      QtTrackAgent.onEvent(context, eventID);
+    }
 
     @ReactMethod
     public void onEventObject(String eventID, ReadableMap property) {
@@ -157,4 +162,18 @@ public class QuicktrackingAnalyticsModuleModule extends ReactContextBaseJavaModu
     public void profileSignOff() {
       QtTrackAgent.onProfileSignOff();
     }
+
+    // SDK预初始化函数不会采集设备信息，也不会向QT后台上报数据。
+    // preInit预初始化函数耗时极少，不会影响App首次冷启动用户体验
+    @ReactMethod
+    public void preInit(String AppKey, String Channel) {
+        QtConfigure.preInit(context, AppKey, Channel);
+    }
+
+    // 请务必在用户同意隐私政策后，再初始化SDK
+    // 正式初始化SDK，务必调用
+    @ReactMethod
+    public void initWithAppkey(String AppKey, String Channel) {
+        QtConfigure.init(context, AppKey, Channel, QtConfigure.DEVICE_TYPE_PHONE, "");
+    }
 }

package/ios/QuicktrackingAnalyticsModule.m

@@ -1,5 +1,7 @@
 //#if __has_include(<QTCommon/MobClick.h>)
 #import <QTCommon/MobClick.h>
+#import <QTCommon/UMConfigure.h>
+
 //#else
 //#import "MobClick.h"
 //#endif
@@ -70,7 +72,7 @@ RCT_EXPORT_METHOD(onEventWithParamsAndCount:(NSString *)eventId parameters:(NSDi
 }
 
 RCT_EXPORT_METHOD(onEventForH5:(NSString*)eventId attributes:(NSDictionary *)attributes) {
-    
+
   Class _MobClickEvent = NSClassFromString(@"QTMobClickEvent");
     if (_MobClickEvent){
         SEL sel = NSSelectorFromString(@"eventForH5:attributes:");
@@ -126,6 +128,16 @@ RCT_EXPORT_METHOD(getGlobalProperties:(RCTPromiseResolveBlock)resolve reject:(RC
     }
 }
 
+// RCT_EXPORT_METHOD(preInit:(NSString*)appKey)
+// {
+//     [QTMobClick preInit:appKey];
+// }
+
+RCT_EXPORT_METHOD(initWithAppkey:(NSString *)appKey channel:(NSString *)channel)
+{
+    [QTConfigure initWithAppkey:appKey channel:channel];
+}
+
 //======================================用户账号和用户属性相关===========================================//
 RCT_EXPORT_METHOD(profileSignIn:(NSString*)puid provider:(NSString*)provider)
 {

package/ios/QuicktrackingAnalyticsModule.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>IDEDidComputeMac32BitWarning</key>
+	<true/>
+</dict>
+</plist>

package/lib/commonjs/index.js

@@ -78,13 +78,22 @@ class QT {
   /**
    * 注册一个全局事件属性
    * @param property 要注册的全局属性
-   * @description 注册全局属性后，后续触发的所有事件都将自动包含这些属性；
-   * 且这些属性及属性值存入缓存，APP退出后清除。
-   * 在分析数据时，可根据此属性进行查看和筛选。
+   * @description
+   ** 注册全局属性后，后续触发的所有事件都将自动包含这些属性；
+   ** 且这些属性及属性值存入缓存，APP退出后清除。
+   ** 在分析数据时，可根据此属性进行查看和筛选。
    */
   static registerGlobalProperty(gp) {
     if (_reactNative.Platform.OS === 'ios') {
-      QuicktrackingAnalyticsModule.registerGlobalProperty(gp);
+      Object.keys(gp).forEach((_propertyName, propertyValue) => {
+        if (!propertyValue && propertyValue !== 0) {
+          console.warn('属性值不能为null或undefined');
+        } else if (typeof propertyValue === 'object') {
+          console.warn('全局属性只能是单层对象');
+        } else {
+          QuicktrackingAnalyticsModule.registerGlobalProperty(gp);
+        }
+      });
     } else {
       QuicktrackingAnalyticsModule.registerGlobalProperties(gp);
     }
@@ -164,58 +173,29 @@ class QT {
   static profileSignOff() {
     QuicktrackingAnalyticsModule.profileSignOff();
   }
-  // /**
-  //  * 自定义事件埋点
-  //  * @param eventId 当前统计的事件ID
-  //  * @param eventLabel 分类标签
-  //  */
-  // static sendEventLabel(eventId: string, eventLabel: string) {
-  //   return QuicktrackingAnalyticsModule.sendEventLabel(eventId, eventLabel);
-  // }
-
-  // /**
-  //  * 自定义事件埋点
-  //  * @param eventId 当前统计的事件ID
-  //  * @param eventData 为当前事件的属性和取值（键值对），不能为空，如：{name:"Jack",gender:"man"}
-  //  */
-  // static sendEventMap(eventId: string, eventData: Object) {
-  //   return QuicktrackingAnalyticsModule.sendEventMap(eventId, eventData);
-  // }
 
-  // /**
-  //  * 自定义事件埋点
-  //  * @param eventId 当前统计的事件ID
-  //  * @param eventData 为当前事件的属性和取值（键值对），不能为空，如：{name:"Jack",gender:"man"}
-  //  * @param eventNum 用户每次触发的数值的分布情况，如事件持续时间、每次付款金额等
-  //  */
-  // static sendEventMapAndCount(
-  //   eventId: string,
-  //   eventData: Object,
-  //   eventNum: number
-  // ) {
-  //   return QuicktrackingAnalyticsModule.sendEventMapAndCount(
-  //     eventId,
-  //     eventData,
-  //     eventNum
-  //   );
-  // }
-
-  // /**
-  //  * 自定义事件埋点
-  //  * @param eventId 当前统计的事件ID
-  //  * @param eventData 为当前事件的属性和取值（键值对），不能为空，值可以是对象
-  //  */
-  // static sendEventObject(eventId: string, eventData: Object) {
-  //   return QuicktrackingAnalyticsModule.sendEventObject(eventId, eventData);
-  // }
+  /**
+   * SDK预初始化，仅Android调用
+   * @param appKey QuickTracking后台提供的唯一key值，请勿泄露给第三方
+   * @param channel 下载渠道
+   * @description
+   ** SDK预初始化函数不会采集设备信息，也不会向QT后台上报数据。
+   ** preInit预初始化函数耗时极少，不会影响App首次冷启动用户体验。
+   ** 需要在RN中判断 Platform.OS === 'android'，再调用此接口
+   */
+  static preInit(appKey, channel) {
+    QuicktrackingAnalyticsModule.preInit(appKey, channel);
+  }
 
-  // /**
-  //  * 设置关注事件是否触发
-  //  * @param eventList 事件list
-  //  */
-  // static setFirstLaunchEvent<T>(eventList: Array<T>) {
-  //   return QuicktrackingAnalyticsModule.setFirstLaunchEvent(eventList);
-  // }
+  /**
+   * SDK正式初始化
+   * @param appKey QuickTracking后台提供的唯一key值，请勿泄露给第三方
+   * @param channel 下载渠道
+   * @description 请务必在用户同意隐私政策后，再初始化SDK，务必调用。
+   */
+  static init(appKey, channel) {
+    QuicktrackingAnalyticsModule.initWithAppkey(appKey, channel);
+  }
 }
 exports.QT = QT;
 //# sourceMappingURL=index.js.map

package/lib/module/index.js

@@ -72,13 +72,22 @@ export class QT {
   /**
    * 注册一个全局事件属性
    * @param property 要注册的全局属性
-   * @description 注册全局属性后，后续触发的所有事件都将自动包含这些属性；
-   * 且这些属性及属性值存入缓存，APP退出后清除。
-   * 在分析数据时，可根据此属性进行查看和筛选。
+   * @description
+   ** 注册全局属性后，后续触发的所有事件都将自动包含这些属性；
+   ** 且这些属性及属性值存入缓存，APP退出后清除。
+   ** 在分析数据时，可根据此属性进行查看和筛选。
    */
   static registerGlobalProperty(gp) {
     if (Platform.OS === 'ios') {
-      QuicktrackingAnalyticsModule.registerGlobalProperty(gp);
+      Object.keys(gp).forEach((_propertyName, propertyValue) => {
+        if (!propertyValue && propertyValue !== 0) {
+          console.warn('属性值不能为null或undefined');
+        } else if (typeof propertyValue === 'object') {
+          console.warn('全局属性只能是单层对象');
+        } else {
+          QuicktrackingAnalyticsModule.registerGlobalProperty(gp);
+        }
+      });
     } else {
       QuicktrackingAnalyticsModule.registerGlobalProperties(gp);
     }
@@ -158,57 +167,28 @@ export class QT {
   static profileSignOff() {
     QuicktrackingAnalyticsModule.profileSignOff();
   }
-  // /**
-  //  * 自定义事件埋点
-  //  * @param eventId 当前统计的事件ID
-  //  * @param eventLabel 分类标签
-  //  */
-  // static sendEventLabel(eventId: string, eventLabel: string) {
-  //   return QuicktrackingAnalyticsModule.sendEventLabel(eventId, eventLabel);
-  // }
-
-  // /**
-  //  * 自定义事件埋点
-  //  * @param eventId 当前统计的事件ID
-  //  * @param eventData 为当前事件的属性和取值（键值对），不能为空，如：{name:"Jack",gender:"man"}
-  //  */
-  // static sendEventMap(eventId: string, eventData: Object) {
-  //   return QuicktrackingAnalyticsModule.sendEventMap(eventId, eventData);
-  // }
 
-  // /**
-  //  * 自定义事件埋点
-  //  * @param eventId 当前统计的事件ID
-  //  * @param eventData 为当前事件的属性和取值（键值对），不能为空，如：{name:"Jack",gender:"man"}
-  //  * @param eventNum 用户每次触发的数值的分布情况，如事件持续时间、每次付款金额等
-  //  */
-  // static sendEventMapAndCount(
-  //   eventId: string,
-  //   eventData: Object,
-  //   eventNum: number
-  // ) {
-  //   return QuicktrackingAnalyticsModule.sendEventMapAndCount(
-  //     eventId,
-  //     eventData,
-  //     eventNum
-  //   );
-  // }
-
-  // /**
-  //  * 自定义事件埋点
-  //  * @param eventId 当前统计的事件ID
-  //  * @param eventData 为当前事件的属性和取值（键值对），不能为空，值可以是对象
-  //  */
-  // static sendEventObject(eventId: string, eventData: Object) {
-  //   return QuicktrackingAnalyticsModule.sendEventObject(eventId, eventData);
-  // }
+  /**
+   * SDK预初始化，仅Android调用
+   * @param appKey QuickTracking后台提供的唯一key值，请勿泄露给第三方
+   * @param channel 下载渠道
+   * @description
+   ** SDK预初始化函数不会采集设备信息，也不会向QT后台上报数据。
+   ** preInit预初始化函数耗时极少，不会影响App首次冷启动用户体验。
+   ** 需要在RN中判断 Platform.OS === 'android'，再调用此接口
+   */
+  static preInit(appKey, channel) {
+    QuicktrackingAnalyticsModule.preInit(appKey, channel);
+  }
 
-  // /**
-  //  * 设置关注事件是否触发
-  //  * @param eventList 事件list
-  //  */
-  // static setFirstLaunchEvent<T>(eventList: Array<T>) {
-  //   return QuicktrackingAnalyticsModule.setFirstLaunchEvent(eventList);
-  // }
+  /**
+   * SDK正式初始化
+   * @param appKey QuickTracking后台提供的唯一key值，请勿泄露给第三方
+   * @param channel 下载渠道
+   * @description 请务必在用户同意隐私政策后，再初始化SDK，务必调用。
+   */
+  static init(appKey, channel) {
+    QuicktrackingAnalyticsModule.initWithAppkey(appKey, channel);
+  }
 }
 //# sourceMappingURL=index.js.map

package/lib/typescript/index.d.ts

@@ -1,3 +1,5 @@
+declare type GlobalProperty = Record<string, string | number>;
+declare type EventParams = Record<string, string | number>;
 /**
  *引入 QuickTracking SDK
  */
@@ -17,7 +19,7 @@ export declare class QT {
      * @param eventId 当前统计的事件ID
      * @param params 对当前事件的参数描述，定义为“参数名:参数值”的“<键-值>”对
      */
-    static sendEvent(eventId: string, params: any): void;
+    static sendEvent(eventId: string, params?: EventParams): void;
     /**
      * 桥接事件埋点
      * @param data H5转发事件的日志体
@@ -26,11 +28,12 @@ export declare class QT {
     /**
      * 注册一个全局事件属性
      * @param property 要注册的全局属性
-     * @description 注册全局属性后，后续触发的所有事件都将自动包含这些属性；
-     * 且这些属性及属性值存入缓存，APP退出后清除。
-     * 在分析数据时，可根据此属性进行查看和筛选。
+     * @description
+     ** 注册全局属性后，后续触发的所有事件都将自动包含这些属性；
+     ** 且这些属性及属性值存入缓存，APP退出后清除。
+     ** 在分析数据时，可根据此属性进行查看和筛选。
      */
-    static registerGlobalProperty(gp: any): void;
+    static registerGlobalProperty(gp: GlobalProperty): void;
     /**
      * 删除一个全局事件属性
      * @param propertyName 要删除的全局事件属性名，只支持大小写字母、数字及下划线
@@ -59,4 +62,22 @@ export declare class QT {
      * 账号登出时需调用此接口，调用之后不再发送账号相关内容。
      */
     static profileSignOff(): void;
+    /**
+     * SDK预初始化，仅Android调用
+     * @param appKey QuickTracking后台提供的唯一key值，请勿泄露给第三方
+     * @param channel 下载渠道
+     * @description
+     ** SDK预初始化函数不会采集设备信息，也不会向QT后台上报数据。
+     ** preInit预初始化函数耗时极少，不会影响App首次冷启动用户体验。
+     ** 需要在RN中判断 Platform.OS === 'android'，再调用此接口
+     */
+    static preInit(appKey: string, channel: string): void;
+    /**
+     * SDK正式初始化
+     * @param appKey QuickTracking后台提供的唯一key值，请勿泄露给第三方
+     * @param channel 下载渠道
+     * @description 请务必在用户同意隐私政策后，再初始化SDK，务必调用。
+     */
+    static init(appKey: string, channel: string): void;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-quicktracking-analytics-module",
-  "version": "1.0.0-beta.3",
+  "version": "1.0.1",
   "description": "QuickTracking ReactNative SDK",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

package/src/index.tsx

@@ -1,5 +1,9 @@
 import { NativeModules, Platform } from 'react-native';
 const QuicktrackingAnalyticsModule = NativeModules.QuicktrackingAnalyticsModule;
+
+type GlobalProperty = Record<string, string | number>;
+type EventParams = Record<string, string | number>;
+
 /**
  *引入 QuickTracking SDK
  */
@@ -25,7 +29,7 @@ export class QT {
    * @param eventId 当前统计的事件ID
    * @param params 对当前事件的参数描述，定义为“参数名:参数值”的“<键-值>”对
    */
-  static sendEvent(eventId: string, params: any) {
+  static sendEvent(eventId: string, params?: EventParams) {
     if (params) {
       QuicktrackingAnalyticsModule.onEventObject(eventId, params);
     } else {
@@ -76,13 +80,22 @@ export class QT {
   /**
    * 注册一个全局事件属性
    * @param property 要注册的全局属性
-   * @description 注册全局属性后，后续触发的所有事件都将自动包含这些属性；
-   * 且这些属性及属性值存入缓存，APP退出后清除。
-   * 在分析数据时，可根据此属性进行查看和筛选。
+   * @description
+   ** 注册全局属性后，后续触发的所有事件都将自动包含这些属性；
+   ** 且这些属性及属性值存入缓存，APP退出后清除。
+   ** 在分析数据时，可根据此属性进行查看和筛选。
    */
-  static registerGlobalProperty(gp: any) {
+  static registerGlobalProperty(gp: GlobalProperty) {
     if (Platform.OS === 'ios') {
-      QuicktrackingAnalyticsModule.registerGlobalProperty(gp);
+      Object.keys(gp).forEach((_propertyName, propertyValue) => {
+        if (!propertyValue && propertyValue !== 0) {
+          console.warn('属性值不能为null或undefined');
+        } else if (typeof propertyValue === 'object') {
+          console.warn('全局属性只能是单层对象');
+        } else {
+          QuicktrackingAnalyticsModule.registerGlobalProperty(gp);
+        }
+      });
     } else {
       QuicktrackingAnalyticsModule.registerGlobalProperties(gp);
     }
@@ -162,56 +175,27 @@ export class QT {
   static profileSignOff() {
     QuicktrackingAnalyticsModule.profileSignOff();
   }
-  // /**
-  //  * 自定义事件埋点
-  //  * @param eventId 当前统计的事件ID
-  //  * @param eventLabel 分类标签
-  //  */
-  // static sendEventLabel(eventId: string, eventLabel: string) {
-  //   return QuicktrackingAnalyticsModule.sendEventLabel(eventId, eventLabel);
-  // }
-
-  // /**
-  //  * 自定义事件埋点
-  //  * @param eventId 当前统计的事件ID
-  //  * @param eventData 为当前事件的属性和取值（键值对），不能为空，如：{name:"Jack",gender:"man"}
-  //  */
-  // static sendEventMap(eventId: string, eventData: Object) {
-  //   return QuicktrackingAnalyticsModule.sendEventMap(eventId, eventData);
-  // }
-
-  // /**
-  //  * 自定义事件埋点
-  //  * @param eventId 当前统计的事件ID
-  //  * @param eventData 为当前事件的属性和取值（键值对），不能为空，如：{name:"Jack",gender:"man"}
-  //  * @param eventNum 用户每次触发的数值的分布情况，如事件持续时间、每次付款金额等
-  //  */
-  // static sendEventMapAndCount(
-  //   eventId: string,
-  //   eventData: Object,
-  //   eventNum: number
-  // ) {
-  //   return QuicktrackingAnalyticsModule.sendEventMapAndCount(
-  //     eventId,
-  //     eventData,
-  //     eventNum
-  //   );
-  // }
 
-  // /**
-  //  * 自定义事件埋点
-  //  * @param eventId 当前统计的事件ID
-  //  * @param eventData 为当前事件的属性和取值（键值对），不能为空，值可以是对象
-  //  */
-  // static sendEventObject(eventId: string, eventData: Object) {
-  //   return QuicktrackingAnalyticsModule.sendEventObject(eventId, eventData);
-  // }
+  /**
+   * SDK预初始化，仅Android调用
+   * @param appKey QuickTracking后台提供的唯一key值，请勿泄露给第三方
+   * @param channel 下载渠道
+   * @description
+   ** SDK预初始化函数不会采集设备信息，也不会向QT后台上报数据。
+   ** preInit预初始化函数耗时极少，不会影响App首次冷启动用户体验。
+   ** 需要在RN中判断 Platform.OS === 'android'，再调用此接口
+   */
+  static preInit(appKey: string, channel: string) {
+    QuicktrackingAnalyticsModule.preInit(appKey, channel);
+  }
 
-  // /**
-  //  * 设置关注事件是否触发
-  //  * @param eventList 事件list
-  //  */
-  // static setFirstLaunchEvent<T>(eventList: Array<T>) {
-  //   return QuicktrackingAnalyticsModule.setFirstLaunchEvent(eventList);
-  // }
+  /**
+   * SDK正式初始化
+   * @param appKey QuickTracking后台提供的唯一key值，请勿泄露给第三方
+   * @param channel 下载渠道
+   * @description 请务必在用户同意隐私政策后，再初始化SDK，务必调用。
+   */
+  static init(appKey: string, channel: string) {
+    QuicktrackingAnalyticsModule.initWithAppkey(appKey, channel);
+  }
 }