Merge pull request #116 from adjust/v4260

Version 4.26.0

Author: uerceg

.gitignore

@@ -1,3 +1,21 @@
+### Version 4.26.0 (18th February 2021)
+#### Added
+- Added possibility to get cost data information in attribution callback.
+- Added `setNeedsCost` method to `AdjustConfig` to indicate if cost data is needed in attribution callback (by default cost data will not be part of attribution callback if not enabled with this setter method).
+- Added `setPreinstallTrackingEnabled` method to `AdjustConfig` to allow enabling of preinstall tracking (this feature is OFF by default).
+- Added support for Apple Search Ads attribution with usage of `AdServices.framework`.
+- Added `setAllowAdServicesInfoReading` method to `AdjustConfig` to allow option for users to prevent SDK from performing any tasks related to Apple Search Ads attribution with usage of `AdServices.framework`.
+- Added wrapper method `updateConversionValue` method to `Adjust` to allow updating SKAdNetwork conversion value via SDK API.
+- Added `getAppTrackingAuthorizationStatus` getter to `Adjust` instance to be able to get current iOS app tracking status.
+- Added improved measurement consent management and third party sharing mechanism.
+- Added public constants to be used as sources for ad revenue tracking with `trackAdRevenue` method.
+
+#### Native SDKs
+- [[email protected]][ios_sdk_v4.26.1]
+- [[email protected]][android_sdk_v4.26.2]
+
+---
+
 ### Version 4.23.1 (6th November 2020)
 #### Added
 - Added support for autolinking.
@@ -381,6 +399,7 @@
 [ios_sdk_v4.22.1]: https://github.com/adjust/ios_sdk/tree/v4.22.1
 [ios_sdk_v4.23.0]: https://github.com/adjust/ios_sdk/tree/v4.23.0
 [ios_sdk_v4.23.2]: https://github.com/adjust/ios_sdk/tree/v4.23.2
+[ios_sdk_v4.26.1]: https://github.com/adjust/ios_sdk/tree/v4.26.1
 
 [android_sdk_v4.10.4]: https://github.com/adjust/android_sdk/tree/v4.10.4
 [android_sdk_v4.11.0]: https://github.com/adjust/android_sdk/tree/v4.11.0
@@ -403,3 +422,4 @@
 [android_sdk_v4.22.0]: https://github.com/adjust/android_sdk/tree/v4.22.0
 [android_sdk_v4.24.0]: https://github.com/adjust/android_sdk/tree/v4.24.0
 [android_sdk_v4.24.1]: https://github.com/adjust/android_sdk/tree/v4.24.1
+[android_sdk_v4.26.2]: https://github.com/adjust/android_sdk/tree/v4.26.2

CHANGELOG.md

@@ -21,7 +21,9 @@ This is the React Native SDK of Adjust™. You can read more about Adjust™ at
 * [Additional features](#additional-features)
    * [AppTrackingTransparency framework](#att-framework)
       * [App-tracking authorisation wrapper](#ata-wrapper)
+      * [Get current authorisation status](#ata-getter)
    * [SKAdNetwork framework](#skadn-framework)
+      * [Update SKAdNetwork conversion value](#skadn-update-conversion-value)
    * [Event tracking](#event-tracking)
       * [Revenue tracking](#revenue-tracking)
       * [Revenue deduplication](#revenue-deduplication)
@@ -40,7 +42,10 @@ This is the React Native SDK of Adjust™. You can read more about Adjust™ at
    * [Offline mode](#offline-mode)
    * [Event buffering](#event-buffering)
    * [GDPR right to be forgotten](#gdpr-forget-me)
-   * [Disable third-party sharing](#disable-third-party-sharing)
+   * [Third-party sharing](#third-party-sharing)
+      * [Disable third-party sharing](#disable-third-party-sharing)
+      * [Enable third-party sharing](#enable-third-party-sharing)
+   * [Measurement consent](#measurement-consent)
    * [SDK signature](#sdk-signature)
    * [Background tracking](#background-tracking)
    * [Device IDs](#device-ids)
@@ -237,16 +242,15 @@ As of v4.22.0, the Adjust SDK supports install tracking on Huawei devices with H
 
 ### <a id="ios-frameworks"></a>iOS frameworks
 
-Select your project in the Project Navigator. In the left hand side of the main view, select your target. In the tab `Build Phases`, expand the group `Link Binary with Libraries`. On the bottom of that section click on the `+` button. Select the `AdSupport.framework` and click the `Add` button. Unless you are using `tvOS`, repeat the same steps to add the `iAd.framework`, `CoreTelephony.framework`, `AppTrackingTransparency.framework` and `StoreKit.framework`. Change the `Status` of both frameworks to `Optional`. Adjust SDK uses these frameworks with following purpose:
+Select your project in the Project Navigator. In the left hand side of the main view, select your target. In the tab `Build Phases`, expand the group `Link Binary with Libraries`. On the bottom of that section click on the `+` button. Select below mentined frameworks and make sure to change the `Status` of frameworks to `Optional`. Adjust SDK uses these frameworks with following purpose:
 
-* `iAd.framework` - in case you are running iAd campaigns
-* `AdSupport.framework` - for reading iOS Advertising Id (IDFA)
-* `CoreTelephony.framework` - for reading MCC and MNC information
-* `StoreKit.framework` - for communication with SKAdNetwork framework
+* `iAd.framework` - to support Apple Searh Ads campaigns
+* `AdServices.framework` - to support Apple Searh Ads campaigns
+* `AdSupport.framework` - to read iOS Advertising Id (IDFA) value
+* `CoreTelephony.framework` - to read MCC and MNC information
+* `StoreKit.framework` - to communicate with `SKAdNetwork` framework
 * `AppTrackingTransparency.framework` - to ask for user's consent to be tracked and obtain status of that consent
 
-If you are not running any iAd campaigns, you can feel free to remove the `iAd.framework` dependency. If you don't use SKAdNetwork framework, feel free to remove `StoreKit.framework` dependency (unless you need it for something else).
-
 ## <a id="additional-features"></a>Additional features
 
 You can take advantage of the following features once the Adjust SDK is integrated into your project.
@@ -304,6 +308,18 @@ Adjust.requestTrackingAuthorizationWithCompletionHandler(function(status) {
 
 Before calling the method, make sure that your iOS app's `Info.plist` contains an entry for `NSUserTrackingUsageDescription` key. In absence of that key and usage of this method, app will crash.
 
+### <a id="ata-getter"></a>Get current authorisation status
+
+**Note**: This feature exists only in iOS platform.
+
+To get the current app tracking authorization status you can call `getAppTrackingAuthorizationStatus` method of `Adjust` class that will return one of the following possibilities:
+
+* `0`: The user hasn't been asked yet
+* `1`: The user device is restricted
+* `2`: The user denied access to IDFA
+* `3`: The user authorized access to IDFA
+* `-1`: The status is not available
+
 ### <a id="skadn-framework"></a>SKAdNetwork framework
 
 **Note**: This feature exists only in iOS platform.
@@ -316,6 +332,16 @@ In case you don't want the Adjust SDK to automatically communicate with SKAdNetw
 adjustConfig.deactivateSKAdNetworkHandling();
 ```
 
+### <a id="skadn-update-conversion-value"></a>Update SKAdNetwork conversion value
+
+**Note**: This feature exists only in iOS platform.
+
+You can use Adjust SDK wrapper method `updateConversionValue` to update SKAdNetwork conversion value for your user:
+
+```js
+Adjust.updateConversionValue(6);
+```
+
 ### <a id="event-tracking"></a>Event tracking
 
 You can use Adjust to track all kinds of events. Let's say you want to track every tap on a button. Simply create a new event token in your [dashboard]. Let's say that event token is `abc123`. You can add the following line in your button’s click handler method to track the click:
@@ -596,6 +622,9 @@ adjustConfig.setAttributionCallbackListener(function(attribution) {
     console.log(attribution.creative);
     console.log(attribution.clickLabel);
     console.log(attribution.adid);
+    console.log(attribution.costType);
+    console.log(attribution.costAmount);
+    console.log(attribution.costCurrency);
 });
 
 Adjust.create(adjustConfig);
@@ -611,9 +640,14 @@ Within the listener function you have access to the `attribution` parameters. He
 - `creative`        the creative grouping level of the current attribution.
 - `clickLabel`      the click label of the current attribution.
 - `adid`            the Adjust device identifier.
+- `costType`        the cost type.
+- `costAmount`      the cost amount.
+- `costCurrency`    the cost currency.
 
 Please make sure to consider our [applicable attribution data policies][attribution-data].
 
+**Note**: The cost data - `costType`, `costAmount` & `costCurrency` are only available when configured in `AdjustConfig` by calling `setNeedsCost` method. If not configured or configured, but not being part of the attribution, these fields will have value `null`. This feature is available in SDK v4.26.0 and above.
+
 ### <a id="session-event-callbacks"></a>Session and event callbacks
 
 You can register a callback to be notified of successful and failed tracked events and/or sessions.
@@ -754,19 +788,52 @@ Adjust.gdprForgetMe();
 
 Upon receiving this information, Adjust will erase the user's data and the Adjust SDK will stop tracking the user. No requests from this device will be sent to Adjust in the future.
 
-### <a id="disable-third-party-sharing"></a>Disable third-party sharing for specific users
+## <a id="third-party-sharing"></a>Third-party sharing for specific users
 
-You can now notify Adjust when a user has exercised their right to stop sharing their data with partners for marketing purposes, but has allowed it to be shared for statistics purposes. 
+You can notify Adjust when a user disables, enables, and re-enables data sharing with third-party partners.
 
-Call the following method to instruct the Adjust SDK to communicate the user's choice to disable data sharing to the Adjust backend:
+### <a id="disable-third-party-sharing"></a>Disable third-party sharing for specific users
 
+Call the following method to instruct the Adjust SDK to communicate the user's choice to disable data sharing to the Adjust backend:
 
-```cs
-Adjust.disableThirdPartySharing();
+```js
+var adjustThirdPartySharing = new AdjustThirdPartySharing(false);
+Adjust.trackThirdPartySharing(adjustThirdPartySharing);
 ```
 
 Upon receiving this information, Adjust will block the sharing of that specific user's data to partners and the Adjust SDK will continue to work as usual.
 
+### <a id="enable-third-party-sharing">Enable or re-enable third-party sharing for specific users</a>
+
+Call the following method to instruct the Adjust SDK to communicate the user's choice to share data or change data sharing, to the Adjust backend:
+
+```js
+var adjustThirdPartySharing = new AdjustThirdPartySharing(false);
+Adjust.trackThirdPartySharing(adjustThirdPartySharing);
+```
+
+Upon receiving this information, Adjust changes sharing the specific user's data to partners. The Adjust SDK will continue to work as expected.
+
+Call the following method to instruct the Adjust SDK to send the granular options to the Adjust backend:
+
+```js
+var adjustThirdPartySharing = new AdjustThirdPartySharing(null);
+adjustThirdPartySharing.addGranularOption("PartnerA", "foo", "bar");
+Adjust.trackThirdPartySharing(adjustThirdPartySharing);
+```
+
+### <a id="measurement-consent"></a>Consent measurement for specific users
+
+You can notify Adjust when a user exercises their right to change data sharing with partners for marketing purposes, but they allow data sharing for statistical purposes. 
+
+Call the following method to instruct the Adjust SDK to communicate the user's choice to change data sharing, to the Adjust backend:
+
+```js
+Adjust.trackMeasurementConsent(true);
+```
+
+Upon receiving this information, Adjust changes sharing the specific user's data to partners. The Adjust SDK will continue to work as expected.
+
 ### <a id="sdk-signature"></a>SDK signature
 
 An account manager must activate the Adjust SDK signature. Contact Adjust support ([email protected]) if you are interested in using this feature.

README.md

@@ -1 +1 @@
-4.23.1
+4.26.0

VERSION

@@ -10,6 +10,7 @@
 
 import android.net.Uri;
 import android.util.Log;
+import java.util.List;
 import java.util.Map;
 import java.util.HashMap;
 import java.util.Map.Entry;
@@ -121,6 +122,8 @@ public void create(ReadableMap mapConfig) {
         boolean shouldLaunchDeeplink = false;
         boolean eventBufferingEnabled = false;
         boolean readMobileEquipmentIdentity = false;
+        boolean preinstallTrackingEnabled = false;
+        boolean needsCost = false;
 
         // Suppress log level.
         if (checkKey(mapConfig, "logLevel")) {
@@ -248,6 +251,18 @@ && checkKey(mapConfig, "info4")) {
         //     adjustConfig.setReadMobileEquipmentIdentity(readMobileEquipmentIdentity);
         // }
 
+        // Preinstall tracking.
+        if (checkKey(mapConfig, "preinstallTrackingEnabled")) {
+            preinstallTrackingEnabled = mapConfig.getBoolean("preinstallTrackingEnabled");
+            adjustConfig.setPreinstallTrackingEnabled(preinstallTrackingEnabled);
+        }
+
+        // Cost data.
+        if (checkKey(mapConfig, "needsCost")) {
+            needsCost = mapConfig.getBoolean("needsCost");
+            adjustConfig.setNeedsCost(needsCost);
+        }
+
         // Launching deferred deep link.
         if (checkKey(mapConfig, "shouldLaunchDeeplink")) {
             shouldLaunchDeeplink = mapConfig.getBoolean("shouldLaunchDeeplink");
@@ -592,6 +607,54 @@ public void requestTrackingAuthorizationWithCompletionHandler(Callback callback)
         callback.invoke("");
     }
 
+    @ReactMethod
+    public void updateConversionValue(int conversionValue) {
+        // do nothing
+    }
+
+    @ReactMethod
+    public void getAppTrackingAuthorizationStatus(Callback callback) {
+        callback.invoke("-1");
+    }
+
+    @ReactMethod
+    public void trackThirdPartySharing(ReadableMap mapThirdPartySharing) {
+        if (mapThirdPartySharing == null) {
+            return;
+        }
+
+        Boolean isEnabled = null;
+        List<Object> granularOptions = null;
+
+        // Enabled.
+        if (checkKey(mapThirdPartySharing, "isEnabled")) {
+            isEnabled = mapThirdPartySharing.getBoolean("isEnabled");
+        }
+
+        final AdjustThirdPartySharing thirdPartySharing = new AdjustThirdPartySharing(isEnabled);
+
+        // Granular options.
+        if (checkKey(mapThirdPartySharing, "granularOptions")) {
+            granularOptions = AdjustUtil.toList(mapThirdPartySharing.getArray("granularOptions"));
+            if (null != granularOptions) {
+                for (int i = 0; i < granularOptions.size(); i += 3) {
+                    thirdPartySharing.addGranularOption(
+                        granularOptions.get(i).toString(),
+                        granularOptions.get(i+1).toString(),
+                        granularOptions.get(i+2).toString());
+                }
+            }
+        }
+
+        // Track third party sharing.
+        com.adjust.sdk.Adjust.trackThirdPartySharing(thirdPartySharing);
+    }
+
+    @ReactMethod
+    public void trackMeasurementConsent(boolean measurementConsent) {
+        com.adjust.sdk.Adjust.trackMeasurementConsent(measurementConsent);
+    }
+
     @ReactMethod
     public void setAttributionCallbackListener() {
         this.attributionCallback = true;
@@ -669,10 +732,10 @@ public void setTestOptions(ReadableMap mapTest) {
             String value = mapTest.getString("subscriptionPath");
             testOptions.subscriptionPath = value;
         }
-        if (checkKey(mapTest, "useTestConnectionOptions")) {
-            boolean value = mapTest.getBoolean("useTestConnectionOptions");
-            testOptions.useTestConnectionOptions = value;
-        }
+        // if (checkKey(mapTest, "useTestConnectionOptions")) {
+        //     boolean value = mapTest.getBoolean("useTestConnectionOptions");
+        //     testOptions.useTestConnectionOptions = value;
+        // }
         if (checkKey(mapTest, "timerIntervalInMilliseconds")) {
             try {
                 Long value = Long.parseLong(mapTest.getString("timerIntervalInMilliseconds"));

android/libs/adjust-android.jar

@@ -27,6 +27,9 @@ final class AdjustUtil {
     private static final String ATTRIBUTION_CREATIVE = "creative";
     private static final String ATTRIBUTION_CLICK_LABEL = "clickLabel";
     private static final String ATTRIBUTION_ADID = "adid";
+    private static final String ATTRIBUTION_COST_TYPE = "costType";
+    private static final String ATTRIBUTION_COST_AMOUNT = "costAmount";
+    private static final String ATTRIBUTION_COST_CURRENCY = "costCurrency";
 
     private static final String EVENT_SUCCESS_MESSAGE = "message";
     private static final String EVENT_SUCCESS_TIMESTAMP = "timestamp";
@@ -68,6 +71,9 @@ public static WritableMap attributionToMap(AdjustAttribution attribution) {
         map.putString(ATTRIBUTION_CREATIVE, null != attribution.creative ? attribution.creative : "");
         map.putString(ATTRIBUTION_CLICK_LABEL, null != attribution.clickLabel ? attribution.clickLabel : "");
         map.putString(ATTRIBUTION_ADID, null != attribution.adid ? attribution.adid : "");
+        map.putString(ATTRIBUTION_COST_TYPE, null != attribution.costType ? attribution.costType : "");
+        map.putDouble(ATTRIBUTION_COST_AMOUNT, null != attribution.costAmount && !attribution.costAmount.isNaN() ? attribution.costAmount : 0);
+        map.putString(ATTRIBUTION_COST_CURRENCY, null != attribution.costCurrency ? attribution.costCurrency : "");
         return map;
     }