@capgo/capacitor-admob 7.1.0 → 7.4.4

package/CapgoCapacitorAdmob.podspec

@@ -13,5 +13,6 @@ Pod::Spec.new do |s|
   s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
   s.ios.deployment_target = '14.0'
   s.dependency 'Capacitor'
+  s.dependency 'Google-Mobile-Ads-SDK', '~> 11.0'
   s.swift_version = '5.1'
 end

package/Package.swift

@@ -10,14 +10,16 @@ let package = Package(
             targets: ["AdmobPlusPlugin"])
     ],
     dependencies: [
-        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "7.0.0")
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "7.0.0"),
+        .package(url: "https://github.com/googleads/swift-package-manager-google-mobile-ads.git", from: "11.0.0")
     ],
     targets: [
         .target(
             name: "AdmobPlusPlugin",
             dependencies: [
                 .product(name: "Capacitor", package: "capacitor-swift-pm"),
-                .product(name: "Cordova", package: "capacitor-swift-pm")
+                .product(name: "Cordova", package: "capacitor-swift-pm"),
+                .product(name: "GoogleMobileAds", package: "swift-package-manager-google-mobile-ads")
             ],
             path: "ios/Sources/AdmobPlusPlugin"),
         .testTarget(

package/README.md

@@ -2,11 +2,15 @@
  <a href="https://capgo.app/"><img src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/></a>
 
 <div align="center">
-  <h2><a href="https://capgo.app/?ref=plugin"> ➡️ Get Instant updates for your App with Capgo</a></h2>
-  <h2><a href="https://capgo.app/consulting/?ref=plugin"> Missing a feature? We’ll build the plugin for you 💪</a></h2>
+  <h2><a href="https://capgo.app/?ref=plugin_admob"> ➡️ Get Instant updates for your App with Capgo</a></h2>
+  <h2><a href="https://capgo.app/consulting/?ref=plugin_admob"> Missing a feature? We’ll build the plugin for you 💪</a></h2>
 </div>
 AdMob SDK bridge for Capacitor apps
 
+## Documentation
+
+The most complete doc is available here: https://capgo.app/docs/plugins/admob/
+
 ## Install
 
 ```bash
@@ -39,12 +43,18 @@ npx cap sync
 <docgen-api>
 <!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
 
+AdMob Plus Plugin interface for displaying Google AdMob ads in Capacitor apps.
+
 ### start()
 
 ```typescript
 start() => Promise<void>
 ```
 
+Initialize and start the AdMob SDK.
+
+**Since:** 1.0.0
+
 --------------------
 
 
@@ -54,9 +64,13 @@ start() => Promise<void>
 configure(config: AdMobConfig) => Promise<void>
 ```
 
-| Param        | Type                                                |
-| ------------ | --------------------------------------------------- |
-| **`config`** | <code><a href="#admobconfig">AdMobConfig</a></code> |
+Configure AdMob settings.
+
+| Param        | Type                                                | Description                       |
+| ------------ | --------------------------------------------------- | --------------------------------- |
+| **`config`** | <code><a href="#admobconfig">AdMobConfig</a></code> | - Configuration options for AdMob |
+
+**Since:** 1.0.0
 
 --------------------
 
@@ -67,9 +81,13 @@ configure(config: AdMobConfig) => Promise<void>
 configRequest(requestConfig: RequestConfig) => Promise<void>
 ```
 
-| Param               | Type                                                    |
-| ------------------- | ------------------------------------------------------- |
-| **`requestConfig`** | <code><a href="#requestconfig">RequestConfig</a></code> |
+Configure ad request settings.
+
+| Param               | Type                                                    | Description                     |
+| ------------------- | ------------------------------------------------------- | ------------------------------- |
+| **`requestConfig`** | <code><a href="#requestconfig">RequestConfig</a></code> | - Request configuration options |
+
+**Since:** 1.0.0
 
 --------------------
 
@@ -80,9 +98,13 @@ configRequest(requestConfig: RequestConfig) => Promise<void>
 adCreate<O extends MobileAdOptions>(opts: O) => Promise<void>
 ```
 
-| Param      | Type           |
-| ---------- | -------------- |
-| **`opts`** | <code>O</code> |
+Create a new ad instance.
+
+| Param      | Type           | Description                                         |
+| ---------- | -------------- | --------------------------------------------------- |
+| **`opts`** | <code>O</code> | - Options for creating the ad, including ad unit ID |
+
+**Since:** 1.0.0
 
 --------------------
 
@@ -93,12 +115,16 @@ adCreate<O extends MobileAdOptions>(opts: O) => Promise<void>
 adIsLoaded(opts: { id: number; }) => Promise<boolean>
 ```
 
-| Param      | Type                         |
-| ---------- | ---------------------------- |
-| **`opts`** | <code>{ id: number; }</code> |
+Check if an ad is loaded and ready to be shown.
+
+| Param      | Type                         | Description                   |
+| ---------- | ---------------------------- | ----------------------------- |
+| **`opts`** | <code>{ id: number; }</code> | - Object containing the ad ID |
 
 **Returns:** <code>Promise&lt;boolean&gt;</code>
 
+**Since:** 1.0.0
+
 --------------------
 
 
@@ -108,9 +134,13 @@ adIsLoaded(opts: { id: number; }) => Promise<boolean>
 adLoad(opts: { id: number; }) => Promise<void>
 ```
 
-| Param      | Type                         |
-| ---------- | ---------------------------- |
-| **`opts`** | <code>{ id: number; }</code> |
+Load an ad.
+
+| Param      | Type                         | Description                   |
+| ---------- | ---------------------------- | ----------------------------- |
+| **`opts`** | <code>{ id: number; }</code> | - Object containing the ad ID |
+
+**Since:** 1.0.0
 
 --------------------
 
@@ -121,9 +151,13 @@ adLoad(opts: { id: number; }) => Promise<void>
 adShow(opts: { id: number; }) => Promise<void>
 ```
 
-| Param      | Type                         |
-| ---------- | ---------------------------- |
-| **`opts`** | <code>{ id: number; }</code> |
+Show a loaded ad.
+
+| Param      | Type                         | Description                   |
+| ---------- | ---------------------------- | ----------------------------- |
+| **`opts`** | <code>{ id: number; }</code> | - Object containing the ad ID |
+
+**Since:** 1.0.0
 
 --------------------
 
@@ -134,9 +168,13 @@ adShow(opts: { id: number; }) => Promise<void>
 adHide(opts: { id: number; }) => Promise<void>
 ```
 
-| Param      | Type                         |
-| ---------- | ---------------------------- |
-| **`opts`** | <code>{ id: number; }</code> |
+Hide a currently displayed ad.
+
+| Param      | Type                         | Description                   |
+| ---------- | ---------------------------- | ----------------------------- |
+| **`opts`** | <code>{ id: number; }</code> | - Object containing the ad ID |
+
+**Since:** 1.0.0
 
 --------------------
 
@@ -147,8 +185,12 @@ adHide(opts: { id: number; }) => Promise<void>
 trackingAuthorizationStatus() => Promise<{ status: TrackingAuthorizationStatus | false; }>
 ```
 
+Get the current tracking authorization status (iOS only).
+
 **Returns:** <code>Promise&lt;{ status: false | <a href="#trackingauthorizationstatus">TrackingAuthorizationStatus</a>; }&gt;</code>
 
+**Since:** 1.0.0
+
 --------------------
 
 
@@ -158,8 +200,12 @@ trackingAuthorizationStatus() => Promise<{ status: TrackingAuthorizationStatus |
 requestTrackingAuthorization() => Promise<{ status: TrackingAuthorizationStatus | false; }>
 ```
 
+Request tracking authorization from the user (iOS only).
+
 **Returns:** <code>Promise&lt;{ status: false | <a href="#trackingauthorizationstatus">TrackingAuthorizationStatus</a>; }&gt;</code>
 
+**Since:** 1.0.0
+
 --------------------
 
 
@@ -169,13 +215,17 @@ requestTrackingAuthorization() => Promise<{ status: TrackingAuthorizationStatus
 addListener(eventName: string, listenerFunc: (event: any) => void) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
-| Param              | Type                                 |
-| ------------------ | ------------------------------------ |
-| **`eventName`**    | <code>string</code>                  |
-| **`listenerFunc`** | <code>(event: any) =&gt; void</code> |
+Add a listener for ad events.
+
+| Param              | Type                                 | Description                                  |
+| ------------------ | ------------------------------------ | -------------------------------------------- |
+| **`eventName`**    | <code>string</code>                  | - The name of the event to listen for        |
+| **`listenerFunc`** | <code>(event: any) =&gt; void</code> | - The function to call when the event occurs |
 
 **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
 
+**Since:** 1.0.0
+
 --------------------
 
 
@@ -185,10 +235,12 @@ addListener(eventName: string, listenerFunc: (event: any) => void) => Promise<Pl
 getPluginVersion() => Promise<{ version: string; }>
 ```
 
-Get the native Capacitor plugin version
+Get the native Capacitor plugin version.
 
 **Returns:** <code>Promise&lt;{ version: string; }&gt;</code>
 
+**Since:** 1.0.0
+
 --------------------
 
 
@@ -207,17 +259,23 @@ Get the native Capacitor plugin version
 
 #### AdMobConfig
 
-<code>{ appMuted?: boolean; appVolume?: number; }</code>
+Configuration options for AdMob.
+
+<code>{ /** Whether the app should be muted */ appMuted?: boolean; /** The app volume (0.0 to 1.0) */ appVolume?: number; }</code>
 
 
 #### RequestConfig
 
-<code>{ maxAdContentRating?: <a href="#maxadcontentrating">MaxAdContentRating</a>; sameAppKey?: boolean; tagForChildDirectedTreatment?: boolean | null; tagForUnderAgeOfConsent?: boolean | null; testDeviceIds?: string[]; }</code>
+Configuration for ad requests.
+
+<code>{ /** Maximum ad content rating */ maxAdContentRating?: <a href="#maxadcontentrating">MaxAdContentRating</a>; /** Whether to use the same app key */ sameAppKey?: boolean; /** Tag for child-directed treatment (true, false, or null for unspecified) */ tagForChildDirectedTreatment?: boolean | null; /** Tag for under age of consent (true, false, or null for unspecified) */ tagForUnderAgeOfConsent?: boolean | null; /** Array of test device IDs */ testDeviceIds?: string[]; }</code>
 
 
 #### MobileAdOptions
 
-<code>{ adUnitId: string }</code>
+Base options for mobile ads.
+
+<code>{ /** The ad unit ID from AdMob */ adUnitId: string; }</code>
 
 
 ### Enums
@@ -225,22 +283,22 @@ Get the native Capacitor plugin version
 
 #### MaxAdContentRating
 
-| Members           | Value             |
-| ----------------- | ----------------- |
-| **`G`**           | <code>'G'</code>  |
-| **`MA`**          | <code>'MA'</code> |
-| **`PG`**          | <code>'PG'</code> |
-| **`T`**           | <code>'T'</code>  |
-| **`UNSPECIFIED`** | <code>''</code>   |
+| Members           | Value             | Description        |
+| ----------------- | ----------------- | ------------------ |
+| **`G`**           | <code>'G'</code>  | General Audiences  |
+| **`MA`**          | <code>'MA'</code> | Mature Audiences   |
+| **`PG`**          | <code>'PG'</code> | Parental Guidance  |
+| **`T`**           | <code>'T'</code>  | Teen               |
+| **`UNSPECIFIED`** | <code>''</code>   | Unspecified rating |
 
 
 #### TrackingAuthorizationStatus
 
-| Members             | Value          |
-| ------------------- | -------------- |
-| **`notDetermined`** | <code>0</code> |
-| **`restricted`**    | <code>1</code> |
-| **`denied`**        | <code>2</code> |
-| **`authorized`**    | <code>3</code> |
+| Members             | Value          | Description                                                |
+| ------------------- | -------------- | ---------------------------------------------------------- |
+| **`notDetermined`** | <code>0</code> | User has not yet received an authorization request         |
+| **`restricted`**    | <code>1</code> | User restricted, device is unable to provide authorization |
+| **`denied`**        | <code>2</code> | User denied authorization                                  |
+| **`authorized`**    | <code>3</code> | User authorized access                                     |
 
 </docgen-api>

package/android/src/main/kotlin/admob/plus/capacitor/AdMobPlusPlugin.kt

@@ -19,6 +19,7 @@ import org.json.JSONObject
 
 @CapacitorPlugin(name = "AdMobPlus")
 class AdMobPlusPlugin : Plugin(), Helper.Adapter {
+    private val pluginVersion = "7.4.1"
     private var helper: Helper? = null
     override fun load() {
         super.load()
@@ -144,4 +145,15 @@ class AdMobPlusPlugin : Plugin(), Helper.Adapter {
             e.printStackTrace()
         }
     }
+
+    @PluginMethod
+    fun getPluginVersion(call: PluginCall) {
+        try {
+            val ret = JSObject()
+            ret.put("version", pluginVersion)
+            call.resolve(ret)
+        } catch (e: Exception) {
+            call.reject("Could not get plugin version", e)
+        }
+    }
 }