Merge pull request #4 from convertedin/update-identify

amr-sakr · web-flow · commit 4ec263e11888 · 2024-08-14T17:13:40.000+03:00
update identify user function and new events (onPushNotificationClick…
diff --git a/PixelSDK/src/main/java/convertedin/pixel/pixelsdk/ConvertedInSdk.kt b/PixelSDK/src/main/java/convertedin/pixel/pixelsdk/ConvertedInSdk.kt
@@ -33,6 +33,7 @@ class ConvertedInSdk {
         helper?.saveDeviceId()
 
         helper?.identifyUser()
+        helper?.appOpened()
         Log.d("Pixel SDK", "$apiUrl$pixelId")
     }
 
@@ -56,11 +57,27 @@ class ConvertedInSdk {
         helper?.addEvent(eventName, currency, total, products)
     }
 
+    /**
+     * This event is typically triggered when a user clicks on a push notification,
+     * and should pass the received campaign id to the function, you can find the campaign id
+     * in the payload of the push notification ["campaign_id"] with a string value
+     */
+    fun onPushNotificationClicked(campaignId: String) {
+        helper?.clickOnPush(campaignId)
+    }
+
+    /**
+     * This event is typically triggered when a user registers for the app.
+     */
     fun registerEvent() {
         helper?.registerEvent()
     }
 
-    // add view content event
+    /**
+     * This event is typically triggered when a user views a specific piece of content,
+     * such as a product, article, or video. By tracking ViewContent events, developers can gain
+     * insights into what content users are engaging with most and optimize their content strategy accordingly.
+     */
     fun viewContentEvent(
         currency: String?,
         total: String?,
@@ -69,7 +86,11 @@ class ConvertedInSdk {
         helper?.viewContentEvent(currency, total, products)
     }
 
-    // add view page event
+    /**
+     * This event is triggered when a user views a page or screen within the app.
+     * By tracking PageView events, developers can gain insights into how users navigate through
+     * their app and optimize the user experience accordingly.
+     */
     fun pageViewEvent(
         currency: String?,
         total: String?,
@@ -78,7 +99,13 @@ class ConvertedInSdk {
         helper?.pageViewEvent(currency, total, products)
     }
 
-    // add to cart event
+    /**
+     * This event is triggered when a user adds a product to their shopping cart.
+     * By tracking AddToCart events, developers can gain insights into which products are most
+     * popular and optimize their product offering and pricing accordingly. The AddToCart event i
+     * s often paired with other e-commerce events such as Purchase or Checkout events, and is an
+     * important component of user analysis and e-commerce optimization.
+     */
     fun addToCartEvent(
         currency: String?,
         total: String?,
@@ -87,7 +114,13 @@ class ConvertedInSdk {
         helper?.addToCartEvent(currency, total, products)
     }
 
-    // add init checkout event
+    /**
+     * This event is triggered when a user begins the process of checking out and entering their
+     * payment and shipping information. By tracking InitiateCheckout events, developers can gain
+     * insights into how users interact with the checkout process and identify areas for improvement
+     * to increase conversion rates. The InitiateCheckout event is often paired with other e-commerce
+     * events such as AddToCart or Purchase events, and is an important component of user analysis and e-commerce optimization.
+     */
     fun initiateCheckoutEvent(
         currency: String?,
         total: String?,
@@ -96,7 +129,14 @@ class ConvertedInSdk {
         helper?.initiateCheckoutEvent(currency, total, products)
     }
 
-    // add purchase event
+    /**
+     *This event is triggered when a user completes a purchase and successfully makes a payment
+     * for a product or service. By tracking Purchase events, developers can gain insights into
+     * which products are most popular and identify patterns in user behavior to optimize the
+     * checkout process and increase sales. The Purchase event is often paired with other e-commerce
+     * events such as AddToCart or InitiateCheckout events, and is an important component of
+     * user analysis and e-commerce optimization.
+     */
     fun purchaseEvent(
         currency: String?,
         total: String?,
diff --git a/PixelSDK/src/main/java/convertedin/pixel/pixelsdk/apis/EventApiCalls.kt b/PixelSDK/src/main/java/convertedin/pixel/pixelsdk/apis/EventApiCalls.kt
@@ -17,7 +17,7 @@ import io.reactivex.Single
         identifyRequest: IdentifyRequest
     ): Single<IdentifyResponse> =
         apis.identifyUser(
-            ConvertedInSdk.apiUrl + "v1/" + pixelId + "/" + API_IDENTITY,
+            ConvertedInSdk.apiUrl + "v2/" + pixelId + "/" + API_IDENTITY,
             storeUrl,
             identifyRequest = identifyRequest
         )
diff --git a/PixelSDK/src/main/java/convertedin/pixel/pixelsdk/data/entities/PixelEvents.kt b/PixelSDK/src/main/java/convertedin/pixel/pixelsdk/data/entities/PixelEvents.kt
@@ -8,6 +8,7 @@ data class EventRequest(
     @SerializedName("cuid") var cuid: String?,
     @SerializedName("data") var data: EventData?,
     @SerializedName("csid") var csid: String?,
+    @SerializedName("ca") var campaignId: String?,
 )
 
 data class EventData(
diff --git a/PixelSDK/src/main/java/convertedin/pixel/pixelsdk/data/entities/PixelIdentifyUser.kt b/PixelSDK/src/main/java/convertedin/pixel/pixelsdk/data/entities/PixelIdentifyUser.kt
@@ -6,6 +6,7 @@ import com.google.gson.annotations.SerializedName
 data class IdentifyRequest(
     @SerializedName("email") var email: String? = null,
     @SerializedName("csid") var csid: String? = null,
+    @SerializedName("anonymous_cid") var anonymousCid: String? = null,
     @SerializedName("phone") var phone: String? = null,
     @SerializedName("country_code") var countryCode: String? = null,
     @SerializedName("src") var src: String? = null,
diff --git a/PixelSDK/src/main/java/convertedin/pixel/pixelsdk/data/sharedPref/SharedPreferencesUtils.kt b/PixelSDK/src/main/java/convertedin/pixel/pixelsdk/data/sharedPref/SharedPreferencesUtils.kt
@@ -46,6 +46,14 @@ class SharedPreferencesUtils private constructor(private val prefHelper: PrefHel
         return prefHelper.getString(DEVICE_PIXEL_ID, null)
     }
 
+    fun saveCampaignId(deviceId: String?) {
+        prefHelper.putString(CAMPAIGN_ID, deviceId ?: "")
+    }
+
+    fun getCampaignId(): String? {
+        return prefHelper.getString(CAMPAIGN_ID, null)
+    }
+
 
 
     companion object {
@@ -54,6 +62,7 @@ class SharedPreferencesUtils private constructor(private val prefHelper: PrefHel
         const val USER = "user"
         const val DEVICE_TOKEN = "deviceToke"
         const val DEVICE_PIXEL_ID = "devicePixelId"
+        const val CAMPAIGN_ID = "campaignId"
 
         private var sharedPreferencesUtils: SharedPreferencesUtils? = null
 
diff --git a/PixelSDK/src/main/java/convertedin/pixel/pixelsdk/repository/EventsRepository.kt b/PixelSDK/src/main/java/convertedin/pixel/pixelsdk/repository/EventsRepository.kt
@@ -9,15 +9,21 @@ import convertedin.pixel.pixelsdk.data.sharedPref.toObjectFromJson
 import convertedin.pixel.pixelsdk.utils.LocalDataUtils
 
 
- class EventsRepository(private val apiCalls: EventApiCalls,
-    private val localDataUtils: LocalDataUtils) : BaseRepository(localDataUtils) {
+class EventsRepository(
+    private val apiCalls: EventApiCalls,
+    private val localDataUtils: LocalDataUtils
+) : BaseRepository(localDataUtils) {
 
     fun saveUser(user: IdentifyResponse) =
         localDataUtils.sharedPreferencesUtils.saveUser(user.toJsonString())
 
     fun getUser(): IdentifyResponse? = localDataUtils.sharedPreferencesUtils.getUser()
         ?.toObjectFromJson<IdentifyResponse>(IdentifyResponse::class.java)
 
+    fun saveCampaignId(campaignId: String?) =
+        localDataUtils.sharedPreferencesUtils.saveCampaignId(campaignId)
+
+    fun getCampaignId() = localDataUtils.sharedPreferencesUtils.getCampaignId()
 
     fun identifyUser(pixelId: String, storeUrl: String, identifyRequest: IdentifyRequest) =
         apiCalls.identifyUser(pixelId, storeUrl, identifyRequest = identifyRequest)
diff --git a/PixelSDK/src/main/java/convertedin/pixel/pixelsdk/utils/PixelHelper.kt b/PixelSDK/src/main/java/convertedin/pixel/pixelsdk/utils/PixelHelper.kt
@@ -47,20 +47,14 @@ class PixelHelper(context: Context) {
     }
 
     internal fun identifyUser(email: String?, phone: String?, countryCode: String?) {
-        val csid =
-            if (email.isNullOrBlank() && phone.isNullOrBlank() && countryCode.isNullOrBlank()) {
-                eventsViewModel.getUser()?.csid
-            } else {
-                eventsViewModel.getUser()?.cid
-            }
-
         if (validUrls())
             eventsViewModel.identifyUser(
                 IdentifyRequest(
                     email = email,
                     phone = phone,
                     countryCode = countryCode,
-                    csid = csid,
+                    anonymousCid = eventsViewModel.getUser()?.cid,
+                    csid = eventsViewModel.getUser()?.csid,
                     src = "push"
                 )
             )
@@ -69,16 +63,20 @@ class PixelHelper(context: Context) {
     }
 
     internal fun identifyUser() {
-        val csid = if (eventsViewModel.getUser()?.csid.isNullOrBlank()) {
-            null
-        } else {
-            eventsViewModel.getUser()?.csid
-        }
-
         if (validUrls())
             eventsViewModel.identifyUser(
-                IdentifyRequest(src = "push", csid = csid)
+                IdentifyRequest(
+                    src = "push",
+                    anonymousCid = eventsViewModel.getUser()?.cid,
+                    csid = eventsViewModel.getUser()?.csid
+                )
             )
+        saveDeviceToken(deviceToken = notificationsViewModel.getDeviceToken())
+    }
+
+    internal fun appOpened() {
+        if (validUrls())
+            sendEvent("OpenApp", null, null, null)
     }
 
     internal fun addEvent(
@@ -91,6 +89,13 @@ class PixelHelper(context: Context) {
             sendEvent(eventName, currency, total, products)
     }
 
+    internal fun clickOnPush(campaignId: String?) {
+        if (validUrls()) {
+            eventsViewModel.saveCampaignId(campaignId = campaignId ?: "")
+            sendEvent("ClickOnPush", null, null, null)
+        }
+    }
+
     internal fun registerEvent() {
         if (validUrls())
             sendEvent("Register", null, null, null)
@@ -153,7 +158,8 @@ class PixelHelper(context: Context) {
                 event = eventName,
                 cuid = eventsViewModel.getDeviceId(),
                 data = EventData(currency = currency, value = total, content = products),
-                csid = eventsViewModel.getUser()?.cid
+                csid = eventsViewModel.getUser()?.cid,
+                campaignId = eventsViewModel.getCampaignId()
             )
         )
     }
@@ -162,16 +168,19 @@ class PixelHelper(context: Context) {
     /////////////////////////////////////////////////////////////////////
 
     internal fun saveDeviceToken(deviceToken: String?) {
-        if (validUrls())
-            eventsViewModel.getUser()?.cid?.let {
-                notificationsViewModel.saveDeviceToken(
-                    SaveTokenRequest(
-                        customerId = it,
-                        deviceToken = deviceToken,
-                        tokenType = "android"
+        if (validUrls()) {
+            if (!deviceToken.isNullOrBlank() && deviceToken != notificationsViewModel.getDeviceToken()) {
+                eventsViewModel.getUser()?.cid?.let {
+                    notificationsViewModel.saveDeviceToken(
+                        SaveTokenRequest(
+                            customerId = it,
+                            deviceToken = deviceToken,
+                            tokenType = "android"
+                        )
                     )
-                )
+                }
             }
+        }
     }
 
 
diff --git a/PixelSDK/src/main/java/convertedin/pixel/pixelsdk/viewmodel/EventsViewModel.kt b/PixelSDK/src/main/java/convertedin/pixel/pixelsdk/viewmodel/EventsViewModel.kt
@@ -47,6 +47,14 @@ class EventsViewModel : BaseViewModel() {
         return repository.getUser()
     }
 
+    fun saveCampaignId(campaignId: String?) {
+        repository.saveCampaignId(campaignId)
+    }
+
+    fun getCampaignId(): String? {
+        return repository.getCampaignId()
+    }
+
     fun identifyUser(identifyRequest: IdentifyRequest) {
         val storeUrl = repository.getStoreUrl()
         val pixelId = repository.getPixelId()
diff --git a/PixelSDK/src/main/java/convertedin/pixel/pixelsdk/viewmodel/NotificationsViewModel.kt b/PixelSDK/src/main/java/convertedin/pixel/pixelsdk/viewmodel/NotificationsViewModel.kt
@@ -37,7 +37,7 @@ import convertedin.pixel.pixelsdk.repository.NotificationsRepository
             subscribe(
                 repository.deleteDeviceToken(pixelId, deleteTokenRequest = deleteTokenRequest)
                     .doAfterSuccess {
-                        repository.saveDeviceTokenLocal(null)
+//                        repository.saveDeviceTokenLocal(null) //TODO temporary 13/08/2023
                     }, {}
             )
     }

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ import io.reactivex.Single`
`17`	`17`	`identifyRequest: IdentifyRequest`
`18`	`18`	`): Single<IdentifyResponse> =`
`19`	`19`	`apis.identifyUser(`
`20`		`- ConvertedInSdk.apiUrl + "v1/" + pixelId + "/" + API_IDENTITY,`
	`20`	`+ ConvertedInSdk.apiUrl + "v2/" + pixelId + "/" + API_IDENTITY,`
`21`	`21`	`storeUrl,`
`22`	`22`	`identifyRequest = identifyRequest`
`23`	`23`	`)`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@ data class EventRequest(`
`8`	`8`	`@SerializedName("cuid") var cuid: String?,`
`9`	`9`	`@SerializedName("data") var data: EventData?,`
`10`	`10`	`@SerializedName("csid") var csid: String?,`
	`11`	`+ @SerializedName("ca") var campaignId: String?,`
`11`	`12`	`)`
`12`	`13`
`13`	`14`	`data class EventData(`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ import convertedin.pixel.pixelsdk.repository.NotificationsRepository`
`37`	`37`	`subscribe(`
`38`	`38`	`repository.deleteDeviceToken(pixelId, deleteTokenRequest = deleteTokenRequest)`
`39`	`39`	`.doAfterSuccess {`
`40`		`- repository.saveDeviceTokenLocal(null)`
	`40`	`+// repository.saveDeviceTokenLocal(null) //TODO temporary 13/08/2023`
`41`	`41`	`}, {}`
`42`	`42`	`)`
`43`	`43`	`}`