Merge pull request #1 from AppsFlyerSDK/cuid-stop

added SetCustomerUserID() & Stop()

Author: gilmor-af

Assets/AppsflyerModule.cs

@@ -18,6 +18,8 @@ public class AppsflyerModule
     private string appid { get; }
     private int af_counter { get; set; }
     private string af_device_id { get; }
+    private string cuid { get; set; }
+    private bool isStopped { get; set; }
     private MonoBehaviour mono { get; }
 
     public AppsflyerModule(string devkey, string appid, MonoBehaviour mono, bool isSandbox = false)
@@ -26,6 +28,7 @@ public AppsflyerModule(string devkey, string appid, MonoBehaviour mono, bool isS
         this.devkey = devkey;
         this.appid = appid;
         this.mono = mono;
+        this.isStopped = true;
 
         this.af_counter = PlayerPrefs.GetInt("af_counter");
         // Debug.Log("af_counter: " + af_counter);
@@ -59,7 +62,9 @@ private RequestData CreateRequestData()
             app_version = "1.0.0", //TODO: Insert your app version
             device_ids = deviceids,
             request_id = GenerateGuid(),
-            limit_ad_tracking = false
+            limit_ad_tracking = false,
+            customer_user_id = cuid
+
         };
         return req;
     }
@@ -87,6 +92,7 @@ private static string TrimDeviceOsVer(string device_os_ver)
     // report first open event to AppsFlyer (or session if counter > 2)
     public void Start(bool skipFirst = false)
     {
+        this.isStopped = false;
         // generating the request data
         RequestData req = CreateRequestData();
 
@@ -100,9 +106,21 @@ public void Start(bool skipFirst = false)
         mono.StartCoroutine(SendUnityPostReq(req, REQ_TYPE));
     }
 
+    public void Stop()
+    {
+        isStopped = true;
+        Debug.LogWarning("Appsflyer SDK has been stopped.");
+    }
+
     // report inapp event to AppsFlyer
     public void LogEvent(string event_name, Dictionary<string, object> event_parameters)
     {
+        if (isStopped)
+        {
+            Debug.LogWarning("Cannot send LogEvent, the Appsflyer SDK is stopped");
+            return;
+        }
+
         // generating the request data
         RequestData req = CreateRequestData();
         // setting the event name and value
@@ -140,6 +158,17 @@ public string GetAppsFlyerUID()
         return this.af_device_id;
     }
 
+    public void SetCustomerUserId(string cuid)
+    {
+        if (!isStopped)
+        {
+            Debug.LogWarning("Cannot set CustomerUserID while the SDK has started.");
+            return;
+        }
+        Debug.Log("Customer User ID has been set");
+        this.cuid = cuid;
+    }
+
     // send post request with Unity HTTP Client
     private IEnumerator SendUnityPostReq(RequestData req, AppsflyerRequestType REQ_TYPE)
     {
@@ -292,6 +321,7 @@ class RequestData
     public DeviceIDs[] device_ids;
     public string request_id;
     public bool limit_ad_tracking;
+    public string customer_user_id;
     public string event_name;
     public Dictionary<string, object> event_parameters;
 }

Assets/AppsflyerScript.cs

@@ -8,11 +8,15 @@ public class AppsflyerScript : MonoBehaviour
 {
     public string DEV_KEY;
     public string APP_ID;
+    public bool IS_SANDBOX;
 
     void Start()
     {
-        AppsflyerModule afm = new AppsflyerModule(DEV_KEY, APP_ID, this);
+        AppsflyerModule afm = new AppsflyerModule(DEV_KEY, APP_ID, this, IS_SANDBOX);
+        afm.SetCustomerUserId("testTEST12345");
         afm.Start();
+        afm.SetCustomerUserId("testTESTNOPE");
+        afm.Stop();
 
         // set event name
         string event_name = "af_purchase";

Assets/Scenes/SampleScene.unity

@@ -152,8 +152,9 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: baec666e5d68e6e449e5490b387c3be7, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
-  devkey: 
-  appid: 
+  DEV_KEY: 
+  APP_ID: 
+  IS_SANDBOX: 0
 --- !u!4 &425522096
 Transform:
   m_ObjectHideFlags: 0

ProjectSettings/ProjectSettings.asset

@@ -270,7 +270,99 @@ PlayerSettings:
   AndroidValidateAppBundleSize: 1
   AndroidAppBundleSizeToValidate: 150
   m_BuildTargetIcons: []
-  m_BuildTargetPlatformIcons: []
+  m_BuildTargetPlatformIcons:
+  - m_BuildTarget: Android
+    m_Icons:
+    - m_Textures: []
+      m_Width: 432
+      m_Height: 432
+      m_Kind: 2
+      m_SubKind: 
+    - m_Textures: []
+      m_Width: 324
+      m_Height: 324
+      m_Kind: 2
+      m_SubKind: 
+    - m_Textures: []
+      m_Width: 216
+      m_Height: 216
+      m_Kind: 2
+      m_SubKind: 
+    - m_Textures: []
+      m_Width: 162
+      m_Height: 162
+      m_Kind: 2
+      m_SubKind: 
+    - m_Textures: []
+      m_Width: 108
+      m_Height: 108
+      m_Kind: 2
+      m_SubKind: 
+    - m_Textures: []
+      m_Width: 81
+      m_Height: 81
+      m_Kind: 2
+      m_SubKind: 
+    - m_Textures: []
+      m_Width: 192
+      m_Height: 192
+      m_Kind: 1
+      m_SubKind: 
+    - m_Textures: []
+      m_Width: 144
+      m_Height: 144
+      m_Kind: 1
+      m_SubKind: 
+    - m_Textures: []
+      m_Width: 96
+      m_Height: 96
+      m_Kind: 1
+      m_SubKind: 
+    - m_Textures: []
+      m_Width: 72
+      m_Height: 72
+      m_Kind: 1
+      m_SubKind: 
+    - m_Textures: []
+      m_Width: 48
+      m_Height: 48
+      m_Kind: 1
+      m_SubKind: 
+    - m_Textures: []
+      m_Width: 36
+      m_Height: 36
+      m_Kind: 1
+      m_SubKind: 
+    - m_Textures: []
+      m_Width: 192
+      m_Height: 192
+      m_Kind: 0
+      m_SubKind: 
+    - m_Textures: []
+      m_Width: 144
+      m_Height: 144
+      m_Kind: 0
+      m_SubKind: 
+    - m_Textures: []
+      m_Width: 96
+      m_Height: 96
+      m_Kind: 0
+      m_SubKind: 
+    - m_Textures: []
+      m_Width: 72
+      m_Height: 72
+      m_Kind: 0
+      m_SubKind: 
+    - m_Textures: []
+      m_Width: 48
+      m_Height: 48
+      m_Kind: 0
+      m_SubKind: 
+    - m_Textures: []
+      m_Width: 36
+      m_Height: 36
+      m_Kind: 0
+      m_SubKind: 
   m_BuildTargetBatching: []
   m_BuildTargetShaderSettings: []
   m_BuildTargetGraphicsJobs:

README.md

@@ -47,6 +47,8 @@ AppsflyerModule afm = new AppsflyerModule(<< DEV_KEY >>, << APP_ID >>, this, tru
 
 - `DEV_KEY`: Get from the marketer or [AppsFlyer HQ](https://support.appsflyer.com/hc/en-us/articles/211719806-App-settings-#general-app-settings).
 - `APP_ID`: The app id on Appsflyer HQ
+- `MonoBehaviour mono`:
+- `bool isSandbox`: Whether to activate sandbox mode. False by default.
 
 ### Start
 
@@ -69,6 +71,28 @@ bool skipFirst = [SOME_CONDITION];
 afm.Start(skipFirst);
 ```
 
+
+### Stop
+
+Once this method is invoked, our SDK no longer communicates with our servers and stops functioning.
+Useful when implementing user opt-in/opt-out.
+
+**Method signature**
+
+```c#
+void Stop()
+```
+
+**Usage**:
+
+```c#
+// Starting the SDK
+afm.Start();
+// ...
+// Stopping the SDK, preventing further communication with AppsFlyer
+afm.Stop();
+```
+
 ### LogEvent
 
 This method receives an event name and JSON object and sends an in-app event to AppsFlyer.
@@ -121,6 +145,27 @@ bool IsInstallOlderThanDate = afm.IsInstallOlderThanDate("2023-02-11T10:00:00+00
 afm.Start(!IsInstallOlderThanDate);
 ```
 
+
+### SetCustomerUserId
+
+Setting your own customer ID enables you to cross-reference your own unique ID with AppsFlyer’s unique ID and other devices’ IDs.
+This ID is available in raw-data reports and in the Postback APIs for cross-referencing with your internal IDs.
+Can be used only before calling `Start()`.
+
+**Method signature**
+
+```c#
+void SetCustomerUserId(string cuid)
+```
+
+**Usage**:
+
+```c#
+AppsflyerSteamModule afm = new AppsflyerSteamModule(DEV_KEY, STEAM_APP_ID, this);
+afm.SetCustomerUserId("15667737-366d-4994-ac8b-653fe6b2be4a");
+afm.Start();
+```
+
 ### GetAppsFlyerUID
 
 Get AppsFlyer's unique device ID. The SDK generates an AppsFlyer unique device ID upon app installation. When the SDK is started, this ID is recorded as the ID of the first app install.