react-native-quicktracking-analytics-module 1.0.0 → 1.0.1

package/README.md

@@ -225,6 +225,41 @@ Podfile示例
 
 ```
 # 埋点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上传值的去重数
@@ -491,7 +526,6 @@ export default function WebPage() {
 ## 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项目需求。
@@ -505,19 +539,18 @@ 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)
 
 
 
 
+
+
+
 ## License
 
 MIT

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,9 +78,10 @@ class QT {
   /**
    * 注册一个全局事件属性
    * @param property 要注册的全局属性
-   * @description 注册全局属性后，后续触发的所有事件都将自动包含这些属性；
-   * 且这些属性及属性值存入缓存，APP退出后清除。
-   * 在分析数据时，可根据此属性进行查看和筛选。
+   * @description
+   ** 注册全局属性后，后续触发的所有事件都将自动包含这些属性；
+   ** 且这些属性及属性值存入缓存，APP退出后清除。
+   ** 在分析数据时，可根据此属性进行查看和筛选。
    */
   static registerGlobalProperty(gp) {
     if (_reactNative.Platform.OS === 'ios') {
@@ -172,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,9 +72,10 @@ export class QT {
   /**
    * 注册一个全局事件属性
    * @param property 要注册的全局属性
-   * @description 注册全局属性后，后续触发的所有事件都将自动包含这些属性；
-   * 且这些属性及属性值存入缓存，APP退出后清除。
-   * 在分析数据时，可根据此属性进行查看和筛选。
+   * @description
+   ** 注册全局属性后，后续触发的所有事件都将自动包含这些属性；
+   ** 且这些属性及属性值存入缓存，APP退出后清除。
+   ** 在分析数据时，可根据此属性进行查看和筛选。
    */
   static registerGlobalProperty(gp) {
     if (Platform.OS === 'ios') {
@@ -166,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

@@ -19,7 +19,7 @@ export declare class QT {
      * @param eventId 当前统计的事件ID
      * @param params 对当前事件的参数描述，定义为“参数名:参数值”的“<键-值>”对
      */
-    static sendEvent(eventId: string, params: EventParams): void;
+    static sendEvent(eventId: string, params?: EventParams): void;
     /**
      * 桥接事件埋点
      * @param data H5转发事件的日志体
@@ -28,9 +28,10 @@ export declare class QT {
     /**
      * 注册一个全局事件属性
      * @param property 要注册的全局属性
-     * @description 注册全局属性后，后续触发的所有事件都将自动包含这些属性；
-     * 且这些属性及属性值存入缓存，APP退出后清除。
-     * 在分析数据时，可根据此属性进行查看和筛选。
+     * @description
+     ** 注册全局属性后，后续触发的所有事件都将自动包含这些属性；
+     ** 且这些属性及属性值存入缓存，APP退出后清除。
+     ** 在分析数据时，可根据此属性进行查看和筛选。
      */
     static registerGlobalProperty(gp: GlobalProperty): void;
     /**
@@ -61,5 +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",
+  "version": "1.0.1",
   "description": "QuickTracking ReactNative SDK",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

package/src/index.tsx

@@ -29,7 +29,7 @@ export class QT {
    * @param eventId 当前统计的事件ID
    * @param params 对当前事件的参数描述，定义为“参数名:参数值”的“<键-值>”对
    */
-  static sendEvent(eventId: string, params: EventParams) {
+  static sendEvent(eventId: string, params?: EventParams) {
     if (params) {
       QuicktrackingAnalyticsModule.onEventObject(eventId, params);
     } else {
@@ -80,9 +80,10 @@ export class QT {
   /**
    * 注册一个全局事件属性
    * @param property 要注册的全局属性
-   * @description 注册全局属性后，后续触发的所有事件都将自动包含这些属性；
-   * 且这些属性及属性值存入缓存，APP退出后清除。
-   * 在分析数据时，可根据此属性进行查看和筛选。
+   * @description
+   ** 注册全局属性后，后续触发的所有事件都将自动包含这些属性；
+   ** 且这些属性及属性值存入缓存，APP退出后清除。
+   ** 在分析数据时，可根据此属性进行查看和筛选。
    */
   static registerGlobalProperty(gp: GlobalProperty) {
     if (Platform.OS === 'ios') {
@@ -174,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);
+  }
 }