Goal tracking

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Unreleased
 * **improvement** Added public init to `CustomVariable` [#269](https://github.com/matomo-org/matomo-sdk-ios/issues/269)
 * **improvement** Renamed the `visitorId` property to `userId` to be more inline with the Documentation. [#258](https://github.com/matomo-org/matomo-sdk-ios/issues/258)
+* **improvement** Added a method for goal tracking [#272](https://github.com/matomo-org/matomo-sdk-ios/issues/272)
 * **bugfix** Fixed an issue where `trackSearch` called from Objective-C would end in an infinite loop. [#263](https://github.com/matomo-org/matomo-sdk-ios/issues/263)
 * **bugfix** Fixed an issue on Objective-C project where swift version was't set. [#260](https://github.com/matomo-org/matomo-sdk-ios/issues/260)
 

MatomoTracker/Event.swift

@@ -87,10 +87,15 @@ public struct Event {
     let contentPiece: String?
     let contentTarget: String?
     let contentInteraction: String?
+
+    /// Goal tracking
+    /// https://matomo.org/docs/tracking-goals-web-analytics/
+    let goalId: Int?
+    let revenue: Float?
 }
 
 extension Event {
-    public init(tracker: MatomoTracker, action: [String], url: URL? = nil, referer: URL? = nil, eventCategory: String? = nil, eventAction: String? = nil, eventName: String? = nil, eventValue: Float? = nil, customTrackingParameters: [String:String] = [:], searchQuery: String? = nil, searchCategory: String? = nil, searchResultsCount: Int? = nil, dimensions: [CustomDimension] = [], variables: [CustomVariable] = [], contentName: String? = nil, contentInteraction: String? = nil, contentPiece: String? = nil, contentTarget: String? = nil) {
+    public init(tracker: MatomoTracker, action: [String], url: URL? = nil, referer: URL? = nil, eventCategory: String? = nil, eventAction: String? = nil, eventName: String? = nil, eventValue: Float? = nil, customTrackingParameters: [String:String] = [:], searchQuery: String? = nil, searchCategory: String? = nil, searchResultsCount: Int? = nil, dimensions: [CustomDimension] = [], variables: [CustomVariable] = [], contentName: String? = nil, contentInteraction: String? = nil, contentPiece: String? = nil, contentTarget: String? = nil, goalId: Int? = nil, revenue: Float? = nil) {
         self.siteId = tracker.siteId
         self.uuid = NSUUID()
         self.visitor = tracker.visitor
@@ -117,5 +122,7 @@ extension Event {
         self.contentPiece = contentPiece
         self.contentTarget = contentTarget
         self.contentInteraction = contentInteraction
+        self.goalId = goalId
+        self.revenue = revenue
     }
 }

MatomoTracker/EventSerializer.swift

@@ -73,6 +73,9 @@ fileprivate extension Event {
                 URLQueryItem(name: "c_p", value: contentPiece),
                 URLQueryItem(name: "c_t", value: contentTarget),
                 URLQueryItem(name: "c_i", value: contentInteraction),
+
+                URLQueryItem(name: "idgoal", value: goalId != nil ? "\(goalId!)" : nil),
+                URLQueryItem(name: "revenue", value: revenue != nil ? "\(revenue!)" : nil),
                 ].filter { $0.value != nil }
 
             let dimensionItems = dimensions.map { URLQueryItem(name: "dimension\($0.index)", value: $0.value) }

MatomoTracker/MatomoTracker.swift

@@ -277,6 +277,16 @@ extension MatomoTracker {
         let event = Event(tracker: self, action: [], url: url, eventCategory: category, eventAction: action, eventName: name, eventValue: value, dimensions: dimensions)
         queue(event: event)
     }
+
+    /// Tracks a goal as described here: https://matomo.org/docs/tracking-goals-web-analytics/
+    ///
+    /// - Parameters:
+    ///   - goalId: The defined ID of the Goal
+    ///   - revenue: The monetary value that was generated by the Goal
+    public func track(goalWithId goalId: Int?, revenue: Float?) {
+        let event = Event(tracker: self, action: [], goalId: goalId, revenue: revenue)
+        queue(event: event)
+    }
 }
 
 extension MatomoTracker {

MatomoTrackerTests/Fixtures/MemoryQueueFixtures.swift

@@ -20,7 +20,9 @@ struct EventFixture {
                      contentName: nil,
                      contentPiece: nil,
                      contentTarget: nil,
-                     contentInteraction: nil)
+                     contentInteraction: nil,
+                     goalId: nil,
+                     revenue: nil)
     }
 }
 

README.md

@@ -139,6 +139,14 @@ matomoTracker.trackContentImpression(name: "preview-liveaboard", piece: "Malaysi
 matomoTracker.trackContentInteraction(name: "preview-liveaboard", interaction: "tap", piece: "Malaysia", target: "https://dummy.matomo.org/liveaboard/malaysia")
 ```
 
+### Goal Tracking
+
+The Matomo iOS SDK supports [goal tracking](https://matomo.org/docs/tracking-goals-web-analytics/).
+
+```Swift
+matomoTracker.track(goalWithId: 1, revenue: 99.99)
+```
+
 ## Advanced Usage
 ### Manual dispatching