react-native-adjust - npm Package Compare versions

Comparing version 4.23.1 to 4.26.0

CHANGELOG.md

@@ -0,1 +1,19 @@
+### 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
+- [iOS@v4.26.1][ios_sdk_v4.26.1]
+- [Android@v4.26.2][android_sdk_v4.26.2]
+
+---
+
 ### Version 4.23.1 (6th November 2020)
@@ -384,2 +402,3 @@ #### Added
 [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
 
@@ -407,1 +426,2 @@ [android_sdk_v4.10.4]: https://github.com/adjust/android_sdk/tree/v4.10.4
 [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

index.d.ts

@@ -14,2 +14,5 @@ declare module 'react-native-adjust' {
     adid: string
+    costType: string
+    costAmount: number
+    costCurrency: string
   }
@@ -57,17 +60,9 @@
     constructor(appToken: string, environment: Environment)
-
     public setLogLevel(level: LogLevel): void
-
-    public setEventBufferingEnabled(isEnabled: boolean): void
-
+    public setEventBufferingEnabled(eventBufferingEnabled: boolean): void
     public setProcessName(processName: string): void
-
     public setDefaultTracker(defaultTracked: string): void
-
     public setExternalDeviceId(externalDeviceId: string): void
-
     public setUrlStrategy(urlStrategy: string): void
-
     public setUserAgent(userAgent: string): void
-
     public setAppSecret(
@@ -78,18 +73,14 @@ secretId: number,
       info3: number,
-      info4: number
-    ): void
-
+      info4: number): void
     public setDelayStart(delayStart: number): void
-
     public setSendInBackground(sendInBackground: boolean): void
-
     public setDeviceKnown(isDeviceKnown: boolean): void
-
+    public setNeedsCost(needsCost: boolean): void
+    public setPreinstallTrackingEnabled(preinstallTrackingEnabled: boolean): void
     public setAllowiAdInfoReading(allowiAdInfoReading: boolean): void
-
+    public setAllowAdServicesInfoReading(allowAdServicesInfoReading: boolean): void
     public setAllowIdfaReading(allowIdfaReading: boolean): void
-
     public setSdkPrefix(sdkPrefix: string): void
-
     public setShouldLaunchDeeplink(shouldLaunchDeeplink: boolean): void
+    public deactivateSKAdNetworkHandling(): void;
 
@@ -161,2 +152,7 @@ public setAttributionCallbackListener(
 
+  export class AdjustThirdPartySharing {
+    constructor(isEnabled: boolean)
+    public addGranularOption(partnerName: string, key: string, value: string): void
+  }
+
   export const Adjust: {
@@ -191,3 +187,8 @@ componentWillUnmount: () => void
     convertUniversalLink: (url: string, scheme: string, callback: (convertedUrl: string) => void) => void
+    requestTrackingAuthorizationWithCompletionHandler: (handler: (status: number) => void) => void
+    updateConversionValue: (conversionValue: number) => void
+    getAppTrackingAuthorizationStatus: (callback: (authorizationStatus: number) => void) => void
+    trackThirdPartySharing: (adjustThirdPartySharing: AdjustThirdPartySharing) => void
+    trackMeasurementConsent: (measurementConsent: boolean) => void
   }
 }

index.js

@@ -129,3 +129,3 @@ 'use strict';
 Adjust.getSdkVersion = function(callback) {
-    module_adjust.getSdkVersion("react-native4.23.1", callback);
+    module_adjust.getSdkVersion("react-native4.26.0", callback);
 };
@@ -150,2 +150,18 @@
 
+Adjust.updateConversionValue = function(conversionValue) {
+    module_adjust.updateConversionValue(conversionValue);
+};
+
+Adjust.getAppTrackingAuthorizationStatus = function(callback) {
+    module_adjust.getAppTrackingAuthorizationStatus(callback);
+};
+
+Adjust.trackThirdPartySharing = function(adjustThirdPartySharing) {
+    module_adjust.trackThirdPartySharing(adjustThirdPartySharing);
+};
+
+Adjust.trackMeasurementConsent = function(measurementConsent) {
+    module_adjust.trackMeasurementConsent(measurementConsent);
+};
+
 Adjust.componentWillUnmount = function() {
@@ -217,3 +233,3 @@ if (AdjustConfig.AttributionSubscription != null) {
 var AdjustConfig = function(appToken, environment) {
-    this.sdkPrefix = "react-native4.23.1";
+    this.sdkPrefix = "react-native4.26.0";
     this.appToken = appToken;
@@ -225,2 +241,3 @@ this.environment = environment;
     this.sendInBackground = null;
+    this.needsCost = null;
     this.delayStart = null;
@@ -240,4 +257,6 @@ this.userAgent = null;
     this.readMobileEquipmentIdentity = null;
+    this.preinstallTrackingEnabled = null;
     // iOS only
     this.allowiAdInfoReading = null;
+    this.allowAdServicesInfoReading = null;
     this.allowIdfaReading = null;
@@ -264,2 +283,21 @@ this.skAdNetworkHandling = null;
 AdjustConfig.UrlStrategyIndia = "india";
+AdjustConfig.AdRevenueSourceMopub = "mopub";
+AdjustConfig.AdRevenueSourceAdmob = "admob";
+AdjustConfig.AdRevenueSourceFbNativeAd = "facebook_native_ad";
+AdjustConfig.AdRevenueSourceFbAudienceNetwork = "facebook_audience_network";
+AdjustConfig.AdRevenueSourceIronsource = "ironsource";
+AdjustConfig.AdRevenueSourceFyber = "fyber";
+AdjustConfig.AdRevenueSourceAerserv = "aerserv";
+AdjustConfig.AdRevenueSourceAppodeal = "appodeal";
+AdjustConfig.AdRevenueSourceAdincube = "adincube";
+AdjustConfig.AdRevenueSourceFusePowered = "fusepowered";
+AdjustConfig.AdRevenueSourceAddapptr = "addapptr";
+AdjustConfig.AdRevenueSourceMillennialMediation = "millennial_mediation";
+AdjustConfig.AdRevenueSourceFlurry = "flurry";
+AdjustConfig.AdRevenueSourceAdmost = "admost";
+AdjustConfig.AdRevenueSourceDeltadna = "deltadna";
+AdjustConfig.AdRevenueSourceUpsight = "upsight";
+AdjustConfig.AdRevenueSourceUnityAds = "unityads";
+AdjustConfig.AdRevenueSourceAdtoapp = "adtoapp";
+AdjustConfig.AdRevenueSourceTapdaq = "tapdaq";
 
@@ -320,2 +358,6 @@ AdjustConfig.prototype.setEventBufferingEnabled = function(isEnabled) {
 
+AdjustConfig.prototype.setNeedsCost = function(needsCost) {
+    this.needsCost = needsCost;
+};
+
 AdjustConfig.prototype.setSdkPrefix = function(sdkPrefix) {
@@ -333,2 +375,6 @@ this.sdkPrefix = sdkPrefix;
 
+AdjustConfig.prototype.setPreinstallTrackingEnabled = function(isEnabled) {
+    this.preinstallTrackingEnabled = isEnabled;
+};
+
 AdjustConfig.prototype.setAllowiAdInfoReading = function(allowiAdInfoReading) {
@@ -338,2 +384,6 @@ this.allowiAdInfoReading = allowiAdInfoReading;
 
+AdjustConfig.prototype.setAllowAdServicesInfoReading = function(allowAdServicesInfoReading) {
+    this.allowAdServicesInfoReading = allowAdServicesInfoReading;
+};
+
 AdjustConfig.prototype.setAllowIdfaReading = function(allowIdfaReading) {
@@ -513,2 +563,25 @@ this.allowIdfaReading = allowIdfaReading;
 
-module.exports = { Adjust, AdjustEvent, AdjustConfig, AdjustAppStoreSubscription, AdjustPlayStoreSubscription }
+// AdjustThirdPartySharing
+
+var AdjustThirdPartySharing = function(isEnabled) {
+    this.isEnabled = isEnabled;
+    this.granularOptions = [];
+};
+
+AdjustThirdPartySharing.prototype.addGranularOption = function(partnerName, key, value) {
+    if (typeof partnerName !== 'string' || typeof key !== 'string' || typeof value !== 'string') {
+        return;
+    }
+    this.granularOptions.push(partnerName);
+    this.granularOptions.push(key);
+    this.granularOptions.push(value);
+};
+
+module.exports = {
+    Adjust,
+    AdjustEvent,
+    AdjustConfig,
+    AdjustAppStoreSubscription,
+    AdjustPlayStoreSubscription,
+    AdjustThirdPartySharing
+}

package.json

 {
     "name": "react-native-adjust",
     "description": "Adjust React Native SDK",
-    "version": "4.23.1",
+    "version": "4.26.0",
     "main": "index.js",
@@ -21,3 +21,6 @@ "author": "Adjust GmbH",
         "url": "git://github.com/adjust/react_native_sdk.git"
+    },
+    "dependencies": {
+        "create-react-native-app": "^3.5.3"
     }
 }

README.md

@@ -24,3 +24,5 @@ ## Summary
       * [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)
@@ -44,3 +46,6 @@ * [Revenue tracking](#revenue-tracking)
    * [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)
@@ -242,12 +247,11 @@ * [Background tracking](#background-tracking)
 
-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
@@ -310,2 +314,14 @@
 
+### <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
@@ -323,2 +339,12 @@
 
+### <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
@@ -604,2 +630,5 @@
     console.log(attribution.adid);
+    console.log(attribution.costType);
+    console.log(attribution.costAmount);
+    console.log(attribution.costCurrency);
 });
@@ -620,5 +649,10 @@
 - `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
@@ -764,11 +798,13 @@
 
+## <a id="third-party-sharing"></a>Third-party sharing for specific users
+
+You can notify Adjust when a user disables, enables, and re-enables data sharing with third-party partners.
+
 ### <a id="disable-third-party-sharing"></a>Disable 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. 
-
 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);
 ```
@@ -778,2 +814,33 @@
 
+### <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
@@ -780,0 +847,0 @@

No alert changes

Improved metrics

Total package byte prevSize

1006838

increased by6.44%

Number of package files

108

increased by2.86%

Lines of code

1634

increased by9.08%

Number of lines in readme file

1112

increased by6.41%

Worsened metrics

Dependency count

1

increased byInfinity%

Dependency changes

• + Addedcreate-react-native-app@^3.5.3

• + Addedcreate-react-native-app@3.9.0(transitive)