@ququplay/admob 7.0.3 → 7.2.1

package/dist/docs.json

@@ -4,6 +4,13 @@
     "slug": "admobplugin",
     "docs": "",
     "tags": [],
+    "extends": [
+      "BannerDefinitions",
+      "RewardDefinitions",
+      "RewardInterstitialDefinitions",
+      "InterstitialDefinitions",
+      "AdmobConsentDefinitions"
+    ],
     "methods": [
       {
         "name": "initialize",
@@ -72,7 +79,7 @@
             "text": "5.2.0"
           }
         ],
-        "docs": "request requestTrackingAuthorization (iOS >14).\nThis is deprecated method. We recommend UMP Consent.",
+        "docs": "request requestTrackingAuthorization (iOS >14).",
         "complexTypes": [],
         "slug": "requesttrackingauthorization"
       },
@@ -498,6 +505,25 @@
         ],
         "slug": "requestconsentinfo"
       },
+      {
+        "name": "showPrivacyOptionsForm",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "group",
+            "text": "Consent"
+          },
+          {
+            "name": "since",
+            "text": "7.0.3"
+          }
+        ],
+        "docs": "Shows a google privacy options form (rendered from your GDPR message config).",
+        "complexTypes": [],
+        "slug": "showprivacyoptionsform"
+      },
       {
         "name": "showConsentForm",
         "signature": "() => Promise<AdmobConsentInfo>",
@@ -1115,20 +1141,7 @@
         "slug": "addlistenerrewardinterstitialadplugineventsshowed-"
       }
     ],
-    "properties": [],
-    "importObject": [
-      "BannerDefinitions",
-      "AdmobConsentDefinitions",
-      "InterstitialDefinitions",
-      "RewardDefinitions",
-      "RewardInterstitialDefinitions",
-      "TrackingAuthorizationStatusInterface",
-      "AdMobDefinitions",
-      "AdMobInitializationOptions",
-      "MaxAdContentRating",
-      "ApplicationMutedOptions",
-      "ApplicationVolumeOptions"
-    ]
+    "properties": []
   },
   "interfaces": [
     {
@@ -1136,6 +1149,7 @@
       "slug": "admobinitializationoptions",
       "docs": "",
       "tags": [],
+      "extends": [],
       "methods": [],
       "properties": [
         {
@@ -1224,19 +1238,6 @@
           ],
           "type": "MaxAdContentRating"
         }
-      ],
-      "importObject": [
-        "BannerDefinitions",
-        "AdmobConsentDefinitions",
-        "InterstitialDefinitions",
-        "RewardDefinitions",
-        "RewardInterstitialDefinitions",
-        "TrackingAuthorizationStatusInterface",
-        "AdMobDefinitions",
-        "AdMobPlugin",
-        "MaxAdContentRating",
-        "ApplicationMutedOptions",
-        "ApplicationVolumeOptions"
       ]
     },
     {
@@ -1249,6 +1250,7 @@
           "name": "url"
         }
       ],
+      "extends": [],
       "methods": [],
       "properties": [
         {
@@ -1258,14 +1260,14 @@
           "complexTypes": [],
           "type": "'authorized' | 'denied' | 'notDetermined' | 'restricted'"
         }
-      ],
-      "importObject": []
+      ]
     },
     {
       "name": "ApplicationMutedOptions",
       "slug": "applicationmutedoptions",
       "docs": "",
       "tags": [],
+      "extends": [],
       "methods": [],
       "properties": [
         {
@@ -1284,19 +1286,6 @@
           "complexTypes": [],
           "type": "boolean | undefined"
         }
-      ],
-      "importObject": [
-        "BannerDefinitions",
-        "AdmobConsentDefinitions",
-        "InterstitialDefinitions",
-        "RewardDefinitions",
-        "RewardInterstitialDefinitions",
-        "TrackingAuthorizationStatusInterface",
-        "AdMobDefinitions",
-        "AdMobPlugin",
-        "AdMobInitializationOptions",
-        "MaxAdContentRating",
-        "ApplicationVolumeOptions"
       ]
     },
     {
@@ -1304,6 +1293,7 @@
       "slug": "applicationvolumeoptions",
       "docs": "",
       "tags": [],
+      "extends": [],
       "methods": [],
       "properties": [
         {
@@ -1322,19 +1312,6 @@
           "complexTypes": [],
           "type": "0 | 1 | 0.1 | 0.2 | 0.3 | 0.4 | 0.5 | 0.6 | 0.7 | 0.8 | 0.9 | undefined"
         }
-      ],
-      "importObject": [
-        "BannerDefinitions",
-        "AdmobConsentDefinitions",
-        "InterstitialDefinitions",
-        "RewardDefinitions",
-        "RewardInterstitialDefinitions",
-        "TrackingAuthorizationStatusInterface",
-        "AdMobDefinitions",
-        "AdMobPlugin",
-        "AdMobInitializationOptions",
-        "MaxAdContentRating",
-        "ApplicationMutedOptions"
       ]
     },
     {
@@ -1342,6 +1319,9 @@
       "slug": "banneradoptions",
       "docs": "This interface extends AdOptions",
       "tags": [],
+      "extends": [
+        "AdOptions"
+      ],
       "methods": [],
       "properties": [
         {
@@ -1379,12 +1359,99 @@
             "BannerAdPosition"
           ],
           "type": "BannerAdPosition"
+        },
+        {
+          "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"
         }
-      ],
-      "importObject": [
-        "AdOptions",
-        "BannerAdPosition",
-        "BannerAdSize"
       ]
     },
     {
@@ -1392,6 +1459,7 @@
       "slug": "pluginlistenerhandle",
       "docs": "",
       "tags": [],
+      "extends": [],
       "methods": [],
       "properties": [
         {
@@ -1401,17 +1469,6 @@
           "complexTypes": [],
           "type": "() => Promise<void>"
         }
-      ],
-      "importObject": [
-        "CapacitorException",
-        "CapacitorGlobal",
-        "RegisterPlugin",
-        "PluginImplementations",
-        "Plugin",
-        "PermissionState",
-        "PluginResultData",
-        "PluginResultError",
-        "PluginCallback"
       ]
     },
     {
@@ -1419,6 +1476,7 @@
       "slug": "admobbannersize",
       "docs": "When notice listener of OnAdLoaded, you can get banner size.",
       "tags": [],
+      "extends": [],
       "methods": [],
       "properties": [
         {
@@ -1435,14 +1493,14 @@
           "complexTypes": [],
           "type": "number"
         }
-      ],
-      "importObject": []
+      ]
     },
     {
       "name": "AdMobError",
       "slug": "admoberror",
       "docs": "For more information\r\nhttps://developers.google.com/android/reference/com/google/android/gms/ads/AdError",
       "tags": [],
+      "extends": [],
       "methods": [],
       "properties": [
         {
@@ -1459,14 +1517,14 @@
           "complexTypes": [],
           "type": "string"
         }
-      ],
-      "importObject": []
+      ]
     },
     {
       "name": "AdmobConsentInfo",
       "slug": "admobconsentinfo",
       "docs": "",
       "tags": [],
+      "extends": [],
       "methods": [],
       "properties": [
         {
@@ -1494,10 +1552,33 @@
           "docs": "If `true` a consent form is available and vice versa.",
           "complexTypes": [],
           "type": "boolean | undefined"
+        },
+        {
+          "name": "canRequestAds",
+          "tags": [
+            {
+              "text": "7.0.3",
+              "name": "since"
+            }
+          ],
+          "docs": "If `true` an ad can be shown.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "privacyOptionsRequirementStatus",
+          "tags": [
+            {
+              "text": "7.0.3",
+              "name": "since"
+            }
+          ],
+          "docs": "Privacy options requirement status of the user.",
+          "complexTypes": [
+            "PrivacyOptionsRequirementStatus"
+          ],
+          "type": "PrivacyOptionsRequirementStatus"
         }
-      ],
-      "importObject": [
-        "AdmobConsentStatus"
       ]
     },
     {
@@ -1505,6 +1586,7 @@
       "slug": "admobconsentrequestoptions",
       "docs": "",
       "tags": [],
+      "extends": [],
       "methods": [],
       "properties": [
         {
@@ -1549,9 +1631,6 @@
           "complexTypes": [],
           "type": "boolean | undefined"
         }
-      ],
-      "importObject": [
-        "AdmobConsentDebugGeography"
       ]
     },
     {
@@ -1559,6 +1638,7 @@
       "slug": "adloadinfo",
       "docs": "",
       "tags": [],
+      "extends": [],
       "methods": [],
       "properties": [
         {
@@ -1568,14 +1648,14 @@
           "complexTypes": [],
           "type": "string"
         }
-      ],
-      "importObject": []
+      ]
     },
     {
       "name": "AdOptions",
       "slug": "adoptions",
       "docs": "",
       "tags": [],
+      "extends": [],
       "methods": [],
       "properties": [
         {
@@ -1622,7 +1702,7 @@
               "name": "since"
             }
           ],
-          "docs": "Margin Banner. Default is 0px;\r\nIf position is BOTTOM_CENTER, margin is be margin-bottom.\r\nIf position is TOP_CENTER, margin is be margin-top.",
+          "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"
         },
@@ -1646,18 +1726,40 @@
               "name": "since"
             }
           ],
-          "docs": "The default behavior of the Google Mobile Ads SDK is to serve personalized ads.\r\nSet this to true to request Non-Personalized Ads",
+          "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"
         }
-      ],
-      "importObject": []
+      ]
     },
     {
       "name": "RewardAdOptions",
       "slug": "rewardadoptions",
       "docs": "",
       "tags": [],
+      "extends": [
+        "AdOptions"
+      ],
       "methods": [],
       "properties": [
         {
@@ -1673,11 +1775,99 @@
             "AtLeastOne"
           ],
           "type": "AtLeastOne<{\n    /**\n     * An optional UserId to pass to your SSV callback function.\n     */\n    userId: string;\n    /**\n     * An optional custom set of data to pass to your SSV callback function.\n     */\n    customData: string;\n  }>"
+        },
+        {
+          "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"
         }
-      ],
-      "importObject": [
-        "AdOptions",
-        "AtLeastOne"
       ]
     },
     {
@@ -1685,6 +1875,7 @@
       "slug": "admobrewarditem",
       "docs": "For more information\r\nhttps://developers.google.com/admob/android/rewarded-video-adapters?hl=en",
       "tags": [],
+      "extends": [],
       "methods": [],
       "properties": [
         {
@@ -1701,14 +1892,16 @@
           "complexTypes": [],
           "type": "number"
         }
-      ],
-      "importObject": []
+      ]
     },
     {
       "name": "RewardInterstitialAdOptions",
       "slug": "rewardinterstitialadoptions",
       "docs": "",
       "tags": [],
+      "extends": [
+        "AdOptions"
+      ],
       "methods": [],
       "properties": [
         {
@@ -1724,11 +1917,99 @@
             "AtLeastOne"
           ],
           "type": "AtLeastOne<{\n    /**\n     * An optional UserId to pass to your SSV callback function.\n     */\n    userId: string;\n    /**\n     * An optional custom set of data to pass to your SSV callback function.\n     */\n    customData: string;\n  }>"
+        },
+        {
+          "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"
         }
-      ],
-      "importObject": [
-        "AdOptions",
-        "AtLeastOne"
       ]
     },
     {
@@ -1736,6 +2017,7 @@
       "slug": "admobrewardinterstitialitem",
       "docs": "For more information\nhttps://developers.google.com/admob/android/rewarded-video-adapters?hl=en",
       "tags": [],
+      "extends": [],
       "methods": [],
       "properties": [
         {
@@ -1752,8 +2034,7 @@
           "complexTypes": [],
           "type": "number"
         }
-      ],
-      "importObject": []
+      ]
     }
   ],
   "enums": [
@@ -1936,6 +2217,30 @@
         }
       ]
     },
+    {
+      "name": "PrivacyOptionsRequirementStatus",
+      "slug": "privacyoptionsrequirementstatus",
+      "members": [
+        {
+          "name": "NOT_REQUIRED",
+          "value": "'NOT_REQUIRED'",
+          "tags": [],
+          "docs": "Privacy options entry point is not required."
+        },
+        {
+          "name": "REQUIRED",
+          "value": "'REQUIRED'",
+          "tags": [],
+          "docs": "Privacy options entry point is required."
+        },
+        {
+          "name": "UNKNOWN",
+          "value": "'UNKNOWN'",
+          "tags": [],
+          "docs": "Privacy options requirement status is unknown."
+        }
+      ]
+    },
     {
       "name": "AdmobConsentDebugGeography",
       "slug": "admobconsentdebuggeography",
@@ -1955,8 +2260,24 @@
         {
           "name": "NOT_EEA",
           "value": "2",
-          "tags": [],
+          "tags": [
+            {
+              "name": "deprecated"
+            }
+          ],
           "docs": "Geography appears as not in EEA for debug devices."
+        },
+        {
+          "name": "US",
+          "value": "3",
+          "tags": [],
+          "docs": "Geography appears as in regulated US state for debug devices."
+        },
+        {
+          "name": "OTHER",
+          "value": "4",
+          "tags": [],
+          "docs": "Geography appears as OTHER state for debug devices."
         }
       ]
     },