feat: add preset traffic source attributes

awslabs · Apr 11, 2024 · 10cd9b9 · 10cd9b9
1 parent 2996028
commit 10cd9b9
Show file tree

Hide file tree

Showing 6 changed files with 81 additions and 17 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.4.0
+
+* feat: add preset traffic source attributes
+
 ## 0.3.0
 
 * feat: add record screen view api

diff --git a/README.md b/README.md
@@ -80,7 +80,7 @@ analytics.setUserId(null);
 
 ```dart
 analytics.setUserAttributes({
-  "userName":"carl",
+  "userName": "carl",
   "userAge": 22
 });
 ```
@@ -90,23 +90,30 @@ Current login user's attributes will be cached in disk, so the next time app lau
 #### Add global attribute
 
 1. Add global attributes when initializing the SDK
-
+
+   The following example code shows how to add traffic source fields as global attributes when initializing the SDK.
    ```dart
    analytics.init({
      appId: "your appId",
      endpoint: "https://example.com/collect",
      globalAttributes: {
-       "_traffic_source_medium": "Search engine",
-       "_traffic_source_name": "Summer promotion",
+       Attr.TRAFFIC_SOURCE_SOURCE: "amazon",
+       Attr.TRAFFIC_SOURCE_MEDIUM: "cpc",
+       Attr.TRAFFIC_SOURCE_CAMPAIGN: "summer_promotion",
+       Attr.TRAFFIC_SOURCE_CAMPAIGN_ID: "summer_promotion_01",
+       Attr.TRAFFIC_SOURCE_TERM: "running_shoes",
+       Attr.TRAFFIC_SOURCE_CONTENT: "banner_ad_1",
+       Attr.TRAFFIC_SOURCE_CLID: "amazon_ad_123",
+       Attr.TRAFFIC_SOURCE_CLID_PLATFORM: "amazon_ads",
+       Attr.APP_INSTALL_CHANNEL: "amazon_store"
      }
    });
    ```
 
 2. Add global attributes after initializing the SDK
    ```dart
    analytics.addGlobalAttributes({
-     "_traffic_source_medium": "Search engine",
-     "_traffic_source_name": "Summer promotion",
+     Attr.TRAFFIC_SOURCE_MEDIUM: "Search engine",
      "level": 10
    });
    ```
@@ -138,7 +145,8 @@ var itemBook = ClickstreamItem(
 analytics.record(
     name: "view_item", 
     attributes: {
-        "currency": "USD",
+        Attr.VALUE: 99,
+        Attr.CURRENCY: "USD"
         "event_category": "recommended"
     }, 
     items: [itemBook]

diff --git a/analysis_options.yaml b/analysis_options.yaml
@@ -2,3 +2,6 @@ include: package:flutter_lints/flutter.yaml
 
 # Additional information about this file can be found at
 # https://dart.dev/guides/language/analysis-options
+linter:
+  rules:
+    // ignore: non_constant_identifier_name
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -42,7 +42,15 @@ class _MyAppState extends State<MyApp> {
         isCompressEvents: false,
         sessionTimeoutDuration: 30000,
         globalAttributes: {
-          "channel": "Samsung",
+          Attr.TRAFFIC_SOURCE_SOURCE: "amazon",
+          Attr.TRAFFIC_SOURCE_MEDIUM: "cpc",
+          Attr.TRAFFIC_SOURCE_CAMPAIGN: "summer_promotion",
+          Attr.TRAFFIC_SOURCE_CAMPAIGN_ID: "summer_promotion_01",
+          Attr.TRAFFIC_SOURCE_TERM: "running_shoes",
+          Attr.TRAFFIC_SOURCE_CONTENT: "banner_ad_1",
+          Attr.TRAFFIC_SOURCE_CLID: "amazon_ad_123",
+          Attr.TRAFFIC_SOURCE_CLID_PLATFORM: "amazon_ads",
+          Attr.APP_INSTALL_CHANNEL: "amazon_store",
           "Class": 5,
           "isTrue": true,
           "Score": 24.32
@@ -180,7 +188,7 @@ class _MyAppState extends State<MyApp> {
               title: const Text('addGlobalAttributes'),
               onTap: () async {
                 analytics.addGlobalAttributes({
-                  "channel": "Samsung",
+                  Attr.APP_INSTALL_CHANNEL: "amazon_store",
                   "Class": 5,
                   "isTrue": true,
                   "Score": 24.32
@@ -193,7 +201,7 @@ class _MyAppState extends State<MyApp> {
               leading: const Icon(Icons.delete_rounded),
               title: const Text('deleteGlobalAttributes'),
               onTap: () async {
-                analytics.deleteGlobalAttributes(["Score", "channel"]);
+                analytics.deleteGlobalAttributes(["Score", Attr.APP_INSTALL_CHANNEL]);
                 log("deleteGlobalAttributes Score and channel");
               },
               minLeadingWidth: 0,

diff --git a/lib/clickstream_analytics.dart b/lib/clickstream_analytics.dart
@@ -119,3 +119,19 @@ class ClickstreamAnalytics {
     return ClickstreamInterface.instance.enable();
   }
 }
+
+class Attr {
+  static const String TRAFFIC_SOURCE_SOURCE = '_traffic_source_source';
+  static const String TRAFFIC_SOURCE_MEDIUM = '_traffic_source_medium';
+  static const String TRAFFIC_SOURCE_CAMPAIGN = '_traffic_source_campaign';
+  static const String TRAFFIC_SOURCE_CAMPAIGN_ID =
+      '_traffic_source_campaign_id';
+  static const String TRAFFIC_SOURCE_TERM = '_traffic_source_term';
+  static const String TRAFFIC_SOURCE_CONTENT = '_traffic_source_content';
+  static const String TRAFFIC_SOURCE_CLID = '_traffic_source_clid';
+  static const String TRAFFIC_SOURCE_CLID_PLATFORM =
+      '_traffic_source_clid_platform';
+  static const String APP_INSTALL_CHANNEL = '_app_install_channel';
+  static const String VALUE = '_value';
+  static const String CURRENCY = '_currency';
+}
diff --git a/test/clickstream_flutter_test.dart b/test/clickstream_flutter_test.dart
@@ -72,7 +72,28 @@ void main() {
         appId: 'testApp',
         endpoint: "https://example.com/collect",
         globalAttributes: {
-          "channel": "Samsung",
+          Attr.APP_INSTALL_CHANNEL: "amazon_store",
+          "Class": 5,
+          "isTrue": true,
+          "Score": 24.32
+        });
+    expect(result, true);
+  });
+
+  test('init SDK with traffic source using global attributes', () async {
+    var result = await analytics.init(
+        appId: 'testApp',
+        endpoint: "https://example.com/collect",
+        globalAttributes: {
+          Attr.TRAFFIC_SOURCE_SOURCE: "amazon",
+          Attr.TRAFFIC_SOURCE_MEDIUM: "cpc",
+          Attr.TRAFFIC_SOURCE_CAMPAIGN: "summer_promotion",
+          Attr.TRAFFIC_SOURCE_CAMPAIGN_ID: "summer_promotion_01",
+          Attr.TRAFFIC_SOURCE_TERM: "running_shoes",
+          Attr.TRAFFIC_SOURCE_CONTENT: "banner_ad_1",
+          Attr.TRAFFIC_SOURCE_CLID: "amazon_ad_123",
+          Attr.TRAFFIC_SOURCE_CLID_PLATFORM: "amazon_ads",
+          Attr.APP_INSTALL_CHANNEL: "amazon_store",
           "Class": 5,
           "isTrue": true,
           "Score": 24.32
@@ -93,7 +114,7 @@ void main() {
         isTrackUserEngagementEvents: false,
         isTrackAppExceptionEvents: true,
         globalAttributes: {
-          "channel": "Samsung",
+          Attr.APP_INSTALL_CHANNEL: "amazon_store",
         });
     expect(result, true);
   });
@@ -125,10 +146,14 @@ void main() {
         price: 65,
         currency: "USD",
         attributes: {"place_of_origin": "USA"});
-    var result = analytics.record(
-        name: "cart_view",
-        attributes: {"_traffic_source_name": "Summer promotion"},
-        items: [itemBook, itemShoes]);
+    var result = analytics.record(name: "cart_view", attributes: {
+      Attr.TRAFFIC_SOURCE_CAMPAIGN: "Summer promotion",
+      Attr.VALUE: 164,
+      Attr.CURRENCY: "USD"
+    }, items: [
+      itemBook,
+      itemShoes
+    ]);
     expect(result, isNotNull);
   });
 
@@ -155,7 +180,7 @@ void main() {
 
   test('setGlobalAttributes', () async {
     var result = analytics.addGlobalAttributes(
-        {"channel": "Play Store", "level": 5.1, "class": 6});
+        {Attr.APP_INSTALL_CHANNEL: "amazon_store", "level": 5.1, "class": 6});
     var result1 = analytics.addGlobalAttributes({});
     expect(result, isNotNull);
     expect(result1, isNotNull);