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

package/README.md

@@ -56,7 +56,7 @@ allprojects {
 dependencies {
   implementation fileTree(include:['*.jar'], dir:'libs')
 
-  implementation "com.umeng.umsdk:qt-px-common:1.3.8.PX"
+  implementation "com.umeng.umsdk:qt-px-common:1.3.9.PX"
 }
 ```
 
@@ -141,13 +141,6 @@ QtConfigure.setCustomDomain("收数域名", null);
 QtConfigure.preInit(this,"appkey","Channel");
 ```
 
-3. 初始化
-```java
-// 请务必在用户同意隐私政策后，再初始化SDK。
-// 正式初始化SDK，务必调用
-QtConfigure.init(this,"appkey","unknown",UMConfigure.DEVICE_TYPE_PHONE, "");
-```
-
 
 ## iOS 基座集成
 ### 使用CocoaPods集成
@@ -226,40 +219,20 @@ 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
+function init(appKey: string, channel: string): void
 ```
 | 参数 | 含义 |
 | --- | --- |
 | appKey | QT后台提供的唯一应用key值 |
-
+| channel | 下载渠道 |
 
 ### 示例
-```typescript
-const initSDK = () => {
-  if (Platform.OS === 'android') {
-      QT.preInit('appkey', 'quicktracking');
-  }
-  QT.init('appkey', 'quicktracking');
-};
+```tsx
+QT.init('appkey', 'quicktracking');
 ```
-
-
 ## 用户账号上报
 ### 用户登录
 该值的上传对应产品中“登录用户”：计算“登录用户”数，就是计算下述API上传值的去重数
@@ -279,7 +252,7 @@ function profileSignIn(ID: string, provider?: string): void
 function profileSignOff(): void
 ```
 
-示例：
+### 示例
 ```typescript
 QT.profileSignIn('用户ID');
 QT.profileSignOff();
@@ -292,7 +265,7 @@ function sendEvent(eventId: string, params: any): void
 ```
 | 参数 | 含义 |
 | --- | --- |
-| eventId | 当前统计的事件ID |
+| eventId | 当前统计的事件编码 |
 | params | 对当前事件的参数描述，定义为“参数名:参数值”的“<键-值>”对 |
 
 注：用户属性上传一定要在用户账号上报后。
@@ -303,7 +276,7 @@ QT.onProfileSignIn("张三");
 
 const user = {
 	gender: "male",
-    age: "8"
+  age: "8"
 }
 QT.sendEvent("$$_user_profile", user);
 ```
@@ -392,7 +365,7 @@ function onPageEnd(pageName: string): void
 ```
 | 参数 | 含义 |
 | --- | --- |
-| pageName | 自定义页面的名称 |
+| pageName | 页面编码 |
 
 示例：
 ```typescript
@@ -408,22 +381,38 @@ onPageStart 和 onPageEnd 必须成对调用。
 ```typescript
   /**
    * 自定义事件埋点
-   * @param eventId 当前统计的事件ID
+   * @param eventId 当前统计的事件编码
    * @param params 对当前事件的参数描述，定义为“参数名:参数值”的“<键-值>”对
+   * @param pageName 当前统计事件的页面编码
    */
-  function sendEvent(eventId: string, params: any): void
+  function sendEvent(eventId: string, params?: any, pageName?: string): void
 ```
 | 参数 | 含义 |
 | --- | --- |
-| eventId | 为当前统计的事件ID。 |
+| eventId | 为当前统计的事件编码。 |
 | params | 对当前事件的参数描述，定义为“参数名:参数值”的“<键-值>对”。为单层对象结构，不支持多层嵌套。 |
+| pageName | 当前统计事件的页面编码。 |
 
 **示例：**
 ```typescript
-QT.sendEvent('my_event', {
-  name: 'app_name',
-  options: 'xxx',
-});
+// 携带事件参数的自定义事件
+QT.sendEvent(
+  'event1',
+  {
+    name: 'quick tracking',
+    method: 'func',
+  },
+);
+
+// 携带事件参数和页面编码的自定义事件
+QT.sendEvent(
+  'event2',
+  {
+    name: 'quick tracking',
+    method: 'func',
+  },
+  'main_page'
+);
 ```
 > **_备注：_**
 > - 多参数类型事件能满足原来计算事件/计数事件的分析场景；
@@ -551,6 +540,9 @@ rvm use 2.7.5
 
 
 
+
+
+
 ## License
 
 MIT

package/android/build.gradle

@@ -134,7 +134,7 @@ dependencies {
 //  implementation fileTree(include:['*.jar'], dir:'libs')
   implementation "com.facebook.react:react-native:+"
   //友盟基础库
-  implementation "com.umeng.umsdk:qt-px-common:1.3.8.PX"
+  implementation "com.umeng.umsdk:qt-px-common:1.3.9.PX"
 }
 
 if (isNewArchitectureEnabled()) {

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

@@ -61,7 +61,12 @@ public class QuicktrackingAnalyticsModuleModule extends ReactContextBaseJavaModu
     }
 
     @ReactMethod
-    public void onEventObject(String eventID, ReadableMap property) {
+    public void onEventWithPageName(String eventID, String pageName) {
+      QtTrackAgent.onEvent(context, eventID, pageName);
+    }
+
+    @ReactMethod
+    public void onEventWithParams(String eventID, ReadableMap property) {
       Map<String, Object> map = new HashMap();
       ReadableMapKeySetIterator iterator = property.keySetIterator();
       while (iterator.hasNextKey()) {
@@ -81,6 +86,27 @@ public class QuicktrackingAnalyticsModuleModule extends ReactContextBaseJavaModu
       QtTrackAgent.onEventObject(context, eventID, map);
     }
 
+    @ReactMethod
+    public void onEventWithParamsAndPageName(String eventID, ReadableMap property, String pageName) {
+      Map<String, Object> map = new HashMap();
+      ReadableMapKeySetIterator iterator = property.keySetIterator();
+      while (iterator.hasNextKey()) {
+        String key = iterator.nextKey();
+        if (ReadableType.Array == property.getType(key)) {
+          map.put(key, property.getArray(key).toString());
+        } else if (ReadableType.Boolean == property.getType(key)) {
+          map.put(key, String.valueOf(property.getBoolean(key)));
+        } else if (ReadableType.Number == property.getType(key)) {
+          map.put(key, String.valueOf(property.getInt(key)));
+        } else if (ReadableType.String == property.getType(key)) {
+          map.put(key, property.getString(key));
+        } else if (ReadableType.Map == property.getType(key)) {
+          map.put(key, property.getMap(key).toString());
+        }
+      }
+      QtTrackAgent.onEventObject(context, eventID, map, pageName);
+    }
+
     @ReactMethod
     public void onEventForH5(String content) {
       try {
@@ -163,13 +189,6 @@ public class QuicktrackingAnalyticsModuleModule extends ReactContextBaseJavaModu
       QtTrackAgent.onProfileSignOff();
     }
 
-    // SDK预初始化函数不会采集设备信息，也不会向QT后台上报数据。
-    // preInit预初始化函数耗时极少，不会影响App首次冷启动用户体验
-    @ReactMethod
-    public void preInit(String AppKey, String Channel) {
-        QtConfigure.preInit(context, AppKey, Channel);
-    }
-
     // 请务必在用户同意隐私政策后，再初始化SDK
     // 正式初始化SDK，务必调用
     @ReactMethod

package/ios/QuicktrackingAnalyticsModule.m

@@ -40,7 +40,7 @@ RCT_EXPORT_METHOD(onPageEnd:(NSString *)pageName)
  * @eventId 自定义事件名(字符串类型)
  * @params 一级平铺自定义参数属性键值对，不支持嵌套，并且iOS端不支持值为 null 和 "" 类型的键
  */
-RCT_EXPORT_METHOD(onEventObject:(NSString*)eventId parameters:(NSDictionary*)parameters)
+RCT_EXPORT_METHOD(onEventWithParams:(NSString*)eventId parameters:(NSDictionary*)parameters)
 {
     if (eventId == nil || [eventId isKindOfClass:[NSNull class]]) {
         return;
@@ -51,6 +51,31 @@ RCT_EXPORT_METHOD(onEventObject:(NSString*)eventId parameters:(NSDictionary*)par
     [QTMobClick event:eventId attributes:parameters];
 }
 
+RCT_EXPORT_METHOD(onEvenWithPageName:(NSString*)eventId pageName:(NSString *)pageName)
+{
+    if (eventId == nil || [eventId isKindOfClass:[NSNull class]]) {
+        return;
+    }
+    if (pageName == nil || [pageName isKindOfClass:[NSNull class]]) {
+        return;
+    }
+    [QTMobClick event:eventId pageName:pageName];
+}
+
+RCT_EXPORT_METHOD(onEventWithParamsAndPageName:(NSString*)eventId pageName:(NSString *)pageName parameters:(NSDictionary*)parameters)
+{
+    if (eventId == nil || [eventId isKindOfClass:[NSNull class]]) {
+        return;
+    }
+    if (pageName == nil || [pageName isKindOfClass:[NSNull class]]) {
+        return;
+    }
+    if (parameters == nil && [parameters isKindOfClass:[NSNull class]]) {
+        parameters = nil;
+    }
+    [QTMobClick event:eventId pageName:pageName attributes:parameters];
+}
+
 RCT_EXPORT_METHOD(onEvent:(NSString *)eventId)
 {
   if (eventId == nil || [eventId isKindOfClass:[NSNull class]]) {

package/lib/commonjs/index.js

@@ -12,7 +12,7 @@ const QuicktrackingAnalyticsModule = _reactNative.NativeModules.QuicktrackingAna
 class QT {
   /**
    * 页面浏览事件埋点-打开页面
-   * @param pageName 页面名称
+   * @param pageName 页面编码
    */
   static onPageStart(pageName) {
     QuicktrackingAnalyticsModule.onPageStart(pageName);
@@ -20,7 +20,7 @@ class QT {
 
   /**
    * 页面浏览事件埋点-离开页面
-   * @param pageName 页面名称
+   * @param pageName 页面编码
    */
   static onPageEnd(pageName) {
     QuicktrackingAnalyticsModule.onPageEnd(pageName);
@@ -28,14 +28,23 @@ class QT {
 
   /**
    * 自定义事件埋点
-   * @param eventId 当前统计的事件ID
+   * @param eventId 当前统计的事件编码
    * @param params 对当前事件的参数描述，定义为“参数名:参数值”的“<键-值>”对
+   * @param pageName 当前统计事件的页面编码
    */
-  static sendEvent(eventId, params) {
+  static sendEvent(eventId, params, pageName) {
     if (params) {
-      QuicktrackingAnalyticsModule.onEventObject(eventId, params);
+      if (pageName) {
+        QuicktrackingAnalyticsModule.onEventWithParamsAndPageName(eventId, params, pageName);
+      } else {
+        QuicktrackingAnalyticsModule.onEventWithParams(eventId, params);
+      }
     } else {
-      QuicktrackingAnalyticsModule.onEvent(eventId);
+      if (pageName) {
+        QuicktrackingAnalyticsModule.onEventWithPageName(eventId, pageName);
+      } else {
+        QuicktrackingAnalyticsModule.onEvent(eventId);
+      }
     }
   }
 
@@ -174,19 +183,6 @@ class QT {
     QuicktrackingAnalyticsModule.profileSignOff();
   }
 
-  /**
-   * 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);
-  }
-
   /**
    * SDK正式初始化
    * @param appKey QuickTracking后台提供的唯一key值，请勿泄露给第三方

package/lib/module/index.js

@@ -6,7 +6,7 @@ const QuicktrackingAnalyticsModule = NativeModules.QuicktrackingAnalyticsModule;
 export class QT {
   /**
    * 页面浏览事件埋点-打开页面
-   * @param pageName 页面名称
+   * @param pageName 页面编码
    */
   static onPageStart(pageName) {
     QuicktrackingAnalyticsModule.onPageStart(pageName);
@@ -14,7 +14,7 @@ export class QT {
 
   /**
    * 页面浏览事件埋点-离开页面
-   * @param pageName 页面名称
+   * @param pageName 页面编码
    */
   static onPageEnd(pageName) {
     QuicktrackingAnalyticsModule.onPageEnd(pageName);
@@ -22,14 +22,23 @@ export class QT {
 
   /**
    * 自定义事件埋点
-   * @param eventId 当前统计的事件ID
+   * @param eventId 当前统计的事件编码
    * @param params 对当前事件的参数描述，定义为“参数名:参数值”的“<键-值>”对
+   * @param pageName 当前统计事件的页面编码
    */
-  static sendEvent(eventId, params) {
+  static sendEvent(eventId, params, pageName) {
     if (params) {
-      QuicktrackingAnalyticsModule.onEventObject(eventId, params);
+      if (pageName) {
+        QuicktrackingAnalyticsModule.onEventWithParamsAndPageName(eventId, params, pageName);
+      } else {
+        QuicktrackingAnalyticsModule.onEventWithParams(eventId, params);
+      }
     } else {
-      QuicktrackingAnalyticsModule.onEvent(eventId);
+      if (pageName) {
+        QuicktrackingAnalyticsModule.onEventWithPageName(eventId, pageName);
+      } else {
+        QuicktrackingAnalyticsModule.onEvent(eventId);
+      }
     }
   }
 
@@ -168,19 +177,6 @@ export class QT {
     QuicktrackingAnalyticsModule.profileSignOff();
   }
 
-  /**
-   * 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);
-  }
-
   /**
    * SDK正式初始化
    * @param appKey QuickTracking后台提供的唯一key值，请勿泄露给第三方

package/lib/typescript/index.d.ts

@@ -6,20 +6,21 @@ declare type EventParams = Record<string, string | number>;
 export declare class QT {
     /**
      * 页面浏览事件埋点-打开页面
-     * @param pageName 页面名称
+     * @param pageName 页面编码
      */
     static onPageStart(pageName: string): void;
     /**
      * 页面浏览事件埋点-离开页面
-     * @param pageName 页面名称
+     * @param pageName 页面编码
      */
     static onPageEnd(pageName: string): void;
     /**
      * 自定义事件埋点
-     * @param eventId 当前统计的事件ID
+     * @param eventId 当前统计的事件编码
      * @param params 对当前事件的参数描述，定义为“参数名:参数值”的“<键-值>”对
+     * @param pageName 当前统计事件的页面编码
      */
-    static sendEvent(eventId: string, params?: EventParams): void;
+    static sendEvent(eventId: string, params?: EventParams, pageName?: string): void;
     /**
      * 桥接事件埋点
      * @param data H5转发事件的日志体
@@ -62,16 +63,6 @@ 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值，请勿泄露给第三方

package/package.json

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

package/src/index.tsx

@@ -10,7 +10,7 @@ type EventParams = Record<string, string | number>;
 export class QT {
   /**
    * 页面浏览事件埋点-打开页面
-   * @param pageName 页面名称
+   * @param pageName 页面编码
    */
   static onPageStart(pageName: string) {
     QuicktrackingAnalyticsModule.onPageStart(pageName);
@@ -18,7 +18,7 @@ export class QT {
 
   /**
    * 页面浏览事件埋点-离开页面
-   * @param pageName 页面名称
+   * @param pageName 页面编码
    */
   static onPageEnd(pageName: string) {
     QuicktrackingAnalyticsModule.onPageEnd(pageName);
@@ -26,14 +26,27 @@ export class QT {
 
   /**
    * 自定义事件埋点
-   * @param eventId 当前统计的事件ID
+   * @param eventId 当前统计的事件编码
    * @param params 对当前事件的参数描述，定义为“参数名:参数值”的“<键-值>”对
+   * @param pageName 当前统计事件的页面编码
    */
-  static sendEvent(eventId: string, params?: EventParams) {
+  static sendEvent(eventId: string, params?: EventParams, pageName?: string) {
     if (params) {
-      QuicktrackingAnalyticsModule.onEventObject(eventId, params);
+      if (pageName) {
+        QuicktrackingAnalyticsModule.onEventWithParamsAndPageName(
+          eventId,
+          params,
+          pageName
+        );
+      } else {
+        QuicktrackingAnalyticsModule.onEventWithParams(eventId, params);
+      }
     } else {
-      QuicktrackingAnalyticsModule.onEvent(eventId);
+      if (pageName) {
+        QuicktrackingAnalyticsModule.onEventWithPageName(eventId, pageName);
+      } else {
+        QuicktrackingAnalyticsModule.onEvent(eventId);
+      }
     }
   }
 
@@ -176,19 +189,6 @@ export class QT {
     QuicktrackingAnalyticsModule.profileSignOff();
   }
 
-  /**
-   * 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);
-  }
-
   /**
    * SDK正式初始化
    * @param appKey QuickTracking后台提供的唯一key值，请勿泄露给第三方