Merge pull request #44 from adjust/v4170

Version 4.17.0

.gitmodules

@@ -1,8 +1,8 @@
 [submodule "ext/Android/sdk"]
-	path = ext/Android/sdk
+	path = ext/android/sdk
 	url = [email protected]:adjust/android_sdk.git
 	branch = master
 [submodule "ext/iOS/sdk"]
-	path = ext/iOS/sdk
+	path = ext/ios/sdk
 	url = [email protected]:adjust/ios_sdk.git
 	branch = master

CHANGELOG.md

@@ -1,3 +1,22 @@
+### Version 4.17.0 (14th January 2019)
+#### Added
+- Added `getSdkVersion()` method to `Adjust` interface to obtain current SDK version string.
+- Added `setCallbackId` method on `AdjustEvent` object for users to set custom ID on event object which will later be reported in event success/failure callbacks.
+- Added `callbackId` field to event tracking success callback object.
+- Added `callbackId` field to event tracking failure callback object.
+
+#### Changed
+- Changed usage of `compile` keyword in plugin's `build.gradle` file into `implementation`.
+- Updated Android SDK and build tools to `28`.
+- Marked `setReadMobileEquipmentIdentity` method of `AdjustConfig` object as deprecated.
+- SDK will now fire attribution request each time upon session tracking finished in case it lacks attribution info.
+
+#### Native SDKs
+- [[email protected]][ios_sdk_v4.17.1]
+- [[email protected]][android_sdk_v4.17.0]
+
+---
+
 ### Version 4.14.0 (18th June 2018)
 #### Added
 - Added deep link caching in case `appWillOpenUrl` method is called natively before SDK is initialised.
@@ -13,7 +32,7 @@
 
 ### Version 4.13.0 (23rd May 2018)
 #### Added
-- Added `gdprForgetMe` method to `Adjsut` interface to enable possibility for user to be forgotten in accordance with GDPR law.
+- Added `gdprForgetMe` method to `Adjust` interface to enable possibility for user to be forgotten in accordance with GDPR law.
 
 #### Native SDKs
 - [[email protected]][ios_sdk_v4.13.0]
@@ -367,6 +386,7 @@
 [ios_sdk_v4.12.3]: https://github.com/adjust/ios_sdk/tree/v4.12.3
 [ios_sdk_v4.13.0]: https://github.com/adjust/ios_sdk/tree/v4.13.0
 [ios_sdk_v4.14.1]: https://github.com/adjust/ios_sdk/tree/v4.14.1
+[ios_sdk_v4.17.1]: https://github.com/adjust/ios_sdk/tree/v4.17.1
 
 [android_sdk_v2.1.3]: https://github.com/adjust/android_sdk/tree/v2.1.3
 [android_sdk_v2.1.4]: https://github.com/adjust/android_sdk/tree/v2.1.4
@@ -385,3 +405,4 @@
 [android_sdk_v4.12.4]: https://github.com/adjust/android_sdk/tree/v4.12.4
 [android_sdk_v4.13.0]: https://github.com/adjust/android_sdk/tree/v4.13.0
 [android_sdk_v4.14.0]: https://github.com/adjust/android_sdk/tree/v4.14.0
+[android_sdk_v4.17.0]: https://github.com/adjust/android_sdk/tree/v4.17.0

README.md

@@ -23,6 +23,7 @@ This is the Adobe AIR SDK of Adjust™. You can read more about Adjust™ at [Ad
       * [In-App Purchase verification](#iap-verification)
       * [Callback parameters](#callback-parameters)
       * [Partner parameters](#partner-parameters)
+      * [Callback identifier](#callback-id)
    * [Session parameters](#session-parameters)
       * [Session callback parameters](#session-callback-parameters)
       * [Session partner parameters](#session-partner-parameters)
@@ -245,20 +246,6 @@ If you are using Proguard, add these lines to your Proguard file:
     java.lang.String getId();
     boolean isLimitAdTrackingEnabled();
 }
--keep class dalvik.system.VMRuntime {
-    java.lang.String getRuntime();
-}
--keep class android.os.Build {
-    java.lang.String[] SUPPORTED_ABIS;
-    java.lang.String CPU_ABI;
-}
--keep class android.content.res.Configuration {
-    android.os.LocaleList getLocales();
-    java.util.Locale locale;
-}
--keep class android.os.LocaledList {
-    java.util.Locale get(int);
-}
 -keep public class com.android.installreferrer.** { *; }
 ```
 
@@ -297,10 +284,8 @@ If you want to track in-app purchases, please make sure to call `trackEvent` onl
 
 ```actionscript
 var adjustEvent:AdjustEvent = new AdjustEvent("abc123");
-
 adjustEvent.setRevenue(0.01, "EUR");
 adjustEvent.setTransactionId("transactionId");
-
 Adjust.trackEvent(adjustEvent);
 ```
 
@@ -318,10 +303,8 @@ For example, suppose you have registered the URL `http://www.adjust.com/callback
 
 ```actionscript
 var adjustEvent:AdjustEvent = new AdjustEvent("abc123");
-
 adjustEvent.addCallbackParameter("key", "value");
 adjustEvent.addCallbackParameter("foo", "bar");
-
 Adjust.trackEvent(adjustEvent);
 ```
 
@@ -343,15 +326,23 @@ This works similarly to the callback parameters mentioned above, but can be adde
 
 ```actionscript
 var adjustEvent:AdjustEvent = new AdjustEvent("abc123");
-
 adjustEvent.addPartnerParameter("key", "value");
 adjustEvent.addPartnerParameter("foo", "bar");
-
 Adjust.trackEvent(adjustEvent);
 ```
 
 You can read more about special partners and these integrations in our [guide to special partners][special-partners].
 
+### <a id="callback-id"></a>Callback identifier
+
+You can also add custom string identifier to each event you want to track. This identifier will later be reported in event success and/or event failure callbacks to enable you to keep track on which event was successfully tracked or not. You can set this identifier by calling the `setCallbackId` method on your `AdjustEvent` instance:
+
+```actionscript
+var adjustEvent:AdjustEvent = new AdjustEvent("abc123");
+adjustEvent.setCallbackId("Your-Custom-Id");
+Adjust.trackEvent(adjustEvent);
+```
+
 ### <a id="session-parameters"></a>Session parameters
 
 Some parameters are saved to be sent in every event and session of the Adjust SDK. Once you have added any of these parameters, you don't need to add them every time, since they will be saved locally. If you add the same parameter twice, there will be no effect.
@@ -510,6 +501,7 @@ public class Example extends Sprite {
         trace("Timestamp = " + eventSuccess.getTimeStamp());
         trace("Adid = " + eventSuccess.getAdid());
         trace("Event Token = " + eventSuccess.getEventToken());
+        trace("Callback Id = " + eventSuccess.getCallbackId());
         trace("Json Response = " + eventSuccess.getJsonResponse());
     }
 }
@@ -544,6 +536,7 @@ public class Example extends Sprite {
         trace("Timestamp = " + eventFail.getTimeStamp());
         trace("Adid = " + eventFail.getAdid());
         trace("Event Token = " + eventFail.getEventToken());
+        trace("Callback Id = " + eventFail.getCallbackId());
         trace("Will Retry = " + eventFail.getWillRetry());
         trace("Json Response = " + eventFail.getJsonResponse());
     }
@@ -627,6 +620,7 @@ The callback functions will be called after the SDK tries to send a package to t
 Both event response data objects contain:
 
 - `var eventToken:String` the event token, if the package tracked was an event.
+- `var callbackId:String` the custom defined callback ID set on event object.
 
 And both event and session failed objects also contain:
 
@@ -865,9 +859,7 @@ var appToken:String = "{YourAppToken}";
 var environment:String = Environment.SANDBOX;
       
 var adjustConfig:AdjustConfig = new AdjustConfig(appToken, environment);
-
 adjustConfig.setDeferredDeeplinkDelegate(deferredDeeplinkDelegate);
-
 Adjust.start(adjustConfig);
 
 // ...
@@ -885,10 +877,8 @@ var appToken:String = "{YourAppToken}";
 var environment:String = Environment.SANDBOX;
       
 var adjustConfig:AdjustConfig = new AdjustConfig(appToken, environment);
-
 adjustConfig.setDeferredDeeplinkDelegate(deferredDeeplinkDelegate);
 adjustConfig.setShouldLaunchDeeplink(true);
-
 Adjust.start(adjustConfig);
 
 // ...
@@ -974,9 +964,7 @@ private static function onInvoke(event:InvokeEvent):void {
     }
 
     var deeplink:String = event.arguments[0];
-    
     trace("Deeplink = " + deeplink);
-    
     Adjust.appWillOpenUrl(deeplink);
 }
 ```
@@ -1014,8 +1002,7 @@ private static function onInvoke(event:InvokeEvent):void {
 
 The Adjust SDK is licensed under the MIT License.
 
-Copyright (c) 2012-2018 Adjust GmbH,
-http://www.adjust.com
+Copyright (c) 2012-2019 Adjust GmbH, http://www.adjust.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

VERSION

@@ -1 +1 @@
-4.14.0
+4.17.0

default/src/com/adjust/sdk/Adjust.as

@@ -56,6 +56,10 @@ package com.adjust.sdk {
             trace("Adjust: getAttribution called");
         }
 
+        public static function getSdkVersion():void {
+            trace("Adjust: getSdkVersion called");
+        }
+
         public static function getGoogleAdId(callback:Function):void {
             trace("Adjust: getGoogleAdId called");
         }

default/src/com/adjust/sdk/AdjustEvent.as

@@ -1,14 +1,13 @@
 package com.adjust.sdk {
     public class AdjustEvent {
-        // For iOS & Android
         private var revenue:Number;
         private var currency:String;
         private var eventToken:String;
+        private var callbackId:String;
         private var transactionId:String;
         private var partnerParameters:Array;
         private var callbackParameters:Array;
-
-        // iOS specific
+        // iOS only.
         private var receipt:String;
         private var isReceiptSet:Boolean;
 
@@ -34,6 +33,10 @@ package com.adjust.sdk {
             this.partnerParameters.push(value);
         }
 
+        public function setCallbackId(callbackId:String):void {
+            this.callbackId = callbackId;
+        }
+
         public function setTransactionId(transactionId:String):void {
             this.transactionId = transactionId;
         }
@@ -44,7 +47,7 @@ package com.adjust.sdk {
             this.isReceiptSet = true;
         }
 
-        // Getters
+        // Getters.
         public function getEventToken():String {
             return this.eventToken;
         }
@@ -65,6 +68,10 @@ package com.adjust.sdk {
             return this.partnerParameters;
         }
 
+        public function getCallbackId():String {
+            return this.callbackId;
+        }
+
         public function getTransactionId():String {
             return this.transactionId;
         }

default/src/com/adjust/sdk/AdjustEventFailure.as

@@ -1,29 +1,31 @@
 package com.adjust.sdk {
     public class AdjustEventFailure {
-        private var willRetry:Boolean;
-
         private var adid:String;
         private var message:String;
         private var timestamp:String;
         private var eventToken:String;
+        private var callbackId:String;
+        private var willRetry:Boolean;
         private var jsonResponse:String;
 
         public function AdjustEventFailure(
             message:String,
             timestamp:String,
             adid:String,
             eventToken:String,
+            callbackId:String,
             jsonResponse:String,
             willRetry:Boolean) {
             this.adid = adid;
             this.message = message;
             this.timestamp = timestamp;
             this.eventToken = eventToken;
+            this.callbackId = callbackId;
             this.jsonResponse = jsonResponse;
             this.willRetry = willRetry;
         }
 
-        // Getters
+        // Getters.
         public function getMessage():String {
             return this.message;
         }
@@ -40,6 +42,10 @@ package com.adjust.sdk {
             return this.eventToken;
         }
 
+        public function getCallbackId():String {
+            return this.callbackId;
+        }
+
         public function getJsonResponse():String {
             return this.jsonResponse;
         }

default/src/com/adjust/sdk/AdjustEventSuccess.as

@@ -4,22 +4,25 @@ package com.adjust.sdk {
         private var message:String;
         private var timestamp:String;
         private var eventToken:String;
+        private var callbackId:String;
         private var jsonResponse:String;
 
         public function AdjustEventSuccess(
             message:String,
             timestamp:String,
             adid:String,
             eventToken:String,
+            callbackId:String,
             jsonResponse:String) {
             this.message = message;
             this.timestamp = timestamp;
             this.adid = adid;
             this.eventToken = eventToken;
+            this.callbackId = callbackId;
             this.jsonResponse = jsonResponse;
         }
 
-        // Getters
+        // Getters.
         public function getMessage():String {
             return this.message;
         }
@@ -36,6 +39,10 @@ package com.adjust.sdk {
             return this.eventToken;
         }
 
+        public function getCallbackId():String {
+            return this.callbackId;
+        }
+
         public function getJsonResponse():String {
             return this.jsonResponse;
         }

doc/migrate.md

@@ -1,4 +1,4 @@
-## Migrate your adjust SDK for Adobe AIR to 4.14.0 from 3.4.3
+## Migrate your adjust SDK for Adobe AIR to 4.17.0 from 3.4.3
 
 ### SDK initialization
 

example/Main-app.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?> 
 <application xmlns="http://ns.adobe.com/air/application/28.0"> 
   <id>com.adjust.examples</id> 
-  <versionNumber>4.14.0</versionNumber> 
+  <versionNumber>4.17.0</versionNumber> 
   <filename>Adjust AIR SDK Demo</filename> 
 
   <initialWindow>

example/Main.as

@@ -179,6 +179,7 @@ package {
             trace("Timestamp = " + eventSuccess.getTimeStamp());
             trace("Adid = " + eventSuccess.getAdid());
             trace("Event token = " + eventSuccess.getEventToken());
+            trace("Callback ID = " + eventSuccess.getCallbackId());
             trace("JSON Response = " + eventSuccess.getJsonResponse());
         }
 
@@ -188,6 +189,7 @@ package {
             trace("Timestamp = " + eventFail.getTimeStamp());
             trace("Adid = " + eventFail.getAdid());
             trace("Event token = " + eventFail.getEventToken());
+            trace("Callback ID = " + eventFail.getCallbackId());
             trace("Will retry = " + eventFail.getWillRetry());
             trace("JSON response = " + eventFail.getJsonResponse());
         }