@ququplay/admob 5.3.1

package/android/src/main/java/com/getcapacitor/community/admob/consent/AdConsentExecutor.java

@@ -0,0 +1,232 @@
+package com.getcapacitor.community.admob.consent;
+
+import android.app.Activity;
+import android.content.Context;
+import android.content.SharedPreferences;
+import android.preference.PreferenceManager;
+import android.util.Log;
+
+import androidx.core.util.Supplier;
+import com.getcapacitor.JSArray;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.community.admob.models.Executor;
+import com.google.android.gms.common.util.BiConsumer;
+import com.google.android.ump.ConsentDebugSettings;
+import com.google.android.ump.ConsentForm;
+import com.google.android.ump.ConsentInformation;
+import com.google.android.ump.ConsentRequestParameters;
+import com.google.android.ump.FormError;
+import com.google.android.ump.UserMessagingPlatform;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class AdConsentExecutor extends Executor {
+
+    private ConsentInformation consentInformation;
+
+    public AdConsentExecutor(
+        Supplier<Context> contextSupplier,
+        Supplier<Activity> activitySupplier,
+        BiConsumer<String, JSObject> notifyListenersFunction,
+        String pluginLogTag
+    ) {
+        super(contextSupplier, activitySupplier, notifyListenersFunction, pluginLogTag, "AdConsentExecutor");
+    }
+
+    public boolean canShowPersonalizedAds(){
+        Context context = contextSupplier.get();
+        SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(context.getApplicationContext());
+        String purposeConsent = prefs.getString("IABTCF_PurposeConsents", "");
+        String vendorConsent = prefs.getString("IABTCF_VendorConsents","");
+        String vendorLI = prefs.getString("IABTCF_VendorLegitimateInterests","");
+        String purposeLI = prefs.getString("IABTCF_PurposeLegitimateInterests","");
+
+        int googleId = 755;
+        boolean hasGoogleVendorConsent = hasAttribute(vendorConsent, googleId);
+        boolean hasGoogleVendorLI = hasAttribute(vendorLI, googleId);
+
+        List<Integer> indexes = new ArrayList<>();
+        indexes.add(1);
+        indexes.add(3);
+        indexes.add(4);
+
+        List<Integer> indexesLI = new ArrayList<>();
+        indexesLI.add(2);
+        indexesLI.add(7);
+        indexesLI.add(9);
+        indexesLI.add(10);
+
+        return hasConsentFor(indexes, purposeConsent, hasGoogleVendorConsent)
+                && hasConsentOrLegitimateInterestFor(indexesLI, purposeConsent, purposeLI, hasGoogleVendorConsent, hasGoogleVendorLI);
+
+    }
+    public boolean canShowAds(){
+        Context context = contextSupplier.get();
+        SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(context.getApplicationContext());
+        String purposeConsent = prefs.getString("IABTCF_PurposeConsents", "");
+        String vendorConsent = prefs.getString("IABTCF_VendorConsents","");
+        String vendorLI = prefs.getString("IABTCF_VendorLegitimateInterests","");
+        String purposeLI = prefs.getString("IABTCF_PurposeLegitimateInterests","");
+
+        int googleId = 755;
+        boolean hasGoogleVendorConsent = hasAttribute(vendorConsent, googleId);
+        boolean hasGoogleVendorLI = hasAttribute(vendorLI, googleId);
+
+        List<Integer> indexes = new ArrayList<>();
+        indexes.add(1);
+
+        List<Integer> indexesLI = new ArrayList<>();
+        indexesLI.add(2);
+        indexesLI.add(7);
+        indexesLI.add(9);
+        indexesLI.add(10);
+
+        return hasConsentFor(indexes, purposeConsent, hasGoogleVendorConsent)
+                && hasConsentOrLegitimateInterestFor(indexesLI, purposeConsent, purposeLI, hasGoogleVendorConsent, hasGoogleVendorLI);
+
+    }
+
+    @PluginMethod
+    public void requestConsentInfo(final PluginCall call, BiConsumer<String, JSObject> notifyListenersFunction) {
+        try {
+            ensureConsentInfo();
+
+            ConsentRequestParameters.Builder paramsBuilder = new ConsentRequestParameters.Builder();
+            ConsentDebugSettings.Builder debugSettingsBuilder = new ConsentDebugSettings.Builder(contextSupplier.get());
+
+            if (call.getData().has("testDeviceIdentifiers")) {
+                JSArray devices = call.getArray("testDeviceIdentifiers");
+
+                for (int i = 0; i < devices.length(); i++) {
+                    debugSettingsBuilder.addTestDeviceHashedId(devices.getString(i));
+                }
+            }
+
+            if (call.getData().has("debugGeography")) {
+                debugSettingsBuilder.setDebugGeography(call.getInt("debugGeography"));
+            }
+
+            paramsBuilder.setConsentDebugSettings(debugSettingsBuilder.build());
+
+            if (call.getData().has("tagForUnderAgeOfConsent")) {
+                paramsBuilder.setTagForUnderAgeOfConsent(call.getBoolean("tagForUnderAgeOfConsent"));
+            }
+
+            ConsentRequestParameters consentRequestParameters = paramsBuilder.build();
+
+            if (activitySupplier.get() == null) {
+                call.reject("Trying to request consent info but the Activity is null");
+                return;
+            }
+
+            consentInformation.requestConsentInfoUpdate(
+                activitySupplier.get(),
+                consentRequestParameters,
+                () -> {
+                    JSObject consentInfo = new JSObject();
+                    consentInfo.put("status", getConsentStatusString(consentInformation.getConsentStatus()));
+                    consentInfo.put("isConsentFormAvailable", consentInformation.isConsentFormAvailable());
+                    consentInfo.put("canShowAds", canShowAds());
+                    consentInfo.put("canShowPersonalizedAds", canShowPersonalizedAds());
+                    call.resolve(consentInfo);
+                },
+                formError -> call.reject(formError.getMessage())
+            );
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage(), ex);
+        }
+    }
+
+    @PluginMethod
+    public void showConsentForm(final PluginCall call, BiConsumer<String, JSObject> notifyListenersFunction) {
+        try {
+            if (activitySupplier.get() == null) {
+                call.reject("Trying to show the consent form but the Activity is null");
+                return;
+            }
+            ensureConsentInfo();
+            activitySupplier
+                .get()
+                .runOnUiThread(
+                    () ->
+                        UserMessagingPlatform.loadConsentForm(
+                            contextSupplier.get(),
+                            consentForm ->
+                                consentForm.show(
+                                    activitySupplier.get(),
+                                    formError -> {
+                                        if (formError != null) {
+                                            call.reject("Error when show consent form", formError.getMessage());
+                                        } else {
+                                            JSObject consentFormInfo = new JSObject();
+                                            consentFormInfo.put("status", getConsentStatusString(consentInformation.getConsentStatus()));
+                                            consentFormInfo.put("canShowAds", canShowAds());
+                                            consentFormInfo.put("canShowPersonalizedAds", canShowPersonalizedAds());
+                                            call.resolve(consentFormInfo);
+                                        }
+                                    }
+                                ),
+                            formError -> call.reject("Error when show consent form", formError.getMessage())
+                        )
+                );
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage(), ex);
+        }
+    }
+
+    @PluginMethod
+    public void resetConsentInfo(final PluginCall call, BiConsumer<String, JSObject> notifyListenersFunction) {
+        ensureConsentInfo();
+        consentInformation.reset();
+        call.resolve();
+    }
+
+    private String getConsentStatusString(int consentConstant) {
+        switch (consentConstant) {
+            case ConsentInformation.ConsentStatus.REQUIRED:
+                return "REQUIRED";
+            case ConsentInformation.ConsentStatus.NOT_REQUIRED:
+                return "NOT_REQUIRED";
+            case ConsentInformation.ConsentStatus.OBTAINED:
+                return "OBTAINED";
+            case ConsentInformation.ConsentStatus.UNKNOWN:
+            default:
+                return "UNKNOWN";
+        }
+    }
+
+    private void ensureConsentInfo() {
+        if (consentInformation == null) {
+            consentInformation = UserMessagingPlatform.getConsentInformation(contextSupplier.get());
+        }
+    }
+
+    private boolean hasAttribute(String input, int index) {
+        if (input == null) return false;
+        return input.length() >= index && input.charAt(index-1) == '1';
+    }
+
+    private boolean hasConsentFor(List<Integer> indexes, String purposeConsent, boolean hasVendorConsent) {
+        for (Integer p: indexes) {
+            if (!hasAttribute(purposeConsent, p)) {
+                return false;
+            }
+        }
+        return hasVendorConsent;
+    }
+
+    private boolean hasConsentOrLegitimateInterestFor(List<Integer> indexes, String purposeConsent, String purposeLI, boolean hasVendorConsent, boolean hasVendorLI){
+        for (Integer p: indexes) {
+            boolean purposeAndVendorLI = hasAttribute(purposeLI, p) && hasVendorLI;
+            boolean purposeConsentAndVendorConsent = hasAttribute(purposeConsent, p) && hasVendorConsent;
+            boolean isOk = purposeAndVendorLI || purposeConsentAndVendorConsent;
+            if (!isOk){
+                return false;
+            }
+        }
+        return true;
+    }
+}

package/android/src/main/java/com/getcapacitor/community/admob/helpers/AdViewIdHelper.java

@@ -0,0 +1,31 @@
+package com.getcapacitor.community.admob.helpers;
+
+import android.content.Context;
+import android.util.Log;
+import com.getcapacitor.community.admob.models.AdOptions;
+import com.google.android.gms.ads.AdRequest;
+import com.google.android.gms.ads.AdView;
+
+public final class AdViewIdHelper {
+
+    private AdViewIdHelper() {}
+
+    public static String getFinalAdId(AdOptions adOptions, AdRequest adRequest, String logTag, Context context) {
+        if (!adOptions.isTesting) {
+            return adOptions.adId;
+        }
+
+        if (adRequest.isTestDevice(context)) {
+            Log.w(logTag, "This device is registered as Testing Device. The real Ad Id will be used");
+            return adOptions.adId;
+        }
+
+        return adOptions.getTestingId();
+    }
+
+    public static void assignIdToAdView(AdView adView, AdOptions adOptions, AdRequest adRequest, String logTag, Context context) {
+        String finalId = getFinalAdId(adOptions, adRequest, logTag, context);
+        adView.setAdUnitId(finalId);
+        Log.d(logTag, "Ad ID: " + finalId);
+    }
+}

package/android/src/main/java/com/getcapacitor/community/admob/helpers/AuthorizationStatusEnum.kt

@@ -0,0 +1,5 @@
+package com.getcapacitor.community.admob.helpers
+
+enum class AuthorizationStatusEnum(val status: String) {
+    AUTHORIZED("authorized");
+}

package/android/src/main/java/com/getcapacitor/community/admob/helpers/FullscreenPluginCallback.kt

@@ -0,0 +1,27 @@
+package com.getcapacitor.community.admob.helpers
+
+import com.getcapacitor.JSObject
+import com.getcapacitor.community.admob.models.AdMobPluginError
+import com.getcapacitor.community.admob.models.LoadPluginEventNames
+import com.google.android.gms.ads.AdError
+import com.google.android.gms.ads.FullScreenContentCallback
+import com.google.android.gms.common.util.BiConsumer
+
+class FullscreenPluginCallback(private val loadPluginObject: LoadPluginEventNames,
+                               private val notifyListenersFunction: BiConsumer<String, JSObject>): FullScreenContentCallback() {
+
+    override fun onAdShowedFullScreenContent() {
+        notifyListenersFunction.accept(loadPluginObject.Showed, JSObject())
+    }
+
+    override fun onAdFailedToShowFullScreenContent(adError: AdError) {
+        val adMobError = AdMobPluginError(adError)
+        notifyListenersFunction.accept(
+                loadPluginObject.FailedToShow, adMobError
+        )
+    }
+
+    override fun onAdDismissedFullScreenContent() {
+        notifyListenersFunction.accept(loadPluginObject.Dismissed, JSObject())
+    }
+}

package/android/src/main/java/com/getcapacitor/community/admob/helpers/RequestHelper.java

@@ -0,0 +1,49 @@
+package com.getcapacitor.community.admob.helpers;
+
+import android.os.Bundle;
+import com.getcapacitor.community.admob.models.AdOptions;
+import com.google.ads.mediation.admob.AdMobAdapter;
+import com.google.android.gms.ads.AdRequest;
+
+public final class RequestHelper {
+
+    private RequestHelper() {}
+
+    /**
+     * Use this function to create all requests, here we can centralize request extras
+     * @param adOptions
+     * @return
+     */
+    public static AdRequest createRequest(AdOptions adOptions) {
+        AdRequest.Builder adRequestBuilder = new AdRequest.Builder();
+
+        // TODO: Allow more key/value extras?
+        if (adOptions.npa) {
+            Bundle extras = new Bundle();
+            extras.putString("npa", "1");
+            adRequestBuilder.addNetworkExtrasBundle(AdMobAdapter.class, extras);
+        }
+
+        return adRequestBuilder.build();
+    }
+
+    /**
+     * Gets a string error reason from an error code.
+     */
+    public static String getRequestErrorReason(int errorCode) {
+        switch (errorCode) {
+            case AdRequest.ERROR_CODE_INTERNAL_ERROR:
+                return "Internal error";
+            case AdRequest.ERROR_CODE_INVALID_REQUEST:
+                return "Invalid request";
+            case AdRequest.ERROR_CODE_NETWORK_ERROR:
+                return "Network Error";
+            case AdRequest.ERROR_CODE_NO_FILL:
+                return "No fill";
+            case AdRequest.ERROR_CODE_APP_ID_MISSING:
+                return "App Id Missing";
+            default:
+                return "Unknown error";
+        }
+    }
+}

package/android/src/main/java/com/getcapacitor/community/admob/interstitial/AdInterstitialExecutor.java

@@ -0,0 +1,80 @@
+package com.getcapacitor.community.admob.interstitial;
+
+import android.app.Activity;
+import android.content.Context;
+import androidx.core.util.Supplier;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.community.admob.helpers.AdViewIdHelper;
+import com.getcapacitor.community.admob.helpers.RequestHelper;
+import com.getcapacitor.community.admob.models.AdMobPluginError;
+import com.getcapacitor.community.admob.models.AdOptions;
+import com.getcapacitor.community.admob.models.Executor;
+import com.google.android.gms.ads.AdRequest;
+import com.google.android.gms.ads.interstitial.InterstitialAd;
+import com.google.android.gms.common.util.BiConsumer;
+
+public class AdInterstitialExecutor extends Executor {
+
+    public static InterstitialAd interstitialAd;
+
+    InterstitialAdCallbackAndListeners adCallbackAndListeners;
+
+    public AdInterstitialExecutor(
+        Supplier<Context> contextSupplier,
+        Supplier<Activity> activitySupplier,
+        BiConsumer<String, JSObject> notifyListenersFunction,
+        String pluginLogTag,
+        InterstitialAdCallbackAndListeners adCallbackAndListeners
+    ) {
+        super(contextSupplier, activitySupplier, notifyListenersFunction, pluginLogTag, "AdRewardExecutor");
+        this.adCallbackAndListeners = adCallbackAndListeners;
+    }
+
+    public void prepareInterstitial(final PluginCall call, BiConsumer<String, JSObject> notifyListenersFunction) {
+        final AdOptions.AdOptionsFactory factory = AdOptions.getFactory();
+        final AdOptions adOptions = factory.createInterstitialOptions(call);
+
+        try {
+            activitySupplier
+                .get()
+                .runOnUiThread(
+                    () -> {
+                        final AdRequest adRequest = RequestHelper.createRequest(adOptions);
+                        final String id = AdViewIdHelper.getFinalAdId(adOptions, adRequest, logTag, contextSupplier.get());
+                        InterstitialAd.load(
+                            activitySupplier.get(),
+                            id,
+                            adRequest,
+                            adCallbackAndListeners.getInterstitialAdLoadCallback(call, notifyListenersFunction)
+                        );
+                    }
+                );
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage(), ex);
+        }
+    }
+
+    public void showInterstitial(final PluginCall call, BiConsumer<String, JSObject> notifyListenersFunction) {
+        if (interstitialAd == null) {
+            String errorMessage = "No Interstitial can be show. It was not prepared or maybe it failed to be prepared.";
+            call.reject(errorMessage);
+            AdMobPluginError errorObject = new AdMobPluginError(-1, errorMessage);
+            notifyListenersFunction.accept(InterstitialAdPluginPluginEvent.FailedToLoad, errorObject);
+            return;
+        }
+
+        activitySupplier
+            .get()
+            .runOnUiThread(
+                () -> {
+                    try {
+                        interstitialAd.show(activitySupplier.get());
+                        call.resolve();
+                    } catch (Exception ex) {
+                        call.reject(ex.getLocalizedMessage(), ex);
+                    }
+                }
+            );
+    }
+}

package/android/src/main/java/com/getcapacitor/community/admob/interstitial/InterstitialAdCallbackAndListeners.kt

@@ -0,0 +1,38 @@
+package com.getcapacitor.community.admob.interstitial
+
+import com.getcapacitor.JSObject
+import com.getcapacitor.PluginCall
+import com.getcapacitor.community.admob.helpers.FullscreenPluginCallback
+import com.getcapacitor.community.admob.models.AdMobPluginError
+import com.google.android.gms.ads.LoadAdError
+import com.google.android.gms.ads.interstitial.InterstitialAd
+import com.google.android.gms.ads.interstitial.InterstitialAdLoadCallback
+import com.google.android.gms.common.util.BiConsumer
+
+object InterstitialAdCallbackAndListeners {
+
+    fun getInterstitialAdLoadCallback(call: PluginCall,
+                                      notifyListenersFunction: BiConsumer<String, JSObject>,
+    ): InterstitialAdLoadCallback {
+        return object : InterstitialAdLoadCallback() {
+            override fun onAdLoaded(ad: InterstitialAd) {
+                ad.fullScreenContentCallback = FullscreenPluginCallback(InterstitialAdPluginPluginEvent, notifyListenersFunction)
+
+                AdInterstitialExecutor.interstitialAd = ad
+
+                val adInfo = JSObject()
+                adInfo.put("adUnitId", ad.adUnitId)
+                call.resolve(adInfo)
+
+                notifyListenersFunction.accept(InterstitialAdPluginPluginEvent.Loaded, adInfo)
+            }
+
+            override fun onAdFailedToLoad(adError: LoadAdError) {
+                val adMobError = AdMobPluginError(adError)
+
+                notifyListenersFunction.accept(InterstitialAdPluginPluginEvent.FailedToLoad, adMobError)
+                call.reject(adError.message)
+            }
+        }
+    }
+}

package/android/src/main/java/com/getcapacitor/community/admob/interstitial/InterstitialAdPluginPluginEvent.kt

@@ -0,0 +1,11 @@
+package com.getcapacitor.community.admob.interstitial
+
+import com.getcapacitor.community.admob.models.LoadPluginEventNames
+
+object InterstitialAdPluginPluginEvent: LoadPluginEventNames {
+    const val Loaded = "interstitialAdLoaded"
+    const val FailedToLoad = "interstitialAdFailedToLoad"
+    override val Showed = "interstitialAdShowed"
+    override val FailedToShow = "interstitialAdFailedToShow"
+    override val Dismissed = "interstitialAdDismissed"
+}

package/android/src/main/java/com/getcapacitor/community/admob/models/AdMobPluginError.kt

@@ -0,0 +1,15 @@
+package com.getcapacitor.community.admob.models
+
+import com.getcapacitor.JSObject
+import com.google.android.gms.ads.AdError
+
+data class AdMobPluginError(val code: Int, val message: String) : JSObject() {
+    override fun put(key: String, value: Int): JSObject {
+        throw Exception("Do not put elements directly here use the constructor")
+    }
+    init {
+        super.put("code", this.code)
+        super.put("message", this.message)
+    }
+    constructor(adError: AdError): this(adError.code, adError.message)
+}