Merge pull request #8 from logicwind/dev

Added campaign tracking

Author: bhavesh-lw

README.md

@@ -295,7 +295,58 @@ trackMediaEvent function use to monitor user interactions with media content, su
 trackMediaEvent({siteId:"siteid",mediaId:"unique id",mediaTitle:"video media play track",playerName:"test 08",mediaType:MediaType.VIDEO,mediaResource:"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4",mediaStatus:"100",mediaLength:"100",mediaFullScreen:"1",mediaHeight:"720",mediaWidth:"1080",mediaProgress:"100"});
 
 ```
- 
+
+
+ ### trackCampaign()
+
+ Tracking campaigns usually involves recording information about user interactions that can be tied to specific marketing efforts, such as UTM parameters.It requires the parameters `title` and `campaignUrl`
+
+ - #### Default Campaign Tracking Values
+* Campaign (Required): mtm_campaign
+<br>A descriptive name for the campaign, e.g. a blog post title or email campaign name.</br>
+
+* Keyword (Recommended): mtm_keyword
+<br>The specific keyword that someone searched for, or category of interest.</br>
+
+- #### Additional Campaign Tracking Values
+(Available with Matomo Cloud or Marketing Campaigns Reporting Plugin)
+
+* Source (Recommended): `mtm_source`
+<br>The actual source of the traffic, e.g. newsletter, twitter, ebay, etc.</br>
+
+* Medium (Recommended): `mtm_medium`
+<br>The type of marketing channel, e.g. email, social, paid, etc.</br>
+
+* Content (Optional): `mtm_content`
+<br>This is a specific link or content that somebody clicked. e.g. banner, big-green-button</br>
+
+* ID (Optional): `mtm_cid`
+<br>A unique identifier for your specific ad. This parameter is often used with the numeric IDs automatically generated by advertising platforms.</br>
+
+* Group (Requires Matomo 4 or above): `mtm_group`
+<br>The audience your campaign is targeting e.g. customers, retargeting, etc</br>
+
+
+* Placement (Requires Matomo 4 or above): `mtm_placement`
+<br>The placement on an advertising network e.g. newsfeed, sidebar, home-banner, etc.</br>
+
+
+If you already have URLs tagged with Google Analytics parameters these are also supported:
+
+* utm_campaign,
+* utm_source,
+* utm_medium,
+* utm_term,
+* utm_content,
+* utm_id.
+
+#### Examples
+
+```js
+
+trackCampaign("Home screen","https://example.com/?mtm_campaign=2020_august_promo&mtm_source=google&mtm_medium=email&mtm_keyword=august promo&mtm_content=primary-cta")
+
+```
 
 ## Methods
 
@@ -318,6 +369,7 @@ trackMediaEvent({siteId:"siteid",mediaId:"unique id",mediaTitle:"video media pla
 | [enableTracking](#enabletracking)    | -                                                         |    ✅   |  ✅  |    ✅      |   ✅     |
 | [setLogger](#setlogger)              | -                                                         |    ✅   |  ✅  |    ✅      |   ✅     |
 | [trackMediaEvent](#trackmediaevent)  |  siteId: String, mediaId: String, mediaTitle: String, playerName: String, mediaType: String, mediaResource: String, mediaStatus: String,mediaLength?:String, mediaProgress?:String, mediaTTP?: String, mediaWidth?: String, mediaHeight?: String, mediaSE?: String, mediaFullScreen?:String                                            |    ✅   |  ✅  |    ✅      |   ✅     |
+| [trackCampaign](#trackcampaign)      | title: String, campaignUrl: String                        |    ✅   |  ✅  |    ✅      |   ✅     |
 
 
 <!-- ## Contributing

android/src/main/java/com/logicwind/reactnativematomotracker/ReactNativeMatomoTrackerModule.kt

@@ -2,9 +2,10 @@ package com.logicwind.reactnativematomotracker
 
 import android.app.Application
 import android.content.ContentValues.TAG
+import android.content.Context
+import android.content.pm.PackageInfo
 import android.os.Build
 import android.util.Log
-import androidx.core.content.pm.PackageInfoCompat
 import com.facebook.react.bridge.ReactApplicationContext
 import com.facebook.react.bridge.ReactContextBaseJavaModule
 import com.facebook.react.bridge.ReactMethod
@@ -29,6 +30,8 @@ class ReactNativeMatomoTrackerModule(reactContext: ReactApplicationContext) :
   private var tracker: Tracker? = null
   private val client = OkHttpClient()
   private var authToken: String? = null
+  private var site_Id: String = ""
+  private var context:ReactApplicationContext  = reactContext
 
   override fun getName(): String {
     return NAME
@@ -61,6 +64,7 @@ class ReactNativeMatomoTrackerModule(reactContext: ReactApplicationContext) :
   @ReactMethod
   fun createTracker(uri:String,siteId:Int,token:String) {
     authToken = token;
+    site_Id = siteId.toString();
     setTracker(uri,siteId)
   }
 
@@ -183,6 +187,52 @@ class ReactNativeMatomoTrackerModule(reactContext: ReactApplicationContext) :
     }
   }
 
+  fun getUserAgent(context: ReactApplicationContext): String {
+    val packageInfo: PackageInfo = context.packageManager.getPackageInfo(context.packageName, 0)
+    val appName = context.applicationInfo.loadLabel(context.packageManager).toString()
+    val appVersion = packageInfo.versionName
+    val userAgent = "Android/${Build.VERSION.RELEASE} (${Build.MODEL}; ${Build.MANUFACTURER}), MatomoTrackerSDK/4.2 $appName/$appVersion"
+
+    return userAgent
+  }
+
+  @ReactMethod
+  fun trackCampaign(title:String, campaignUrl: String) {
+
+    if (tracker != null) {
+      val userAgent = getUserAgent(context)
+      val baseUrl = tracker?.apiUrl
+      var query = "idsite=${encode(site_Id)}" +
+        "&rec=1" +
+        "&url=${encode(campaignUrl)}" +
+        "&action_name=${title}" +
+        "&_id=${encode(tracker?.visitorId.toString())}"
+        try {
+          val urlString = "$baseUrl?$query"
+          val jsonBody = """
+          {
+              "auth_token": "$authToken",
+          }
+        """.trimIndent()
+
+          val requestBody = jsonBody.toRequestBody("application/json; charset=utf-8".toMediaType())
+
+          val request = Request.Builder()
+            .url(urlString)
+            .header("User-Agent",userAgent)
+            .post(requestBody)
+            .build()
+
+          client.newCall(request).execute().use { response ->
+            val responseCode = response.code
+            println(" responseCode : "+ responseCode)
+          }
+        }catch (e:Exception){
+          Log.e(TAG, "error : ${e.message}")
+        }
+    }
+  }
+
 
   @ReactMethod
   fun trackMedia(
@@ -213,6 +263,7 @@ class ReactNativeMatomoTrackerModule(reactContext: ReactApplicationContext) :
     }
 
     val baseUrl = tracker?.apiUrl
+     val userAgent = getUserAgent(context)
     var query = "idsite=${encode(siteId)}" +
       "&rec=1" +
       "&r=${generateRandomNumber()}" +
@@ -263,6 +314,7 @@ class ReactNativeMatomoTrackerModule(reactContext: ReactApplicationContext) :
 
       val request = Request.Builder()
         .url(urlString)
+        .header("User-Agent",userAgent)
         .post(requestBody)
         .build()
 

example/ios/Podfile.lock

@@ -7,7 +7,7 @@ PODS:
   - hermes-engine (0.74.1):
     - hermes-engine/Pre-built (= 0.74.1)
   - hermes-engine/Pre-built (0.74.1)
-  - logicwind-react-native-matomo-tracker (0.3.2):
+  - logicwind-react-native-matomo-tracker (0.3.3):
     - DoubleConversion
     - glog
     - hermes-engine
@@ -1376,7 +1376,7 @@ SPEC CHECKSUMS:
   fmt: 4c2741a687cc09f0634a2e2c72a838b99f1ff120
   glog: c5d68082e772fa1c511173d6b30a9de2c05a69a2
   hermes-engine: 16b8530de1b383cdada1476cf52d1b52f0692cbc
-  logicwind-react-native-matomo-tracker: 3875a57609e26fb4af6b2998adc3db7421d5acf6
+  logicwind-react-native-matomo-tracker: eefe6c3abc9a2e54ac2c73a74ec75da5b2f20edf
   MatomoTracker: 1f3772a41c27393067d0126071afe6ae1c7f739e
   RCT-Folly: 02617c592a293bd6d418e0a88ff4ee1f88329b47
   RCTDeprecation: efb313d8126259e9294dc4ee0002f44a6f676aba

example/src/App.tsx

@@ -18,6 +18,7 @@ import {
   setUserId,
   setVisitorId,
   startSession,
+  trackCampaign,
   trackDispatch,
   trackDownload,
   trackEvent,
@@ -27,14 +28,14 @@ import {
   trackOutlink,
   trackScreen,
   trackSearch,
-
 } from '@logicwind/react-native-matomo-tracker';
 
 export default function App() {
   const [result] = React.useState<number | undefined>();
 
   React.useEffect(() => {
-    createTracker("https://your-matomo-url/matomo.php", 1) //Replace 1 with your matomo site id
+    createTracker("https://your-domain-url/matomo.php", 1)  //Replace 1 with your matomo site id
+    setLogger()
   }, []);
 
   return (
@@ -43,6 +44,15 @@ export default function App() {
         <View style={styles.container}>
           <Text>Matomo Tracking {result}</Text>
 
+          <Pressable
+            style={styles.button}
+            onPress={() => {
+              trackCampaign("Home screen","rntestApp://home?mtm_campaign=2020_august_promo&mtm_source=google&mtm_medium=email&mtm_keyword=2020 august promo&mtm_content=primary-cta")
+            }}
+          >
+            <Text style={styles.buttonText}>Track Campaign</Text>
+          </Pressable>
+
           <Pressable
             style={styles.button}
             onPress={() => {

ios/ReactNativeMatomoTracker.mm

@@ -39,14 +39,9 @@ @interface RCT_EXTERN_MODULE(ReactNativeMatomoTracker, NSObject)
 
 RCT_EXTERN_METHOD(enableTracking)
 
-RCT_EXTERN_METHOD(trackMedia:(NSString *)siteId withMediaId:(NSString *)mediaId withMediaTitle:(NSString *)mediaTitle withPlayerName:(NSString *)playerName withMediaType:(NSString *)mediaType withMediaResource:(NSString *)mediaResource withMediaStatus:(NSString *)mediaStatus withMediaLength:(NSString *)mediaLength withMediaProgress:(NSString *)mediaProgress withMediaTTP:(NSString *)mediaTTP withMediaWidth:(NSString *)mediaWidth withMediaHeight:(NSString *)mediaHeight withMediaSE:(NSString *)mediaSE withMediaFullScreen:(NSString *)mediaFullScreen)
-
-
-
-
-
-
+RCT_EXTERN_METHOD(trackCampaign:(NSString *)title withCampaignUrl:(NSString *)campaignUrl)
 
+RCT_EXTERN_METHOD(trackMedia:(NSString *)siteId withMediaId:(NSString *)mediaId withMediaTitle:(NSString *)mediaTitle withPlayerName:(NSString *)playerName withMediaType:(NSString *)mediaType withMediaResource:(NSString *)mediaResource withMediaStatus:(NSString *)mediaStatus withMediaLength:(NSString *)mediaLength withMediaProgress:(NSString *)mediaProgress withMediaTTP:(NSString *)mediaTTP withMediaWidth:(NSString *)mediaWidth withMediaHeight:(NSString *)mediaHeight withMediaSE:(NSString *)mediaSE withMediaFullScreen:(NSString *)mediaFullScreen)
 
 
 

ios/ReactNativeMatomoTracker.swift

@@ -6,6 +6,7 @@ class ReactNativeMatomoTracker: NSObject {
 
     var matomoTracker: MatomoTracker?
     var baseURL = "";
+    var site_id = "";
     var authToken = "";
     var _id = "";
     override init() {
@@ -21,8 +22,10 @@ class ReactNativeMatomoTracker: NSObject {
     func createTracker(uri:String,siteId:String,token:String) {
         authToken = token
         let queue = UserDefaultsQueue(UserDefaults.standard, autoSave: true)
+        
          baseURL =  uri
-    
+         site_id = siteId
+        
         let dispatcher = URLSessionDispatcher(baseURL: URL(string:baseURL)!)
         matomoTracker = MatomoTracker(siteId: siteId, queue: queue, dispatcher: dispatcher)
         matomoTracker?.userId = _id;
@@ -115,7 +118,29 @@ class ReactNativeMatomoTracker: NSObject {
 
     }
 
-
+    @objc(trackCampaign:withCampaignUrl:)
+    func trackCampaign(title:String,campaignUrl:String) {
+        
+        if let campaignUrl = URL(string: campaignUrl) {
+            if let components = URLComponents(url: campaignUrl, resolvingAgainstBaseURL: false),
+               let queryItems = components.queryItems {
+                var campaignParameters = [String: String]()
+                for queryItem in queryItems {
+                    if let value = queryItem.value {
+                        campaignParameters[queryItem.name] = value
+                    }
+                }
+            
+                matomoTracker?.track(view: ["campaign"], url: campaignUrl)
+                matomoTracker?.dispatch()
+            }
+            
+        } else {
+                  print("Invalid URL string")
+        }
+    
+    }
+    
     @objc(trackMedia:withMediaId:withMediaTitle:withPlayerName:withMediaType:withMediaResource:withMediaStatus:withMediaLength:withMediaProgress:withMediaTTP:withMediaWidth:withMediaHeight:withMediaSE:withMediaFullScreen:)
     func trackMediaEvent(
         siteId: String,

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logicwind/react-native-matomo-tracker",
-  "version": "0.3.3",
+  "version": "0.3.4",
   "description": "React-native plugin for matomo analytics",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

src/index.tsx

@@ -17,67 +17,71 @@ const ReactNativeMatomoTracker = NativeModules.ReactNativeMatomoTracker
       }
     );
 
-export function createTracker(uri: String, siteId: Number,token:String=""): Promise<number> {
+export function createTracker(uri: String, siteId: Number,token:String="") {
     return ReactNativeMatomoTracker.createTracker(uri, Platform.OS=="ios"?siteId.toString() :siteId,token);
 }
 
-export function trackScreen(screenName: String, title: String): Promise<number> {
+export function trackScreen(screenName: String, title: String) {
   return ReactNativeMatomoTracker.trackScreen(screenName, title);
 }
 
-export function trackEvent(category:String,action:String,name:String="",value:Number=0): Promise<number> {
+export function trackEvent(category:String,action:String,name:String="",value:Number=0) {
   return ReactNativeMatomoTracker.trackEvent(category,action,name,value);
 }
 
-export function trackDispatch(): Promise<number> {
+export function trackDispatch(){
   return ReactNativeMatomoTracker.trackDispatch();
 }
 
-export function trackOutlink(url:String): Promise<number> {
+export function trackOutlink(url:String) {
   return ReactNativeMatomoTracker.trackOutlink(url);
 }
 
-export function trackSearch(keyword:String): Promise<number> {
+export function trackSearch(keyword:String) {
   return ReactNativeMatomoTracker.trackSearch(keyword);
 }
 
-export function trackImpression(contentName:String): Promise<number> {
+export function trackImpression(contentName:String){
   return ReactNativeMatomoTracker.trackImpression(contentName);
 }
 
-export function trackInteraction(contentName:String,contentInteraction:String): Promise<number> {
+export function trackInteraction(contentName:String,contentInteraction:String) {
   return ReactNativeMatomoTracker.trackInteraction(contentName,contentInteraction);
 }
 
-export function trackDownload(category:String,action:String,url:String): Promise<number> {
+export function trackDownload(category:String,action:String,url:String){
   return ReactNativeMatomoTracker.trackDownload(category,action,url);
 }
 
-export function setUserId(id:String): Promise<number> {
+export function setUserId(id:String) {
   return ReactNativeMatomoTracker.setUserId(id);
 }
 
-export function setVisitorId(visitorId:String): Promise<number> {
+export function setVisitorId(visitorId:String) {
   return ReactNativeMatomoTracker.setVisitorId(visitorId);
 }
 
-export function disableTracking(): Promise<number> {
+export function disableTracking() {
   return ReactNativeMatomoTracker.disableTracking();
 }
 
-export function enableTracking(): Promise<number> {
+export function enableTracking() {
   return ReactNativeMatomoTracker.enableTracking();
 }
 
 
-export function setLogger(): Promise<number> {
+export function setLogger(){
   return ReactNativeMatomoTracker.setLogger();
 }
 
-export function startSession(): Promise<number> {
+export function startSession() {
   return ReactNativeMatomoTracker.startSession();
 }
 
+export function trackCampaign(title:String,campaignUrl:String) {
+  return ReactNativeMatomoTracker.trackCampaign(title,campaignUrl);
+}
+
 export function trackMediaEvent(
 {siteId,mediaId,mediaTitle,playerName,mediaType,mediaResource,mediaStatus,mediaLength="",mediaProgress="",mediaTTP="",mediaWidth="",mediaHeight="",mediaSE="",mediaFullScreen=""}:{  
   siteId: String,