@ququplay/admob 5.3.1

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

@@ -0,0 +1,225 @@
+package com.getcapacitor.community.admob.models;
+
+import androidx.annotation.VisibleForTesting;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.community.admob.banner.BannerAdSizeEnum;
+import com.getcapacitor.community.admob.rewarded.models.SsvInfo;
+
+/**
+ * Holds the options for an Ad Request
+ * TODO: automatically create type definitions https://github.com/vojtechhabarta/typescript-generator ?
+ */
+public abstract class AdOptions {
+
+    /**
+     * The ad unit ID that you want to request
+     *
+     * @see <a href="https://support.google.com/admob/answer/7356431?hl=en">Find ad Unit ID of an app</a>
+     */
+    public final String adId;
+    /**
+     * Banner Ad Size, defaults to ADAPTIVE_BANNER.
+     * IT can be: ADAPTIVE_BANNER, BANNER, MEDIUM_RECTANGLE,
+     * FULL_BANNER, LEADERBOARD, SKYSCRAPER, or CUSTOM
+     */
+    public final BannerAdSizeEnum adSize;
+
+    public static final String BANNER_TESTER_ID = "ca-app-pub-3940256099942544/6300978111";
+    public static final String INTERSTITIAL_TESTER_ID = "ca-app-pub-3940256099942544/1033173712";
+    public static final String REWARD_VIDEO_TESTER_ID = "ca-app-pub-3940256099942544/5224354917";
+
+    /**
+     * The position of the ad, it can be TOP_CENTER,
+     * CENTER or BOTTOM
+     * <p>
+     * TODO: Make an enum
+     */
+    public final String position;
+
+    /**
+     * If set to true, an test app will be requested using the official sample ads unit ids
+     *
+     * @see <a href="https://developers.google.com/admob/android/test-ads#sample_ad_units">Sample ad units</a>
+     */
+    public final boolean isTesting;
+
+    /**
+     * Margin Banner. Default is 0 px;
+     * If position is BOTTOM_CENTER, margin is be margin-bottom.
+     * If position is TOP_CENTER, margin is be margin-top.
+     */
+    public final int margin;
+
+    /**
+     * The default behavior of the Google Mobile Ads SDK is to serve personalized ads.
+     * Set this to true to request Non-Personalized Ads
+     *
+     * @see <a href="https://developers.google.com/admob/android/eu-consent">EU-Consent</a>
+     * <p>
+     * Default is false
+     */
+    public final boolean npa;
+
+    /**
+     * Used for Server side verification of Reward Ads
+     */
+    public final SsvInfo ssvInfo;
+
+    private AdOptions(PluginCall call) {
+        /*
+         * TODO: Since the Id in the Typescript AdOptions interface is not optional
+         *  the default value here should never be used. In case it is used it means this is an error.
+         *  Would not be better to print an error (call.reject()) and do not create any Ad?
+         *  Why? Because an distracted dev could think that everything is working when it is not.
+         */
+
+        this.adId = call.getString("adId", getTestingId());
+        this.isTesting = call.getBoolean("isTesting", false);
+        this.position = call.getString("position", "BOTTOM_CENTER");
+        this.margin = call.getInt("margin", 0);
+        this.npa = call.getBoolean("npa", false);
+        this.ssvInfo = new SsvInfo(call);
+
+        String sizeString = call.getString("adSize", BannerAdSizeEnum.ADAPTIVE_BANNER.name());
+        this.adSize = AdOptions.adSizeStringToAdSizeEnum(sizeString);
+    }
+
+    private AdOptions(String id, boolean isTesting, String position, int margin, boolean npa, BannerAdSizeEnum adSize, SsvInfo ssvInfo) {
+        this.adId = id;
+        this.isTesting = isTesting;
+        this.position = position;
+        this.margin = margin;
+        this.npa = npa;
+        this.adSize = adSize;
+        this.ssvInfo = ssvInfo;
+    }
+
+    /**
+     * @return the id used for this type of test ads.
+     */
+    public abstract String getTestingId();
+
+    private static BannerAdSizeEnum adSizeStringToAdSizeEnum(String sizeString) {
+        try {
+            return BannerAdSizeEnum.valueOf(sizeString);
+        } catch (IllegalArgumentException error) {
+            return BannerAdSizeEnum.ADAPTIVE_BANNER;
+        }
+    }
+
+    public static class AdOptionsFactory {
+
+        private AdOptionsFactory() {}
+
+        public AdOptions createBannerOptions(PluginCall call) {
+            return new AdOptions(call) {
+                @Override
+                public String getTestingId() {
+                    return AdOptions.BANNER_TESTER_ID;
+                }
+            };
+        }
+
+        public AdOptions createInterstitialOptions(PluginCall call) {
+            return new AdOptions(call) {
+                @Override
+                public String getTestingId() {
+                    return AdOptions.INTERSTITIAL_TESTER_ID;
+                }
+            };
+        }
+
+        public AdOptions createRewardVideoOptions(PluginCall call) {
+            return new AdOptions(call) {
+                @Override
+                public String getTestingId() {
+                    return AdOptions.REWARD_VIDEO_TESTER_ID;
+                }
+            };
+        }
+
+        public AdOptions createGenericOptions(PluginCall call, final String testingID) {
+            return new AdOptions(call) {
+                @Override
+                public String getTestingId() {
+                    return testingID;
+                }
+            };
+        }
+    }
+
+    private static AdOptionsFactory factory;
+
+    public static AdOptionsFactory getFactory() {
+        if (AdOptions.factory != null) {
+            return AdOptions.factory;
+        }
+        AdOptions.factory = new AdOptionsFactory();
+        return AdOptions.factory;
+    }
+
+    /**
+     * Just for testing
+     */
+    @VisibleForTesting(otherwise = VisibleForTesting.PRIVATE)
+    public static class TesterAdOptionsBuilder {
+
+        private String id = "TesterAdOptionsBuilder__defaultID";
+        private String testingID = "TesterAdOptionsBuilder__testingID";
+        private boolean isTesting = true;
+        private String position = "TesterAdOptionsBuilder__position";
+        private int margin = 1;
+        private boolean npa = false;
+        private BannerAdSizeEnum adSize = BannerAdSizeEnum.ADAPTIVE_BANNER;
+        private SsvInfo ssvInfo = new SsvInfo();
+
+        public TesterAdOptionsBuilder setSsvInfo(SsvInfo info) {
+            ssvInfo = info;
+            return this;
+        }
+
+        public TesterAdOptionsBuilder setIsTesting(boolean value) {
+            isTesting = value;
+            return this;
+        }
+
+        public TesterAdOptionsBuilder setNpa(boolean value) {
+            npa = value;
+            return this;
+        }
+
+        public TesterAdOptionsBuilder setPosition(String value) {
+            position = value;
+            return this;
+        }
+
+        public TesterAdOptionsBuilder setTestingID(String value) {
+            testingID = value;
+            return this;
+        }
+
+        public TesterAdOptionsBuilder setID(String value) {
+            id = value;
+            return this;
+        }
+
+        public TesterAdOptionsBuilder setMargin(int value) {
+            margin = value;
+            return this;
+        }
+
+        public TesterAdOptionsBuilder setAdSize(BannerAdSizeEnum value) {
+            adSize = value;
+            return this;
+        }
+
+        public AdOptions build() {
+            return new AdOptions(id, isTesting, position, margin, npa, adSize, ssvInfo) {
+                @Override
+                public String getTestingId() {
+                    return testingID;
+                }
+            };
+        }
+    }
+}

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

@@ -0,0 +1,34 @@
+package com.getcapacitor.community.admob.models;
+
+import android.app.Activity;
+import android.content.Context;
+import androidx.core.util.Supplier;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.Plugin;
+import com.google.android.gms.common.util.BiConsumer;
+
+public abstract class Executor {
+
+    protected final Supplier<Context> contextSupplier;
+    protected final Supplier<Activity> activitySupplier;
+    protected BiConsumer<String, JSObject> notifyListenersFunction;
+    protected final String logTag;
+
+    // Eventually we can change the notification directly here!
+    protected void notifyListeners(String eventName, JSObject data) {
+        notifyListenersFunction.accept(eventName, data);
+    }
+
+    public Executor(
+        Supplier<Context> contextSupplier,
+        Supplier<Activity> activitySupplier,
+        BiConsumer<String, JSObject> notifyListenersFunction,
+        String pluginLogTag,
+        String executorTag
+    ) {
+        this.contextSupplier = contextSupplier;
+        this.activitySupplier = activitySupplier;
+        this.notifyListenersFunction = notifyListenersFunction;
+        this.logTag = pluginLogTag + "|" + executorTag;
+    }
+}

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

@@ -0,0 +1,7 @@
+package com.getcapacitor.community.admob.models
+
+interface LoadPluginEventNames {
+    val Showed: String
+    val FailedToShow: String
+    val Dismissed: String
+}

package/android/src/main/java/com/getcapacitor/community/admob/rewarded/AdRewardExecutor.java

@@ -0,0 +1,80 @@
+package com.getcapacitor.community.admob.rewarded;
+
+import android.app.Activity;
+import android.content.Context;
+import androidx.core.util.Supplier;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+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.rewarded.RewardedAd;
+import com.google.android.gms.common.util.BiConsumer;
+
+public class AdRewardExecutor extends Executor {
+
+    public static RewardedAd mRewardedAd;
+
+    public AdRewardExecutor(
+        Supplier<Context> contextSupplier,
+        Supplier<Activity> activitySupplier,
+        BiConsumer<String, JSObject> notifyListenersFunction,
+        String pluginLogTag
+    ) {
+        super(contextSupplier, activitySupplier, notifyListenersFunction, pluginLogTag, "AdRewardExecutor");
+    }
+
+    @PluginMethod
+    public void prepareRewardVideoAd(final PluginCall call, BiConsumer<String, JSObject> notifyListenersFunction) {
+        final AdOptions adOptions = AdOptions.getFactory().createRewardVideoOptions(call);
+
+        activitySupplier
+            .get()
+            .runOnUiThread(
+                () -> {
+                    try {
+                        final AdRequest adRequest = RequestHelper.createRequest(adOptions);
+                        final String id = AdViewIdHelper.getFinalAdId(adOptions, adRequest, logTag, contextSupplier.get());
+                        RewardedAd.load(
+                            contextSupplier.get(),
+                            id,
+                            adRequest,
+                            RewardedAdCallbackAndListeners.INSTANCE.getRewardedAdLoadCallback(call, notifyListenersFunction, adOptions)
+                        );
+                    } catch (Exception ex) {
+                        call.reject(ex.getLocalizedMessage(), ex);
+                    }
+                }
+            );
+    }
+
+    @PluginMethod
+    public void showRewardVideoAd(final PluginCall call, BiConsumer<String, JSObject> notifyListenersFunction) {
+        if (mRewardedAd == null) {
+            String errorMessage = "No Reward Video Ad 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(RewardAdPluginEvents.FailedToLoad, errorObject);
+            return;
+        }
+
+        try {
+            activitySupplier
+                .get()
+                .runOnUiThread(
+                    () -> {
+                        mRewardedAd.show(
+                            activitySupplier.get(),
+                            RewardedAdCallbackAndListeners.INSTANCE.getOnUserEarnedRewardListener(call, notifyListenersFunction)
+                        );
+                    }
+                );
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage(), ex);
+        }
+    }
+}

package/android/src/main/java/com/getcapacitor/community/admob/rewarded/RewardAdPluginEvents.kt

@@ -0,0 +1,12 @@
+package com.getcapacitor.community.admob.rewarded
+
+import com.getcapacitor.community.admob.models.LoadPluginEventNames
+
+object RewardAdPluginEvents: LoadPluginEventNames {
+    const val Loaded = "onRewardedVideoAdLoaded"
+    const val FailedToLoad = "onRewardedVideoAdFailedToLoad"
+    const val Rewarded = "onRewardedVideoAdReward"
+    override val Showed = "onRewardedVideoAdShowed"
+    override val FailedToShow = "onRewardedVideoAdFailedToShow"
+    override val Dismissed = "onRewardedVideoAdDismissed"
+}

package/android/src/main/java/com/getcapacitor/community/admob/rewarded/RewardedAdCallbackAndListeners.kt

@@ -0,0 +1,63 @@
+package com.getcapacitor.community.admob.rewarded
+
+import com.getcapacitor.JSObject
+import com.getcapacitor.PluginCall
+import com.getcapacitor.community.admob.helpers.FullscreenPluginCallback
+import com.getcapacitor.community.admob.models.AdMobPluginError
+import com.getcapacitor.community.admob.models.AdOptions
+import com.google.android.gms.ads.LoadAdError
+import com.google.android.gms.ads.OnUserEarnedRewardListener
+import com.google.android.gms.ads.rewarded.RewardItem
+import com.google.android.gms.ads.rewarded.RewardedAd
+import com.google.android.gms.ads.rewarded.RewardedAdLoadCallback
+import com.google.android.gms.ads.rewarded.ServerSideVerificationOptions
+import com.google.android.gms.common.util.BiConsumer
+
+object RewardedAdCallbackAndListeners {
+
+    fun getOnUserEarnedRewardListener(call: PluginCall, notifyListenersFunction: BiConsumer<String, JSObject>): OnUserEarnedRewardListener {
+        return OnUserEarnedRewardListener { item: RewardItem ->
+            val response = JSObject()
+            response.put("type", item.type)
+                    .put("amount", item.amount)
+            notifyListenersFunction.accept(RewardAdPluginEvents.Rewarded, response)
+            call.resolve(response)
+        }
+    }
+
+    fun getRewardedAdLoadCallback(call: PluginCall, notifyListenersFunction: BiConsumer<String, JSObject>, adOptions: AdOptions): RewardedAdLoadCallback {
+        return object : RewardedAdLoadCallback() {
+            override fun onAdLoaded(ad: RewardedAd) {
+                AdRewardExecutor.mRewardedAd = ad
+                AdRewardExecutor.mRewardedAd.fullScreenContentCallback = FullscreenPluginCallback(
+                        RewardAdPluginEvents, notifyListenersFunction)
+
+                if(adOptions.ssvInfo.hasInfo){
+                    val ssvOptions = ServerSideVerificationOptions.Builder()
+                    adOptions.ssvInfo.customData?.let {
+                        ssvOptions.setCustomData(it)
+                    }
+
+                    adOptions.ssvInfo.userId?.let {
+                        ssvOptions.setUserId(it)
+                    }
+                    AdRewardExecutor.mRewardedAd.setServerSideVerificationOptions(ssvOptions.build())
+                }
+
+                val adInfo = JSObject()
+                adInfo.put("adUnitId", ad.adUnitId)
+                call.resolve(adInfo)
+
+                notifyListenersFunction.accept(RewardAdPluginEvents.Loaded, adInfo)
+            }
+
+            override fun onAdFailedToLoad(adError: LoadAdError) {
+                val adMobError = AdMobPluginError(adError)
+
+                notifyListenersFunction.accept(RewardAdPluginEvents.FailedToLoad, adMobError)
+                call.reject(adError.message)
+            }
+        }
+    }
+
+}

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

@@ -0,0 +1,20 @@
+package com.getcapacitor.community.admob.rewarded.models
+
+import com.getcapacitor.PluginCall
+
+class SsvInfo(
+    val customData: String? = null,
+    val userId: String? = null) {
+
+    constructor(pluginCall: PluginCall?) : this(
+        pluginCall?.getObject("ssv")?.getString("customData"),
+        pluginCall?.getObject("ssv")?.getString("userId")
+    )
+
+    constructor() : this(null, null)
+
+    val hasInfo
+        get(): Boolean {
+            return customData != null || userId != null
+        }
+}

package/android/src/main/res/layout/bridge_layout_main.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<androidx.coordinatorlayout.widget.CoordinatorLayout xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:app="http://schemas.android.com/apk/res-auto"
+    xmlns:tools="http://schemas.android.com/tools"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent"
+    tools:context="com.getcapacitor.BridgeActivity"
+    >
+
+    <WebView
+        android:id="@+id/webview"
+        android:layout_width="fill_parent"
+        android:layout_height="fill_parent" />
+
+</androidx.coordinatorlayout.widget.CoordinatorLayout>

package/android/src/main/res/values/colors.xml

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+</resources>

package/android/src/main/res/values/strings.xml

@@ -0,0 +1,2 @@
+<resources>
+</resources>

package/android/src/main/res/values/styles.xml

@@ -0,0 +1,3 @@
+<resources>
+
+</resources>