Merge pull request #614 from AppsFlyerSDK/releases/6.x.x/6.16.x/6.16.2-rc1

Releases/6.x.x/6.16.x/6.16.2 rc1

Author: al-af

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 6.16.2
+ Release date: *2025-03-19*
+
+- SDK > React Native plugin > No enum constant com.appsflyer.MediationNetwork.xxx" error on Android with some mediation networks' names have _ (underscore) character
+- React Native >> Update Plugin to v6.16.2
+
 ## 6.15.3
  Release date: *2025-01-8*
 

Docs/RN_CMP.md

@@ -59,81 +59,123 @@ A CMP compatible with TCF v2.2 collects DMA consent data and stores it in NSUser
     }
  },[])
 ```
-## Manually collect consent data
-If your app does not use a CMP compatible with TCF v2.2, use the SDK API detailed below to provide the consent data directly to the SDK.
-
-### When GDPR applies to the user
-If GDPR applies to the user, perform the following:
-
-1. Given that GDPR is applicable to the user, determine whether the consent data is already stored for this session.
-    1. If there is no consent data stored, show the consent dialog to capture the user consent decision.
-    2. If there is consent data stored continue to the next step.
-2. To transfer the consent data to the SDK create an AppsFlyerConsent object using `forGDPRUser` method that accepts the following parameters:<br>
-    `hasConsentForDataUsage: boolean` - Indicates whether the user has consented to use their data for advertising purposes.<br>
-    `hasConsentForAdsPersonalization: boolean` - Indicates whether the user has consented to use their data for personalized advertising.
-3. Call `appsFlyer.setConsentData(consentData)` with the AppsFlyerConsent object.
-4. Call `appsFlyer.initSdk()`.
+
+### Manually Collecting Consent Data
+
+If your app does not use a TCF v2.2-compatible CMP, you must manually provide the consent data using the SDK API.
+
+How to Set Consent Data: </br>
+1.	Determine GDPR Applicability:
+    *	If GDPR applies, check whether consent data is already stored.
+    *	If not stored, show a consent dialog to obtain user consent.
+2.	Create an AppsFlyerConsent object with the relevant parameters.
+3.	Pass the consent data to the SDK using appsFlyer.setConsentData(consentData).
+4.	Initialize the SDK with appsFlyer.initSdk().
+
+#### Setting Consent Data for Users
+
+<b>When GDPR Applies</b>
+
+If GDPR applies to the user, create an AppsFlyerConsent object with the user’s preferences.
 ```javascript
-import appsFlyer, {AppsFlyerConsent} from 'react-native-appsflyer';
+import appsFlyer, { AppsFlyerConsent } from 'react-native-appsflyer';
 
 useEffect(() => {
     const option = {
-    isDebug: true,
-    devKey: 'UxXxXxXxXd',
-    onInstallConversionDataListener: true,
-    onDeepLinkListener: true,
-    timeToWaitForATTUserAuthorization: 10,
+        isDebug: true,
+        devKey: 'UxXxXxXxXd',
+        onInstallConversionDataListener: true,
+        onDeepLinkListener: true,
+        timeToWaitForATTUserAuthorization: 10,
     };
 
-    // user consent data
-    let consentData = AppsFlyerConsent.forGDPRUser(true, false);
+    // User has given consent
+    const consentData = new AppsFlyerConsent(true, true, true, true);
 
+    // Send consent data to the SDK
     appsFlyer.setConsentData(consentData);
 
-    //start appsflyer
+    // Start AppsFlyer SDK
     appsFlyer.initSdk(
-      option,
-      res => {
-        console.log(res);
-      },
-      err => {
-        console.log(err);
-      },
+        option,
+        res => console.log(res),
+        err => console.log(err)
     );
- },[])
+}, []);
 ```
-### When GDPR does not apply to the user
 
-If GDPR doesn’t apply to the user perform the following:
-1. Create an AppsFlyerConsent object using `forNonGDPRUser` method that doesn't accepts any parameters
-2. Call `appsFlyer.setConsentData(consentData)` with the AppsFlyerConsent object.
-3. Call `appsFlyer.initSdk()`.
+<b>When GDPR Does Not Apply</b>
+
+If GDPR does not apply to the user, simply mark it as such in the AppsFlyerConsent object.
 ```javascript
-import appsFlyer, {AppsFlyerConsent} from 'react-native-appsflyer';
+import appsFlyer, { AppsFlyerConsent } from 'react-native-appsflyer';
 
 useEffect(() => {
     const option = {
-    isDebug: true,
-    devKey: 'UxXxXxXxXd',
-    onInstallConversionDataListener: true,
-    onDeepLinkListener: true,
-    timeToWaitForATTUserAuthorization: 10,
+        isDebug: true,
+        devKey: 'UxXxXxXxXd',
+        onInstallConversionDataListener: true,
+        onDeepLinkListener: true,
+        timeToWaitForATTUserAuthorization: 10,
     };
 
     // GDPR does not apply to the user
-   let consentData = AppsFlyerConsent.forNonGDPRUser();
+    const consentData = new AppsFlyerConsent(false);
 
-   appsFlyer.setConsentData(consentData);
+    // Send consent data to the SDK
+    appsFlyer.setConsentData(consentData);
 
-    //start appsflyer
+    // Start AppsFlyer SDK
     appsFlyer.initSdk(
-      option,
-      res => {
-        console.log(res);
-      },
-      err => {
-        console.log(err);
-      },
+        option,
+        res => console.log(res),
+        err => console.log(err)
     );
- },[])
-```
+}, []);
+```
+
+### Consent Object API
+
+```javascript
+//AppsFlyerConsent Constructor:
+
+new AppsFlyerConsent(
+    isUserSubjectToGDPR,          // Boolean (optional) - Whether GDPR applies to the user
+    hasConsentForDataUsage,       // Boolean (optional) - Consent for data usage
+    hasConsentForAdsPersonalization, // Boolean (optional) - Consent for ads personalization
+    hasConsentForAdStorage        // Boolean (optional) - Consent for ad storage
+);
+
+//Example Cases:
+
+// Full consent for GDPR user
+const consent1 = new AppsFlyerConsent(true, true, true, true);
+
+// No consent for GDPR user
+const consent2 = new AppsFlyerConsent(true, false, false, false);
+
+// Non-GDPR user
+const consent3 = new AppsFlyerConsent(false);
+
+// AppsFlyerConsent object support the following cases if they are needed.
+const consent4 = new AppsFlyerConsent(true);
+const consent5 = new AppsFlyerConsent(true, true);
+const consent6 = new AppsFlyerConsent(null, true, true, true);
+const consent7 = new AppsFlyerConsent(true, null, true, true);
+const consent8 = new AppsFlyerConsent(true, true, null, true);
+const consent9 = new AppsFlyerConsent(true, true, true, null);
+const consent10 = new AppsFlyerConsent(true, true, false, true);
+const consent11 = new AppsFlyerConsent(false, true, false, false);
+const consent12 = new AppsFlyerConsent(null, null, null, null);
+const consent13 = new AppsFlyerConsent();
+```
+
+### Deprecation Notice
+
+The following methods have been deprecated since SDK version 6.16.2 and should no longer be used:
+```javascript
+// Deprecated since 6.16.2
+AppsFlyerConsent.forGDPRUser(true, false);
+AppsFlyerConsent.forNonGDPRUser();
+```
+Instead, use the new AppsFlyerConsent constructor.

Docs/RN_ExpoInstallation.md

@@ -38,6 +38,75 @@ expo install react-native-appsflyer
     ],
 ...
 ```
+### Fix for build failure with RN 0.76 and Expo 52
+To ensure seamless integration of the AppsFlyer plugin in your Expo-managed project, it’s essential to handle modifications to the AndroidManifest.xml correctly. Since direct edits to the AndroidManifest.xml aren’t feasible in the managed workflow, you’ll need to create a custom configuration to include the necessary changes.
+
+### Handling dataExtractionRules Conflict
+
+When building your Expo app with the AppsFlyer plugin, you might encounter a build error related to the `dataExtractionRules` attribute. This issue arises due to a conflict between the `dataExtractionRules `defined in your project’s `AndroidManifest.xml` and the one included in the AppsFlyer SDK.
+
+<b>Solution:</b> Creating a Custom Plugin to Modify `AndroidManifest.xml`
+
+To resolve this, you can create a custom Expo config plugin that modifies the AndroidManifest.xml during the build process. This approach allows you to adjust the manifest without directly editing it, maintaining compatibility with the managed workflow.
+
+Steps to Implement the Custom Plugin:
+1. Create the Plugin File:
+    -	In your project’s root directory, create a file named withCustomAndroidManifest.js.
+2.	Define the Plugin Function:
+	  -	In withCustomAndroidManifest.js, define a function that uses Expo’s withAndroidManifest to modify the manifest. This function will remove the conflicting dataExtractionRules attribute.
+
+```js
+// withCustomAndroidManifest.js
+const { withAndroidManifest } = require('@expo/config-plugins');
+
+module.exports = function withCustomAndroidManifest(config) {
+  return withAndroidManifest(config, async (config) => {
+    const androidManifest = config.modResults;
+    const manifest = androidManifest.manifest;
+    
+    // Ensure xmlns:tools is present in the <manifest> tag
+    if (!manifest.$['xmlns:tools']) {
+      manifest.$['xmlns:tools'] = 'http://schemas.android.com/tools';
+    }
+
+    const application = manifest.application[0];
+
+    // Add tools:replace attribute for dataExtractionRules and fullBackupContent
+    application['$']['tools:replace'] = 'android:dataExtractionRules, android:fullBackupContent';
+
+    // Set dataExtractionRules and fullBackupContent as attributes within <application>
+    application['$']['android:dataExtractionRules'] = '@xml/secure_store_data_extraction_rules';
+    application['$']['android:fullBackupContent'] = '@xml/secure_store_backup_rules';
+
+    return config;
+  });
+};
+
+```
+
+3.	Update app.json or app.config.js:
+	  -	In your app configuration file, include the custom plugin to ensure it’s executed during the build process.
+
+```json
+// app.json
+{
+  "expo": {
+    // ... other configurations ...
+    "plugins": [
+      "./withCustomAndroidManifest.js",
+      [
+        "react-native-appsflyer",
+        {
+          "shouldUseStrictMode": true
+        }
+      ]
+    ]
+  }
+}
+```
+
+By implementing this custom plugin, you can resolve the dataExtractionRules conflict without directly modifying the AndroidManifest.xml.
+
 ## The AD_ID permission for android apps
 In v6.8.0 of the AppsFlyer SDK, we added the normal permission com.google.android.gms.permission.AD_ID to the SDK's AndroidManifest, 
 to allow the SDK to collect the Android Advertising ID on apps targeting API 33.

README.md

@@ -12,11 +12,12 @@
 
 ### <a id="plugin-build-for"> This plugin is built for
 
-- Android AppsFlyer SDK **v6.15.2**
-- iOS AppsFlyer SDK **v6.15.3**
+- Android AppsFlyer SDK **v6.16.2**
+- iOS AppsFlyer SDK **v6.16.2**
 - Tested with React-Native **v0.62.0** (older versions might be supported)
 
 ## <a id="breaking-changes"> ❗❗ Breaking changes when updating to v6.x.x❗❗
+- From version `6.16.2`, `AppsFlyerConsent.forGDPRUser` and `AppsFlyerConsent.forNonGDPRUser` have been **deprecated**. Use the new `AppsFlyerConsent` constructor instead. See [Deprecation Notice](/Docs/RN_CMP.md#deprecation-notice).
 
 - From version `6.15.1`, upgraded to targetSDKVersion 34, Java 17, and Gradle 8.7 in [AppsFlyer Android SDK v6.15.1](https://support.appsflyer.com/hc/en-us/articles/115001256006-AppsFlyer-Android-SDK-release-notes).
 

android/.project

@@ -5,19 +5,13 @@
 	<projects>
 	</projects>
 	<buildSpec>
-		<buildCommand>
-			<name>org.eclipse.jdt.core.javabuilder</name>
-			<arguments>
-			</arguments>
-		</buildCommand>
 		<buildCommand>
 			<name>org.eclipse.buildship.core.gradleprojectbuilder</name>
 			<arguments>
 			</arguments>
 		</buildCommand>
 	</buildSpec>
 	<natures>
-		<nature>org.eclipse.jdt.core.javanature</nature>
 		<nature>org.eclipse.buildship.core.gradleprojectnature</nature>
 	</natures>
 	<filteredResources>

android/build.gradle

@@ -20,11 +20,12 @@ buildscript {
 apply plugin: 'com.android.library'
 
 android {
+    namespace "com.appsflyer.reactnative"
     compileSdkVersion safeExtGet('compileSdkVersion', 34)
     buildToolsVersion safeExtGet('buildToolsVersion', '34.0.0')
 
     defaultConfig {
-        minSdkVersion safeExtGet('minSdkVersion', 16)
+        minSdkVersion safeExtGet('minSdkVersion', 21)
         targetSdkVersion safeExtGet('targetSdkVersion', 34)
         versionCode 1
         versionName "1.0"
@@ -54,5 +55,5 @@ repositories {
 dependencies {
     implementation "com.facebook.react:react-native:${safeExtGet('reactNativeVersion', '+')}"
     implementation "com.android.installreferrer:installreferrer:${safeExtGet('installReferrerVersion', '2.1')}"
-    api "com.appsflyer:af-android-sdk:${safeExtGet('appsflyerVersion', '6.15.2')}"
+    api "com.appsflyer:af-android-sdk:${safeExtGet('appsflyerVersion', '6.16.2')}"
 }

android/src/main/java/com/appsflyer/reactnative/RNAppsFlyerConstants.java

@@ -6,7 +6,7 @@
 
 public class RNAppsFlyerConstants {
 
-    final static String PLUGIN_VERSION = "6.15.3";
+    final static String PLUGIN_VERSION = "6.16.2";
     final static String NO_DEVKEY_FOUND = "No 'devKey' found or its empty";
     final static String UNKNOWN_ERROR = "AF Unknown Error";
     final static String SUCCESS = "Success";

android/src/main/java/com/appsflyer/reactnative/RNAppsFlyerModule.java

@@ -8,6 +8,7 @@
 import android.os.Bundle;
 
 import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
 
 import android.util.Log;
 
@@ -876,17 +877,41 @@ public void enableTCFDataCollection(Boolean enabled) {
     }
 
     @ReactMethod
-    public void setConsentData(ReadableMap consentData) {
+    public void setConsentData(@Nullable ReadableMap consentData) {
+        if (consentData == null) {
+            Log.e("AppsFlyer", "consentData is null");
+            return;
+        }
+
         JSONObject JSONConsentData = RNUtil.readableMapToJson(consentData);
-        boolean isUserSubjectToGDPR = JSONConsentData.optBoolean("isUserSubjectToGDPR");
-        boolean hasConsentForDataUsage = JSONConsentData.optBoolean("hasConsentForDataUsage");
-        boolean hasConsentForAdsPersonalization = JSONConsentData.optBoolean("hasConsentForAdsPersonalization");
-        AppsFlyerConsent consentObject;
-        if (isUserSubjectToGDPR) {
-            consentObject = AppsFlyerConsent.forGDPRUser(hasConsentForDataUsage, hasConsentForAdsPersonalization);
-        } else {
-            consentObject = AppsFlyerConsent.forNonGDPRUser();
+        if (JSONConsentData == null) {
+            Log.e("AppsFlyer", "Failed to convert consentData to JSON");
+            return;
         }
+
+        Boolean isUserSubjectToGDPR = JSONConsentData.has("isUserSubjectToGDPR") && !JSONConsentData.isNull("isUserSubjectToGDPR")
+                ? JSONConsentData.optBoolean("isUserSubjectToGDPR")
+                : null;
+
+        Boolean hasConsentForDataUsage = JSONConsentData.has("hasConsentForDataUsage") && !JSONConsentData.isNull("hasConsentForDataUsage")
+                ? JSONConsentData.optBoolean("hasConsentForDataUsage")
+                : null;
+
+        Boolean hasConsentForAdsPersonalization = JSONConsentData.has("hasConsentForAdsPersonalization") && !JSONConsentData.isNull("hasConsentForAdsPersonalization")
+                ? JSONConsentData.optBoolean("hasConsentForAdsPersonalization")
+                : null;
+
+        Boolean hasConsentForAdStorage = JSONConsentData.has("hasConsentForAdStorage") && !JSONConsentData.isNull("hasConsentForAdStorage")
+                ? JSONConsentData.optBoolean("hasConsentForAdStorage")
+                : null;
+
+        AppsFlyerConsent consentObject = new AppsFlyerConsent(
+                isUserSubjectToGDPR,
+                hasConsentForDataUsage,
+                hasConsentForAdsPersonalization,
+                hasConsentForAdStorage
+        );
+
         AppsFlyerLib.getInstance().setConsentData(consentObject);
     }
 

babel.config.js

@@ -0,0 +1,4 @@
+// babel.config.js
+module.exports = {
+    presets: ['module:metro-react-native-babel-preset'],
+  };