@ququplay/admob 8.0.8 → 8.1.0

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

@@ -0,0 +1,112 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- A native ad as a strip across the top of the screen: icon, "Ad" badge, headline, body and the call to action.
+     Colours are set from the JS style options. The AdChoices icon sits in the top right corner; the wider end padding
+     keeps the button clear of it. A hairline along the bottom separates the ad from the screen below. -->
+<com.google.android.gms.ads.nativead.NativeAdView xmlns:android="http://schemas.android.com/apk/res/android"
+    android:id="@+id/admob_native_ad_view"
+    android:layout_width="match_parent"
+    android:layout_height="wrap_content">
+
+    <LinearLayout
+        android:layout_width="match_parent"
+        android:layout_height="wrap_content"
+        android:orientation="vertical">
+
+        <LinearLayout
+            android:layout_width="match_parent"
+            android:layout_height="wrap_content"
+            android:gravity="center_vertical"
+            android:minHeight="56dp"
+            android:orientation="horizontal"
+            android:paddingStart="12dp"
+            android:paddingTop="6dp"
+            android:paddingEnd="20dp"
+            android:paddingBottom="7dp">
+
+            <ImageView
+                android:id="@+id/admob_native_ad_icon"
+                android:layout_width="40dp"
+                android:layout_height="40dp"
+                android:layout_marginEnd="10dp"
+                android:adjustViewBounds="true"
+                android:contentDescription="@null"
+                android:scaleType="fitCenter" />
+
+            <LinearLayout
+                android:layout_width="0dp"
+                android:layout_height="wrap_content"
+                android:layout_weight="1"
+                android:orientation="vertical">
+
+                <LinearLayout
+                    android:layout_width="match_parent"
+                    android:layout_height="wrap_content"
+                    android:gravity="center_vertical"
+                    android:orientation="horizontal">
+
+                    <TextView
+                        android:id="@+id/admob_native_ad_badge"
+                        android:layout_width="wrap_content"
+                        android:layout_height="wrap_content"
+                        android:layout_marginEnd="6dp"
+                        android:minWidth="18dp"
+                        android:minHeight="16dp"
+                        android:paddingStart="4dp"
+                        android:paddingEnd="4dp"
+                        android:text="@string/admob_native_ad_badge"
+                        android:textSize="10sp"
+                        android:textStyle="bold" />
+
+                    <TextView
+                        android:id="@+id/admob_native_ad_headline"
+                        android:layout_width="0dp"
+                        android:layout_height="wrap_content"
+                        android:layout_weight="1"
+                        android:ellipsize="end"
+                        android:maxLines="1"
+                        android:textSize="14sp"
+                        android:textStyle="bold" />
+                </LinearLayout>
+
+                <TextView
+                    android:id="@+id/admob_native_ad_body"
+                    android:layout_width="match_parent"
+                    android:layout_height="wrap_content"
+                    android:layout_marginTop="2dp"
+                    android:ellipsize="end"
+                    android:maxLines="1"
+                    android:textSize="12sp" />
+            </LinearLayout>
+
+            <Button
+                android:id="@+id/admob_native_ad_call_to_action"
+                android:layout_width="wrap_content"
+                android:layout_height="36dp"
+                android:layout_marginStart="10dp"
+                android:maxWidth="120dp"
+                android:minWidth="64dp"
+                android:minHeight="0dp"
+                android:ellipsize="end"
+                android:maxLines="1"
+                android:paddingStart="12dp"
+                android:paddingTop="0dp"
+                android:paddingEnd="12dp"
+                android:paddingBottom="0dp"
+                android:stateListAnimator="@null"
+                android:textAllCaps="false"
+                android:textSize="13sp"
+                android:textStyle="bold" />
+        </LinearLayout>
+
+        <View
+            android:id="@+id/admob_native_ad_divider"
+            android:layout_width="match_parent"
+            android:layout_height="1px" />
+    </LinearLayout>
+
+    <com.google.android.gms.ads.nativead.AdChoicesView
+        android:id="@+id/admob_native_ad_choices"
+        android:layout_width="wrap_content"
+        android:layout_height="wrap_content"
+        android:layout_gravity="top|end" />
+</com.google.android.gms.ads.nativead.NativeAdView>

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

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+    <string name="admob_native_ad_badge">Ad</string>
+</resources>

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

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+    <string name="admob_native_ad_badge">Reklama</string>
+</resources>

package/dist/docs.json

@@ -6,6 +6,7 @@
     "tags": [],
     "extends": [
       "BannerDefinitions",
+      "NativeAdDefinitions",
       "RewardDefinitions",
       "RewardInterstitialDefinitions",
       "InterstitialDefinitions",
@@ -738,6 +739,282 @@
         ],
         "slug": "addlistenerinterstitialadplugineventsshowed-"
       },
+      {
+        "name": "showNativeAd",
+        "signature": "(options: NativeAdOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "NativeAdOptions",
+            "type": "NativeAdOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "group",
+            "text": "NativeAd"
+          },
+          {
+            "name": "param",
+            "text": "options NativeAdOptions"
+          },
+          {
+            "name": "since",
+            "text": "8.1.0"
+          }
+        ],
+        "docs": "Show a native ad as a strip across the top of the screen.\nShows the ad loaded before when there is one and it has not expired, otherwise loads a new one.\nAndroid and iOS; resolves without showing anything on the web.",
+        "complexTypes": [
+          "NativeAdOptions"
+        ],
+        "slug": "shownativead"
+      },
+      {
+        "name": "hideNativeAd",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "group",
+            "text": "NativeAd"
+          },
+          {
+            "name": "since",
+            "text": "8.1.0"
+          }
+        ],
+        "docs": "Hide the native ad but keep it, so showNativeAd brings back the same ad.",
+        "complexTypes": [],
+        "slug": "hidenativead"
+      },
+      {
+        "name": "removeNativeAd",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "group",
+            "text": "NativeAd"
+          },
+          {
+            "name": "since",
+            "text": "8.1.0"
+          }
+        ],
+        "docs": "Destroy the native ad, remove it from screen.",
+        "complexTypes": [],
+        "slug": "removenativead"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: NativeAdPluginEvents.SizeChanged, listenerFunc: (info: AdMobBannerSize) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "nativeAdSizeChanged",
+            "type": "NativeAdPluginEvents.SizeChanged"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(info: AdMobBannerSize) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "group",
+            "text": "NativeAd"
+          },
+          {
+            "name": "param",
+            "text": "eventName nativeAdSizeChanged"
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc"
+          },
+          {
+            "name": "since",
+            "text": "8.1.0"
+          }
+        ],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "NativeAdPluginEvents",
+          "AdMobBannerSize"
+        ],
+        "slug": "addlistenernativeadplugineventssizechanged-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: NativeAdPluginEvents.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "nativeAdLoaded",
+            "type": "NativeAdPluginEvents.Loaded"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "() => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "group",
+            "text": "NativeAd"
+          },
+          {
+            "name": "param",
+            "text": "eventName nativeAdLoaded"
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc"
+          },
+          {
+            "name": "since",
+            "text": "8.1.0"
+          }
+        ],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "NativeAdPluginEvents"
+        ],
+        "slug": "addlistenernativeadplugineventsloaded-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: NativeAdPluginEvents.FailedToLoad, listenerFunc: (info: AdMobError) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "nativeAdFailedToLoad",
+            "type": "NativeAdPluginEvents.FailedToLoad"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(info: AdMobError) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "group",
+            "text": "NativeAd"
+          },
+          {
+            "name": "param",
+            "text": "eventName nativeAdFailedToLoad"
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc"
+          },
+          {
+            "name": "since",
+            "text": "8.1.0"
+          }
+        ],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "NativeAdPluginEvents",
+          "AdMobError"
+        ],
+        "slug": "addlistenernativeadplugineventsfailedtoload-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: NativeAdPluginEvents.Clicked, listenerFunc: () => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "nativeAdClicked",
+            "type": "NativeAdPluginEvents.Clicked"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "() => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "group",
+            "text": "NativeAd"
+          },
+          {
+            "name": "param",
+            "text": "eventName nativeAdClicked"
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc"
+          },
+          {
+            "name": "since",
+            "text": "8.1.0"
+          }
+        ],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "NativeAdPluginEvents"
+        ],
+        "slug": "addlistenernativeadplugineventsclicked-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: NativeAdPluginEvents.AdImpression, listenerFunc: () => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "nativeAdImpression",
+            "type": "NativeAdPluginEvents.AdImpression"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "() => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "group",
+            "text": "NativeAd"
+          },
+          {
+            "name": "param",
+            "text": "eventName nativeAdImpression"
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc"
+          },
+          {
+            "name": "since",
+            "text": "8.1.0"
+          }
+        ],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "NativeAdPluginEvents"
+        ],
+        "slug": "addlistenernativeadplugineventsadimpression-"
+      },
       {
         "name": "prepareRewardVideoAd",
         "signature": "(options: RewardAdOptions) => Promise<AdLoadInfo>",
@@ -1752,6 +2029,176 @@
         }
       ]
     },
+    {
+      "name": "NativeAdOptions",
+      "slug": "nativeadoptions",
+      "docs": "",
+      "tags": [],
+      "extends": [
+        "AdOptions"
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "style",
+          "tags": [
+            {
+              "text": "8.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Colours of the native ad strip, as `#RRGGBB` (or `#AARRGGBB`).",
+          "complexTypes": [
+            "NativeAdStyle"
+          ],
+          "type": "NativeAdStyle"
+        },
+        {
+          "name": "adId",
+          "tags": [
+            {
+              "text": "https ://support.google.com/admob/answer/7356431?hl=en",
+              "name": "see"
+            },
+            {
+              "text": "1.1.2",
+              "name": "since"
+            }
+          ],
+          "docs": "The ad unit ID that you want to request",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "isTesting",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "1.1.2",
+              "name": "since"
+            }
+          ],
+          "docs": "You can use test mode of ad.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "margin",
+          "tags": [
+            {
+              "text": "0",
+              "name": "default"
+            },
+            {
+              "text": "1.1.2",
+              "name": "since"
+            }
+          ],
+          "docs": "Margin Banner. Default is 0px;\nIf position is BOTTOM_CENTER, margin is be margin-bottom.\nIf position is TOP_CENTER, margin is be margin-top.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "npa",
+          "tags": [
+            {
+              "text": "https ://developers.google.com/admob/ios/eu-consent",
+              "name": "see"
+            },
+            {
+              "text": "https ://developers.google.com/admob/android/eu-consent",
+              "name": "see"
+            },
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "1.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The default behavior of the Google Mobile Ads SDK is to serve personalized ads.\nSet this to true to request Non-Personalized Ads",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "immersiveMode",
+          "tags": [
+            {
+              "text": "https ://developers.google.com/admob/android/reference/com/google/android/gms/ads/interstitial/InterstitialAd#setImmersiveMode(boolean)",
+              "name": "see"
+            },
+            {
+              "text": "https ://developers.google.com/admob/android/reference/com/google/android/gms/ads/rewarded/RewardedAd#setImmersiveMode(boolean)",
+              "name": "see"
+            },
+            {
+              "text": "7.0.3",
+              "name": "since"
+            }
+          ],
+          "docs": "Sets a flag that controls if this interstitial or reward object will be displayed in immersive mode.\nCall this method before show.\nDuring show, if this flag is on and immersive mode is supported,\nSYSTEM_UI_FLAG_IMMERSIVE_STICKY &SYSTEM_UI_FLAG_HIDE_NAVIGATION will be turned on for interstitial or reward ad.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "NativeAdStyle",
+      "slug": "nativeadstyle",
+      "docs": "",
+      "tags": [],
+      "extends": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "backgroundColor",
+          "tags": [],
+          "docs": "Background of the strip. Defaults to white.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "textColor",
+          "tags": [],
+          "docs": "Headline text. Defaults to black.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "secondaryTextColor",
+          "tags": [],
+          "docs": "Body text. Defaults to textColor.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "buttonColor",
+          "tags": [],
+          "docs": "Call-to-action button and \"Ad\" badge background.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "buttonTextColor",
+          "tags": [],
+          "docs": "Call-to-action button and \"Ad\" badge text. Defaults to white.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "dividerColor",
+          "tags": [],
+          "docs": "Hairline along the bottom of the strip. Defaults to none.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
     {
       "name": "RewardAdOptions",
       "slug": "rewardadoptions",
@@ -2317,6 +2764,42 @@
         }
       ]
     },
+    {
+      "name": "NativeAdPluginEvents",
+      "slug": "nativeadpluginevents",
+      "members": [
+        {
+          "name": "SizeChanged",
+          "value": "'nativeAdSizeChanged'",
+          "tags": [],
+          "docs": "The strip's size in dp; 0 when it is hidden or removed."
+        },
+        {
+          "name": "Loaded",
+          "value": "'nativeAdLoaded'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "FailedToLoad",
+          "value": "'nativeAdFailedToLoad'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "Clicked",
+          "value": "'nativeAdClicked'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "AdImpression",
+          "value": "'nativeAdImpression'",
+          "tags": [],
+          "docs": ""
+        }
+      ]
+    },
     {
       "name": "RewardAdPluginEvents",
       "slug": "rewardadpluginevents",

package/dist/esm/definitions.d.ts

@@ -1,10 +1,11 @@
 import type { BannerDefinitions } from './banner';
 import type { AdmobConsentDefinitions } from './consent';
 import type { InterstitialDefinitions } from './interstitial';
+import type { NativeAdDefinitions } from './native-ad';
 import type { RewardDefinitions } from './reward';
 import type { RewardInterstitialDefinitions } from './reward-interstitial';
 import type { TrackingAuthorizationStatusInterface } from './shared/tracking-authorization-status.interface';
-type AdMobDefinitions = BannerDefinitions & RewardDefinitions & RewardInterstitialDefinitions & InterstitialDefinitions & AdmobConsentDefinitions;
+type AdMobDefinitions = BannerDefinitions & NativeAdDefinitions & RewardDefinitions & RewardInterstitialDefinitions & InterstitialDefinitions & AdmobConsentDefinitions;
 export interface AdMobPlugin extends AdMobDefinitions {
     /**
      * Initialize AdMob with AdMobInitializationOptions

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAwGA,MAAM,CAAN,IAAY,kBAoBX;AApBD,WAAY,kBAAkB;IAC5B;;OAEG;IACH,yCAAmB,CAAA;IAEnB;;OAEG;IACH,2DAAqC,CAAA;IAErC;;OAEG;IACH,mCAAa,CAAA;IAEb;;OAEG;IACH,uDAAiC,CAAA;AACnC,CAAC,EApBW,kBAAkB,KAAlB,kBAAkB,QAoB7B"}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AA0GA,MAAM,CAAN,IAAY,kBAoBX;AApBD,WAAY,kBAAkB;IAC5B;;OAEG;IACH,yCAAmB,CAAA;IAEnB;;OAEG;IACH,2DAAqC,CAAA;IAErC;;OAEG;IACH,mCAAa,CAAA;IAEb;;OAEG;IACH,uDAAiC,CAAA;AACnC,CAAC,EApBW,kBAAkB,KAAlB,kBAAkB,QAoB7B"}

package/dist/esm/index.d.ts

@@ -2,6 +2,7 @@ import type { AdMobPlugin } from './definitions';
 declare const AdMob: AdMobPlugin;
 export * from './definitions';
 export * from './banner/index';
+export * from './native-ad/index';
 export * from './interstitial/index';
 export * from './reward-interstitial/index';
 export * from './reward/index';

package/dist/esm/index.js

@@ -4,6 +4,7 @@ const AdMob = registerPlugin('AdMob', {
 });
 export * from './definitions';
 export * from './banner/index';
+export * from './native-ad/index';
 export * from './interstitial/index';
 export * from './reward-interstitial/index';
 export * from './reward/index';

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,KAAK,GAAG,cAAc,CAAc,OAAO,EAAE;IACjD,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;CACzD,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,KAAK,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,KAAK,GAAG,cAAc,CAAc,OAAO,EAAE;IACjD,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;CACzD,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,KAAK,EAAE,CAAC"}

package/dist/esm/native-ad/index.d.ts

@@ -0,0 +1,3 @@
+export * from './native-ad-definitions.interface';
+export * from './native-ad-options.interface';
+export * from './native-ad-plugin-events.enum';

package/dist/esm/native-ad/index.js

@@ -0,0 +1,4 @@
+export * from './native-ad-definitions.interface';
+export * from './native-ad-options.interface';
+export * from './native-ad-plugin-events.enum';
+//# sourceMappingURL=index.js.map