Merge pull request #109 from adjust/v4220

Version 4.22.0

CHANGELOG.md

@@ -1,3 +1,13 @@
+### Version 4.22.0 (10th June 2020)
+#### Added
+- Added subscription tracking feature.
+
+#### Native SDKs
+- [iOS@v4.22.1][ios_sdk_v4.22.1]
+- [Android@v4.22.0][android_sdk_v4.22.0]
+
+---
+
 ### Version 4.21.2 (4th May 2020)
 #### Fixed
 - Removed iAd timer from iOS native SDK.
@@ -466,6 +476,7 @@
 [ios_sdk_v4.21.0]: https://github.com/adjust/ios_sdk/tree/v4.21.0
 [ios_sdk_v4.21.1]: https://github.com/adjust/ios_sdk/tree/v4.21.1
 [ios_sdk_v4.21.3]: https://github.com/adjust/ios_sdk/tree/v4.21.3
+[ios_sdk_v4.22.1]: https://github.com/adjust/ios_sdk/tree/v4.22.1
 
 [android_sdk_v3.5.0]: https://github.com/adjust/android_sdk/tree/v3.5.0
 [android_sdk_v4.1.0]: https://github.com/adjust/android_sdk/tree/v4.1.0
@@ -488,3 +499,4 @@
 [android_sdk_v4.18.0]: https://github.com/adjust/android_sdk/tree/v4.18.0
 [android_sdk_v4.21.0]: https://github.com/adjust/android_sdk/tree/v4.21.0
 [android_sdk_v4.21.1]: https://github.com/adjust/android_sdk/tree/v4.21.1
+[android_sdk_v4.22.0]: https://github.com/adjust/android_sdk/tree/v4.22.0

README.md

@@ -2,7 +2,7 @@
 
 This is the Cordova SDK of Adjust™. You can read more about Adjust™ at [adjust.com].
 
-N.B. At the moment, SDK 4.21.2 for Cordova supports Android platform version `4.0.0 and higher` and iOS platform version `3.0.0 and higher`.
+N.B. At the moment, SDK 4.22.0 for Cordova supports Android platform version `4.0.0 and higher` and iOS platform version `3.0.0 and higher`.
 
 ## Table of contents
 
@@ -29,6 +29,7 @@ N.B. At the moment, SDK 4.21.2 for Cordova supports Android platform version `4.
       * [Callback parameters](#callback-parameters)
       * [Partner parameters](#partner-parameters)
       * [Callback identifier](#callback-id)
+   * [Subscription tracking](#subscription-tracking) 
    * [Session parameters](#session-parameters)
       * [Session callback parameters](#session-callback-parameters)
       * [Session partner parameters](#session-partner-parameters)
@@ -356,6 +357,89 @@ adjustEvent.setCallbackId("Your-Custom-Id");
 Adjust.trackEvent(adjustEvent);
 ```
 
+### <a id="subscription-tracking"></a>Subscription tracking
+
+**Note**: This feature is only available in the SDK v4.22.0 and above.
+
+You can track App Store and Play Store subscriptions and verify their validity with the Adjust SDK. After a subscription has been successfully purchased, make the following call to the Adjust SDK:
+
+**For App Store subscription:**
+
+```js
+var subscription = new AdjustAppStoreSubscription(price, currency, transactionId, receipt);
+subscription.setTransactionDate(transactionDate);
+subscription.setSalesRegion(salesRegion);
+
+Adjust.trackAppStoreSubscription(subscription);
+```
+
+**For Play Store subscription:**
+
+```js
+var subscription = new AdjustPlayStoreSubscription(price, currency, sku, orderId, signature, purchaseToken);
+subscription.setPurchaseTime(purchaseTime);
+
+Adjust.trackPlayStoreSubscription(subscription);
+```
+
+Subscription tracking parameters for App Store subscription:
+
+- [price](https://developer.apple.com/documentation/storekit/skproduct/1506094-price?language=objc)
+- currency (you need to pass [currencyCode](https://developer.apple.com/documentation/foundation/nslocale/1642836-currencycode?language=objc) of the [priceLocale](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=objc) object)
+- [transactionId](https://developer.apple.com/documentation/storekit/skpaymenttransaction/1411288-transactionidentifier?language=objc)
+- [receipt](https://developer.apple.com/documentation/foundation/nsbundle/1407276-appstorereceipturl)
+- [transactionDate](https://developer.apple.com/documentation/storekit/skpaymenttransaction/1411273-transactiondate?language=objc)
+- salesRegion (you need to pass [countryCode](https://developer.apple.com/documentation/foundation/nslocale/1643060-countrycode?language=objc) of the [priceLocale](https://developer.apple.com/documentation/storekit/skproduct/1506145-pricelocale?language=objc) object)
+
+Subscription tracking parameters for Play Store subscription:
+
+- [price](https://developer.android.com/reference/com/android/billingclient/api/SkuDetails#getpriceamountmicros)
+- [currency](https://developer.android.com/reference/com/android/billingclient/api/SkuDetails#getpricecurrencycode)
+- [sku](https://developer.android.com/reference/com/android/billingclient/api/Purchase#getsku)
+- [orderId](https://developer.android.com/reference/com/android/billingclient/api/Purchase#getorderid)
+- [signature](https://developer.android.com/reference/com/android/billingclient/api/Purchase#getsignature)
+- [purchaseToken](https://developer.android.com/reference/com/android/billingclient/api/Purchase#getpurchasetoken)
+- [purchaseTime](https://developer.android.com/reference/com/android/billingclient/api/Purchase#getpurchasetime)
+
+**Note:** Subscription tracking API offered by Adjust SDK expects all parameters to be passed as `string` values. Parameters described above are the ones which API exects you to pass to subscription object prior to tracking subscription. There are various libraries which are handling in app purchases in Cordova and each one of them should return information described above in some form upon successfully completed subscription purchase. You should locate where these parameters are placed in response you are getting from library you are using for in app purchases, extract those values and pass them to Adjust API as string values.
+
+Just like with event tracking, you can attach callback and partner parameters to the subscription object as well:
+
+**For App Store subscription:**
+
+```js
+var subscription = new AdjustAppStoreSubscription(price, currency, transactionId, receipt);
+subscription.setTransactionDate(transactionDate);
+subscription.setSalesRegion(salesRegion);
+
+// add callback parameters
+subscription.addCallbackParameter("key", "value");
+subscription.addCallbackParameter("foo", "bar");
+
+// add partner parameters
+subscription.addPartnerParameter("key", "value");
+subscription.addPartnerParameter("foo", "bar");
+
+Adjust.trackAppStoreSubscription(subscription);
+```
+
+**For Play Store subscription:**
+
+```js
+var subscription = new AdjustPlayStoreSubscription(price, currency, sku, orderId, signature, purchaseToken);
+subscription.setPurchaseTime(purchaseTime);
+
+// add callback parameters
+subscription.addCallbackParameter("key", "value");
+subscription.addCallbackParameter("foo", "bar");
+
+// add partner parameters
+subscription.addPartnerParameter("key", "value");
+subscription.addPartnerParameter("foo", "bar");
+
+Adjust.trackPlayStoreSubscription(subscription);
+```
+
 ### <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.

VERSION

@@ -1 +1 @@
-4.21.2
+4.22.0

doc/migrate.md

@@ -1,4 +1,4 @@
-## Migrate your Adjust SDK for Cordova to 4.21.2 from 3.4.1
+## Migrate your Adjust SDK for Cordova to 4.22.0 from 3.4.1
 
 ### Migration procedure
 

example-cordova/config.xml

@@ -34,5 +34,4 @@
         <variable name="ANDROID_PATHPREFIX" value="/" />
     </plugin>
     <engine name="ios" spec="^4.5.5" />
-    <engine name="android" spec="^7.1.4" />
 </widget>

example-cordova/package.json

@@ -4,12 +4,12 @@
     "description": "A sample Apache Cordova application that uses Adjust SDK.",
     "main": "index.js",
     "dependencies": {
-        "com.adjust.sdk": "^4.21.2",
+        "com.adjust.sdk": "file:../temp_plugin",
         "cordova-android": "^8.1.0",
         "cordova-ios": "^5.1.1",
         "cordova-plugin-console": "^1.1.0",
         "cordova-plugin-customurlscheme": "^4.3.0",
-        "cordova-plugin-device": "^2.0.2",
+        "cordova-plugin-device": "git+https://github.com/apache/cordova-plugin-device.git",
         "cordova-plugin-dialogs": "^2.0.1",
         "cordova-plugin-whitelist": "^1.3.3",
         "cordova-universal-links-plugin": "^1.2.1"
@@ -26,11 +26,12 @@
                 "ANDROID_SCHEME": " ",
                 "ANDROID_HOST": " ",
                 "ANDROID_PATHPREFIX": "/"
-            }
+            },
+            "com.adjust.sdk": {}
         },
         "platforms": [
             "ios",
             "android"
         ]
     }
-}
+}

example-ionic/package.json

@@ -1,6 +1,6 @@
 {
   "name": "AdjustExample",
-  "version": "4.21.2",
+  "version": "4.22.0",
   "author": "Ionic Framework",
   "homepage": "http://ionicframework.com/",
   "private": true,
@@ -26,7 +26,7 @@
     "@ionic-native/status-bar": "~4.17.0",
     "@ionic/storage": "2.2.0",
     "acorn": "^7.1.1",
-    "com.adjust.sdk": "^4.21.2",
+    "com.adjust.sdk": "^4.22.0",
     "cordova-android": "7.1.4",
     "cordova-ios": "^5.1.1",
     "cordova-plugin-device": "^2.0.2",