@capgo/capacitor-admob 7.1.1 → 7.4.4

package/dist/docs.json

@@ -2,16 +2,38 @@
   "api": {
     "name": "AdMobPlusPlugin",
     "slug": "admobplusplugin",
-    "docs": "",
-    "tags": [],
+    "docs": "AdMob Plus Plugin interface for displaying Google AdMob ads in Capacitor apps.",
+    "tags": [
+      {
+        "text": "1.0.0",
+        "name": "since"
+      }
+    ],
     "methods": [
       {
         "name": "start",
         "signature": "() => Promise<void>",
         "parameters": [],
         "returns": "Promise<void>",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves when the SDK is initialized"
+          },
+          {
+            "name": "throws",
+            "text": "Error if initialization fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait AdMob.start();\n```"
+          }
+        ],
+        "docs": "Initialize and start the AdMob SDK.",
         "complexTypes": [],
         "slug": "start"
       },
@@ -21,13 +43,34 @@
         "parameters": [
           {
             "name": "config",
-            "docs": "",
+            "docs": "- Configuration options for AdMob",
             "type": "AdMobConfig"
           }
         ],
         "returns": "Promise<void>",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "param",
+            "text": "config - Configuration options for AdMob"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when configuration is applied"
+          },
+          {
+            "name": "throws",
+            "text": "Error if configuration fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait AdMob.configure({\n  appMuted: false,\n  appVolume: 0.5\n});\n```"
+          }
+        ],
+        "docs": "Configure AdMob settings.",
         "complexTypes": [
           "AdMobConfig"
         ],
@@ -39,13 +82,34 @@
         "parameters": [
           {
             "name": "requestConfig",
-            "docs": "",
+            "docs": "- Request configuration options",
             "type": "RequestConfig"
           }
         ],
         "returns": "Promise<void>",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "param",
+            "text": "requestConfig - Request configuration options"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when request configuration is applied"
+          },
+          {
+            "name": "throws",
+            "text": "Error if configuration fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait AdMob.configRequest({\n  maxAdContentRating: MaxAdContentRating.PG,\n  tagForChildDirectedTreatment: true,\n  testDeviceIds: ['test-device-id']\n});\n```"
+          }
+        ],
+        "docs": "Configure ad request settings.",
         "complexTypes": [
           "RequestConfig"
         ],
@@ -57,13 +121,34 @@
         "parameters": [
           {
             "name": "opts",
-            "docs": "",
+            "docs": "- Options for creating the ad, including ad unit ID",
             "type": "O"
           }
         ],
         "returns": "Promise<void>",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "param",
+            "text": "opts - Options for creating the ad, including ad unit ID"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when the ad is created"
+          },
+          {
+            "name": "throws",
+            "text": "Error if ad creation fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait AdMob.adCreate({\n  adUnitId: 'ca-app-pub-3940256099942544/1033173712'\n});\n```"
+          }
+        ],
+        "docs": "Create a new ad instance.",
         "complexTypes": [
           "MobileAdOptions",
           "O"
@@ -76,13 +161,34 @@
         "parameters": [
           {
             "name": "opts",
-            "docs": "",
+            "docs": "- Object containing the ad ID",
             "type": "{ id: number; }"
           }
         ],
         "returns": "Promise<boolean>",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "param",
+            "text": "opts - Object containing the ad ID"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves to true if the ad is loaded, false otherwise"
+          },
+          {
+            "name": "throws",
+            "text": "Error if checking load status fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst isLoaded = await AdMob.adIsLoaded({ id: 1 });\nif (isLoaded) {\n  await AdMob.adShow({ id: 1 });\n}\n```"
+          }
+        ],
+        "docs": "Check if an ad is loaded and ready to be shown.",
         "complexTypes": [],
         "slug": "adisloaded"
       },
@@ -92,13 +198,34 @@
         "parameters": [
           {
             "name": "opts",
-            "docs": "",
+            "docs": "- Object containing the ad ID",
             "type": "{ id: number; }"
           }
         ],
         "returns": "Promise<void>",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "param",
+            "text": "opts - Object containing the ad ID"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when the ad is loaded"
+          },
+          {
+            "name": "throws",
+            "text": "Error if ad loading fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait AdMob.adLoad({ id: 1 });\n```"
+          }
+        ],
+        "docs": "Load an ad.",
         "complexTypes": [],
         "slug": "adload"
       },
@@ -108,13 +235,34 @@
         "parameters": [
           {
             "name": "opts",
-            "docs": "",
+            "docs": "- Object containing the ad ID",
             "type": "{ id: number; }"
           }
         ],
         "returns": "Promise<void>",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "param",
+            "text": "opts - Object containing the ad ID"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when the ad is shown"
+          },
+          {
+            "name": "throws",
+            "text": "Error if showing the ad fails or if the ad is not loaded"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait AdMob.adShow({ id: 1 });\n```"
+          }
+        ],
+        "docs": "Show a loaded ad.",
         "complexTypes": [],
         "slug": "adshow"
       },
@@ -124,13 +272,34 @@
         "parameters": [
           {
             "name": "opts",
-            "docs": "",
+            "docs": "- Object containing the ad ID",
             "type": "{ id: number; }"
           }
         ],
         "returns": "Promise<void>",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "param",
+            "text": "opts - Object containing the ad ID"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when the ad is hidden"
+          },
+          {
+            "name": "throws",
+            "text": "Error if hiding the ad fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait AdMob.adHide({ id: 1 });\n```"
+          }
+        ],
+        "docs": "Hide a currently displayed ad.",
         "complexTypes": [],
         "slug": "adhide"
       },
@@ -139,8 +308,25 @@
         "signature": "() => Promise<{ status: TrackingAuthorizationStatus | false; }>",
         "parameters": [],
         "returns": "Promise<{ status: false | TrackingAuthorizationStatus; }>",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the current tracking authorization status"
+          },
+          {
+            "name": "throws",
+            "text": "Error if getting status fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { status } = await AdMob.trackingAuthorizationStatus();\nif (status === TrackingAuthorizationStatus.notDetermined) {\n  await AdMob.requestTrackingAuthorization();\n}\n```"
+          }
+        ],
+        "docs": "Get the current tracking authorization status (iOS only).",
         "complexTypes": [
           "TrackingAuthorizationStatus"
         ],
@@ -151,8 +337,25 @@
         "signature": "() => Promise<{ status: TrackingAuthorizationStatus | false; }>",
         "parameters": [],
         "returns": "Promise<{ status: false | TrackingAuthorizationStatus; }>",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the tracking authorization status after the request"
+          },
+          {
+            "name": "throws",
+            "text": "Error if the request fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { status } = await AdMob.requestTrackingAuthorization();\nconsole.log('User tracking status:', status);\n```"
+          }
+        ],
+        "docs": "Request tracking authorization from the user (iOS only).",
         "complexTypes": [
           "TrackingAuthorizationStatus"
         ],
@@ -164,18 +367,39 @@
         "parameters": [
           {
             "name": "eventName",
-            "docs": "",
+            "docs": "- The name of the event to listen for",
             "type": "string"
           },
           {
             "name": "listenerFunc",
-            "docs": "",
+            "docs": "- The function to call when the event occurs",
             "type": "(event: any) => void"
           }
         ],
         "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName - The name of the event to listen for"
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc - The function to call when the event occurs"
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves to a listener handle"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst listener = await AdMob.addListener('adLoaded', (event) => {\n  console.log('Ad loaded:', event);\n});\n\n// Remove listener when done\nawait listener.remove();\n```"
+          }
+        ],
+        "docs": "Add a listener for ad events.",
         "complexTypes": [
           "PluginListenerHandle"
         ],
@@ -189,14 +413,22 @@
         "tags": [
           {
             "name": "returns",
-            "text": "an Promise with version for this device"
+            "text": "Promise that resolves with the plugin version"
           },
           {
             "name": "throws",
-            "text": "An error if the something went wrong"
+            "text": "Error if getting the version fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { version } = await AdMob.getPluginVersion();\nconsole.log('Plugin version:', version);\n```"
           }
         ],
-        "docs": "Get the native Capacitor plugin version",
+        "docs": "Get the native Capacitor plugin version.",
         "complexTypes": [],
         "slug": "getpluginversion"
       }
@@ -230,31 +462,31 @@
           "name": "G",
           "value": "'G'",
           "tags": [],
-          "docs": ""
+          "docs": "General Audiences"
         },
         {
           "name": "MA",
           "value": "'MA'",
           "tags": [],
-          "docs": ""
+          "docs": "Mature Audiences"
         },
         {
           "name": "PG",
           "value": "'PG'",
           "tags": [],
-          "docs": ""
+          "docs": "Parental Guidance"
         },
         {
           "name": "T",
           "value": "'T'",
           "tags": [],
-          "docs": ""
+          "docs": "Teen"
         },
         {
           "name": "UNSPECIFIED",
           "value": "''",
           "tags": [],
-          "docs": ""
+          "docs": "Unspecified rating"
         }
       ]
     },
@@ -266,25 +498,25 @@
           "name": "notDetermined",
           "value": "0",
           "tags": [],
-          "docs": ""
+          "docs": "User has not yet received an authorization request"
         },
         {
           "name": "restricted",
           "value": "1",
           "tags": [],
-          "docs": ""
+          "docs": "User restricted, device is unable to provide authorization"
         },
         {
           "name": "denied",
           "value": "2",
           "tags": [],
-          "docs": ""
+          "docs": "User denied authorization"
         },
         {
           "name": "authorized",
           "value": "3",
           "tags": [],
-          "docs": ""
+          "docs": "User authorized access"
         }
       ]
     }
@@ -293,10 +525,10 @@
     {
       "name": "AdMobConfig",
       "slug": "admobconfig",
-      "docs": "",
+      "docs": "Configuration options for AdMob.",
       "types": [
         {
-          "text": "{\n  appMuted?: boolean;\n  appVolume?: number;\n}",
+          "text": "{\n  /** Whether the app should be muted */\n  appMuted?: boolean;\n  /** The app volume (0.0 to 1.0) */\n  appVolume?: number;\n}",
           "complexTypes": []
         }
       ]
@@ -304,10 +536,10 @@
     {
       "name": "RequestConfig",
       "slug": "requestconfig",
-      "docs": "",
+      "docs": "Configuration for ad requests.",
       "types": [
         {
-          "text": "{\n  maxAdContentRating?: MaxAdContentRating;\n  sameAppKey?: boolean;\n  tagForChildDirectedTreatment?: boolean | null;\n  tagForUnderAgeOfConsent?: boolean | null;\n  testDeviceIds?: string[];\n}",
+          "text": "{\n  /** Maximum ad content rating */\n  maxAdContentRating?: MaxAdContentRating;\n  /** Whether to use the same app key */\n  sameAppKey?: boolean;\n  /** Tag for child-directed treatment (true, false, or null for unspecified) */\n  tagForChildDirectedTreatment?: boolean | null;\n  /** Tag for under age of consent (true, false, or null for unspecified) */\n  tagForUnderAgeOfConsent?: boolean | null;\n  /** Array of test device IDs */\n  testDeviceIds?: string[];\n}",
           "complexTypes": [
             "MaxAdContentRating"
           ]
@@ -317,10 +549,10 @@
     {
       "name": "MobileAdOptions",
       "slug": "mobileadoptions",
-      "docs": "",
+      "docs": "Base options for mobile ads.",
       "types": [
         {
-          "text": "{ adUnitId: string }",
+          "text": "{\n  /** The ad unit ID from AdMob */\n  adUnitId: string;\n}",
           "complexTypes": []
         }
       ]