cordova-plugin-admob-nextgen 1.9.9 → 2.0.0

package/README.md

@@ -147,6 +147,7 @@ Add this to your `config.xml` to restore the plugin automatically.
 
 ### Supporting Mediation: **[⚡ admob-mediation-suite ](https://github.com/swaplab-engine/admob-mediation-suite)** (Optional)
 ### Supporting Native ads: **[⚡ cordova-plugin-admob-nextgen-native ](https://github.com/swaplab-engine/cordova-plugin-admob-nextgen-native)** (Optional)
+### New COPPA : **[⚡ cordova-plugin-play-age-signals ](https://github.com/swaplab-engine/cordova-plugin-play-age-signals)** (Optional)
 
 ---
 
@@ -163,13 +164,11 @@ Add this to your `config.xml` to restore the plugin automatically.
 
 **IMPORTANT:** Configure Global Settings and handle Privacy Consent (UMP) **BEFORE** initializing the SDK.
 
-### Step 1: Global Configuration (Run First)
-
     // Optional: Mute ads globally
     admobNextGen.setAppVolume(0.5);
     admobNextGen.setAppMuted(true);
 
-### Step 2: Request Consent (UMP) & Initialize
+### Step 1: Request Consent (UMP) & Initialize
 
     // 1. Request Consent Information
     admobNextGen.requestConsentInfo({
@@ -214,7 +213,7 @@ Add this to your `config.xml` to restore the plugin automatically.
     }
 
 
-    // 4. Privacy options
+       // 4. Privacy options
         admobNextGen.showPrivacyOptionsForm(function() {
             startSdk();
         }, function(err) {
@@ -247,19 +246,81 @@ function checkAppTracking() {
 // admobNextGen.getTrackingAuthorizationStatus(success, error);
 ```   
 
-### Step 3: Check Consent Status (Smart Analysis)
-You can check if the user has granted permission for Personalized Ads without parsing complex IAB strings manually.
+### Step 2: Check Consent Status (Smart Analysis)
+- Understanding Consent Flags (`getTCData`)
 
-    admobNextGen.getTCData(function(data) {
-        // --- SMART ANALYSIS (Easy) ---
-        console.log("Personalized Allowed: " + data.isPersonalizedAllowed); // Boolean: true/false
-        console.log("Status: " + data.statusMessage);
+*(See [Publisher integration with the IAB Europe TCF](https://support.google.com/admanager/answer/9805023?hl=en#consent-policies))*
+> 
 
-        // --- RAW DATA (Expert) ---
-        console.log("TC String: " + data.tcString);
-        console.log("GDPR Applies: " + data.gdprApplies); // 1=Yes, 0=No
-        console.log("Purpose Consents: " + data.purposeConsents);
-    });
+When you call `admobNextGen.getTCData()`, the plugin returns a JSON object containing raw IAB TCF strings alongside pre-calculated boolean flags. To comply with AdMob's strict policies in GDPR regions, This plugin provide specific AdMob flags alongside the legacy flag.
+
+| Flag | Description | GDPR Requirements Checked |
+| :--- | :--- | :--- |
+| `isAdMobPersonalizedAdsAllowed` | **(Recommended)** Returns `true` if the user has granted all necessary consents for AdMob to serve **Personalized Ads**. | Consent for Purposes 1, 3, 4 **AND** (Consent or Legitimate Interest) for Purposes 2, 7, 9, 10 **AND** Vendor 755 (Google). |
+| `isAdMobNonPersonalizedAdsAllowed` | **(Recommended)** Returns `true` if the user has granted the minimum consent required for AdMob to serve **Non-Personalized Ads**. | Consent for Purpose 1 **AND** (Consent or Legitimate Interest) for Purposes 2, 7, 9, 10 **AND** Vendor 755 (Google). |
+| `isPersonalizedAllowed` | **(Legacy)** Preserved for backward compatibility with older app versions. **Not recommended for strict AdMob policy compliance.** | Consent for Purpose 1 only. |
+
+> **Note:** If the user is outside the GDPR region (e.g., USA, Indonesia), all of the ready-to-use flags above will return `true` by default.
+
+### A: Standard Usage (Ready-to-use Flags)
+For most users, relying on the built-in boolean flags is the easiest way to ensure AdMob compliance without parsing complex strings.
+
+```javascript
+// Request TC Data
+admobNextGen.getTCData(function(tcData) {
+
+    
+    console.log(tcData.adMobConsentStatus);
+    
+    if (tcData.isAdMobPersonalizedAdsAllowed) {
+        console.log("Consent met: AdMob can serve Personalized Ads.");
+        // Proceed to load ads...
+    } 
+    else if (tcData.isAdMobNonPersonalizedAdsAllowed) {
+        console.log("Consent met: AdMob will serve Non-Personalized Ads (Limited Ads).");
+        // Proceed to load ads...
+    } 
+    else {
+        console.log("Consent insufficient: AdMob cannot serve any ads.");
+        // You might want to show the privacy options form again here
+    }
+
+});
+```
+
+#### B: Advanced Usage (Raw Data Control)
+Advanced users who want full control over the consent logic can completely ignore the built-in boolean flags. The plugin exposes the raw IAB TCF data directly from the device's local storage (`purposeConsents`, `purposeLegitimateInterests`, `vendorConsents`, etc.), allowing you to manipulate and build custom conditions based on your own specific requirements.
+
+```javascript
+admobNextGen.getTCData(function(tcData) {
+    
+    // Ignore the built-in flags and parse the raw data yourself.
+    // Note: IAB TCF strings are 1-indexed, but JavaScript strings are 0-indexed.
+    // Index 0 represents Purpose 1, Index 2 represents Purpose 3, etc.
+    
+    const purposes = tcData.purposeConsents || "";
+    const lis = tcData.purposeLegitimateInterests || "";
+    const vendors = tcData.vendorConsents || "";
+
+    // const tcs = tcData.tcString;
+    // const region = tcData.gdprApplies;
+    
+    // Custom logic example: Check if Purpose 1 and Purpose 3 are explicitly granted
+    const hasPurpose1 = purposes.charAt(0) === '1';
+    const hasPurpose3 = purposes.charAt(2) === '1';
+    
+    // Check if Vendor 755 (Google) is granted (Index 754)
+    const hasGoogleVendor = vendors.charAt(754) === '1';
+    
+    if (hasPurpose1 && hasPurpose3 && hasGoogleVendor) {
+        console.log("Custom advanced condition met!");
+        // Your custom ad loading logic here
+    } else {
+        console.log("Custom advanced condition failed.");
+    }
+
+});
+```
 
 ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cordova-plugin-admob-nextgen",
-  "version": "1.9.9",
+  "version": "2.0.0",
   "description": "Google Mobile Ads Next Gen SDK for Cordova. High performance and modular architecture. ",
   "cordova": {
     "id": "cordova-plugin-admob-nextgen",

package/plugin.xml

@@ -1,6 +1,6 @@
 <?xml version='1.0' encoding='utf-8'?>
 <plugin id="cordova-plugin-admob-nextgen" 
-        version="1.9.9" 
+        version="2.0.0" 
         xmlns="http://apache.org/cordova/ns/plugins/1.0" 
         xmlns:android="http://schemas.android.com/apk/res/android">
 

package/src/android/ConsentExecutor.java

@@ -130,41 +130,79 @@ public class ConsentExecutor {
 
             String tcString = prefs.getString("IABTCF_TCString", "");
             String purposeConsents = prefs.getString("IABTCF_PurposeConsents", "");
+            String purposeLegitimateInterests = prefs.getString("IABTCF_PurposeLegitimateInterests", ""); 
             String vendorConsents = prefs.getString("IABTCF_VendorConsents", "");
             int gdprApplies = prefs.getInt("IABTCF_gdprApplies", 0);
 
             tcData.put("tcString", tcString);
             tcData.put("purposeConsents", purposeConsents);
+            tcData.put("purposeLegitimateInterests", purposeLegitimateInterests); 
             tcData.put("vendorConsents", vendorConsents);
             tcData.put("gdprApplies", gdprApplies);
 
             boolean isPersonalizedAllowed = false;
             String statusMessage = "Unknown";
 
+            boolean isAdMobPersonalizedAdsAllowed = false;
+            boolean isAdMobNonPersonalizedAdsAllowed = false;
+            String adMobConsentStatus = "Unknown";
+
             if (gdprApplies == 0) {
 
                 isPersonalizedAllowed = true;
                 statusMessage = "Not GDPR region. Personalized Ads allowed by default.";
+
+                isAdMobPersonalizedAdsAllowed = true;
+                isAdMobNonPersonalizedAdsAllowed = true;
+                adMobConsentStatus = "Not GDPR region. AdMob ads allowed by default.";
             } else {
 
                 if (purposeConsents != null && purposeConsents.length() > 0) {
                     char p1 = purposeConsents.charAt(0);
                     if (p1 == '1') {
                         isPersonalizedAllowed = true;
-                        statusMessage = "Purpose 1 Granted. Personalized Ads allowed.";
+                        statusMessage = "Purpose 1 Granted. Legacy check passed.";
                     } else {
                         isPersonalizedAllowed = false;
-                        statusMessage = "Purpose 1 Denied. Non-Personalized / Limited Ads only.";
+                        statusMessage = "Purpose 1 Denied. Legacy check failed.";
                     }
-                } else {
+                }
+
+                boolean hasPurpose1 = checkConsent(purposeConsents, 1);
+                boolean hasPurpose3 = checkConsent(purposeConsents, 3);
+                boolean hasPurpose4 = checkConsent(purposeConsents, 4);
 
-                    isPersonalizedAllowed = false;
-                    statusMessage = "No consent data found (User hasn't answered yet).";
+                boolean hasRequiredLI_or_Consent = 
+                    hasConsentOrLI(purposeConsents, purposeLegitimateInterests, 2) &&
+                    hasConsentOrLI(purposeConsents, purposeLegitimateInterests, 7) &&
+                    hasConsentOrLI(purposeConsents, purposeLegitimateInterests, 9) &&
+                    hasConsentOrLI(purposeConsents, purposeLegitimateInterests, 10);
+
+                boolean hasVendorGoogle = checkConsent(vendorConsents, 755); 
+
+                if (hasPurpose1 && hasVendorGoogle && hasRequiredLI_or_Consent) {
+                    isAdMobNonPersonalizedAdsAllowed = true;
+
+                    if (hasPurpose3 && hasPurpose4) {
+                        isAdMobPersonalizedAdsAllowed = true;
+                        adMobConsentStatus = "Strict requirements met for Personalized Ads (Purposes 1,3,4 + LI 2,7,9,10 + Vendor 755).";
+                    } else {
+                        isAdMobPersonalizedAdsAllowed = false;
+                        adMobConsentStatus = "Requirements met for Non-Personalized Ads only.";
+                    }
+                } else {
+                    isAdMobPersonalizedAdsAllowed = false;
+                    isAdMobNonPersonalizedAdsAllowed = false;
+                    adMobConsentStatus = "Insufficient strict consent (Missing P1, Vendor 755, or P2,7,9,10). Limited Ads only.";
                 }
             }
 
-            tcData.put("isPersonalizedAllowed", isPersonalizedAllowed); 
-            tcData.put("statusMessage", statusMessage); 
+            tcData.put("isPersonalizedAllowed", isPersonalizedAllowed);
+            tcData.put("statusMessage", statusMessage);
+
+            tcData.put("isAdMobPersonalizedAdsAllowed", isAdMobPersonalizedAdsAllowed);
+            tcData.put("isAdMobNonPersonalizedAdsAllowed", isAdMobNonPersonalizedAdsAllowed);
+            tcData.put("adMobConsentStatus", adMobConsentStatus);
 
             callbackContext.success(tcData);
         } catch (Exception e) {
@@ -172,6 +210,19 @@ public class ConsentExecutor {
         }
     }
 
+    private boolean checkConsent(String consentString, int id) {
+        if (consentString == null || consentString.length() < id) {
+            return false;
+        }
+        return consentString.charAt(id - 1) == '1';
+    }
+
+    private boolean hasConsentOrLI(String consents, String lis, int id) {
+        boolean hasConsent = checkConsent(consents, id);
+        boolean hasLI = checkConsent(lis, id);
+        return hasConsent || hasLI;
+    }
+
     private String getDeviceId() {
         try {
             Context context = cordova.getActivity();

package/src/ios/ConsentExecutor.m

@@ -100,12 +100,14 @@
 
             NSString *tcString = [prefs stringForKey:@"IABTCF_TCString"] ?: @"";
             NSString *purposeConsents = [prefs stringForKey:@"IABTCF_PurposeConsents"] ?: @"";
+            NSString *purposeLegitimateInterests = [prefs stringForKey:@"IABTCF_PurposeLegitimateInterests"] ?: @""; 
             NSString *vendorConsents = [prefs stringForKey:@"IABTCF_VendorConsents"] ?: @"";
             NSString *additionalConsent = [prefs stringForKey:@"IABTCF_AddtlConsent"] ?: @"";
-            NSInteger gdprApplies = [prefs integerForKey:@"IABTCF_gdprApplies"]; 
+            NSInteger gdprApplies = [prefs integerForKey:@"IABTCF_gdprApplies"];
 
             tcData[@"tcString"] = tcString;
             tcData[@"purposeConsents"] = purposeConsents;
+            tcData[@"purposeLegitimateInterests"] = purposeLegitimateInterests; 
             tcData[@"vendorConsents"] = vendorConsents;
             tcData[@"additionalConsent"] = additionalConsent;
             tcData[@"gdprApplies"] = @(gdprApplies);
@@ -113,24 +115,55 @@
             BOOL isPersonalizedAllowed = NO;
             NSString *statusMessage = @"Unknown";
 
-            if (gdprApplies == 0) {
+            BOOL isAdMobPersonalizedAdsAllowed = NO;
+            BOOL isAdMobNonPersonalizedAdsAllowed = NO;
+            NSString *adMobConsentStatus = @"Unknown";
 
+            if (gdprApplies == 0) {
                 isPersonalizedAllowed = YES;
                 statusMessage = @"Not GDPR region. Personalized Ads allowed by default.";
+
+                isAdMobPersonalizedAdsAllowed = YES;
+                isAdMobNonPersonalizedAdsAllowed = YES;
+                adMobConsentStatus = @"Not GDPR region. AdMob ads allowed by default.";
             } else {
 
                 if (purposeConsents.length > 0) {
-
                     if ([purposeConsents hasPrefix:@"1"]) {
                         isPersonalizedAllowed = YES;
-                        statusMessage = @"Purpose 1 Granted. Personalized Ads allowed.";
+                        statusMessage = @"Purpose 1 Granted. Legacy check passed.";
                     } else {
                         isPersonalizedAllowed = NO;
-                        statusMessage = @"Purpose 1 Denied. Non-Personalized / Limited Ads only.";
+                        statusMessage = @"Purpose 1 Denied. Legacy check failed.";
+                    }
+                }
+
+                BOOL hasPurpose1 = [self checkConsent:purposeConsents consentId:1];
+                BOOL hasPurpose3 = [self checkConsent:purposeConsents consentId:3];
+                BOOL hasPurpose4 = [self checkConsent:purposeConsents consentId:4];
+
+                BOOL hasRequiredLI_or_Consent = 
+                    [self hasConsentOrLI:purposeConsents lis:purposeLegitimateInterests consentId:2] &&
+                    [self hasConsentOrLI:purposeConsents lis:purposeLegitimateInterests consentId:7] &&
+                    [self hasConsentOrLI:purposeConsents lis:purposeLegitimateInterests consentId:9] &&
+                    [self hasConsentOrLI:purposeConsents lis:purposeLegitimateInterests consentId:10];
+
+                BOOL hasVendorGoogle = [self checkConsent:vendorConsents consentId:755];
+
+                if (hasPurpose1 && hasVendorGoogle && hasRequiredLI_or_Consent) {
+                    isAdMobNonPersonalizedAdsAllowed = YES;
+
+                    if (hasPurpose3 && hasPurpose4) {
+                        isAdMobPersonalizedAdsAllowed = YES;
+                        adMobConsentStatus = @"Strict requirements met for Personalized Ads (Purposes 1,3,4 + LI 2,7,9,10 + Vendor 755).";
+                    } else {
+                        isAdMobPersonalizedAdsAllowed = NO;
+                        adMobConsentStatus = @"Requirements met for Non-Personalized Ads only.";
                     }
                 } else {
-                    isPersonalizedAllowed = NO;
-                    statusMessage = @"No consent data found (User hasn't answered yet).";
+                    isAdMobPersonalizedAdsAllowed = NO;
+                    isAdMobNonPersonalizedAdsAllowed = NO;
+                    adMobConsentStatus = @"Insufficient strict consent (Missing P1, Vendor 755, or P2,7,9,10). Limited Ads only.";
                 }
             }
 
@@ -143,6 +176,10 @@
             tcData[@"statusMessage"] = statusMessage;
             tcData[@"isACVersion2"] = @(isACVersion2);
 
+            tcData[@"isAdMobPersonalizedAdsAllowed"] = @(isAdMobPersonalizedAdsAllowed);
+            tcData[@"isAdMobNonPersonalizedAdsAllowed"] = @(isAdMobNonPersonalizedAdsAllowed);
+            tcData[@"adMobConsentStatus"] = adMobConsentStatus;
+
             if (command) {
                 CDVPluginResult* res = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsDictionary:tcData];
                 [self.plugin.commandDelegate sendPluginResult:res callbackId:command.callbackId];
@@ -156,6 +193,20 @@
     });
 }
 
+- (BOOL)checkConsent:(NSString *)consentString consentId:(NSInteger)consentId {
+    if (!consentString || consentString.length < consentId) {
+        return NO;
+    }
+    unichar c = [consentString characterAtIndex:(consentId - 1)];
+    return c == '1';
+}
+
+- (BOOL)hasConsentOrLI:(NSString *)consents lis:(NSString *)lis consentId:(NSInteger)consentId {
+    BOOL hasConsent = [self checkConsent:consents consentId:consentId];
+    BOOL hasLI = [self checkConsent:lis consentId:consentId];
+    return hasConsent || hasLI;
+}
+
 - (void)showPrivacyOptionsForm:(CDVInvokedUrlCommand *)command {
     dispatch_async(dispatch_get_main_queue(), ^{
         [UMPConsentForm presentPrivacyOptionsFormFromViewController:self.plugin.viewController completionHandler:^(NSError * _Nullable formError) {