# @capacitor-community/admob 中文文档

规范地址：https://npmcn.com/package/%40capacitor-community/admob/

版本：8\.4\.0
npm 元数据更新时间：2026-11-16T11:54:00.884Z
中文译文更新时间：2026-11-16T11:56:39.546Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40capacitor-community/admob
原文对照：https://npmcn.com/package/%40capacitor-community/admob/?lang=original
项目主页：https://docs.rdlabo.dev/projects/capacitor-admob
源码仓库：https://github.com/capacitor-community/admob

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1 MB，251 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：3 个
- 首次发布：2020-06-27T01:38:04.085Z
- 最新版本发布：2026-11-16T11:54:00.518Z
- 近 30 天下载量：373053（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：99（近 12 个月 39 个）

## 中文简介

AdMob 的本地插件

## 安装

```sh
npm install @capacitor-community/admob
```

也可以使用：`pnpm add @capacitor-community/admob`、`yarn add @capacitor-community/admob`、`bun add @capacitor-community/admob`

## README

  
![](https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png)

### 广告

**`@capacitor-community/admob`**

本地 AdMob 的电容社区插件 .

**[阅读全部文档](https://docs.rdlabo.dev/projects/capacitor-admob)**

![](https://img.shields.io/maintenance/yes/2026?style=flat-square) [![](https://img.shields.io/npm/l/@capacitor-community/admob?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/admob)  
[![](https://img.shields.io/npm/dw/@capacitor-community/admob?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/admob) [![](https://img.shields.io/npm/v/@capacitor-community/admob?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/admob)

## 维护者

| 维护者 | GitHub 图像 | 社会 | 网站 |
| --- | --- | --- | --- |
| 坂原正彦 | [德语](https://github.com/rdlabo) | [@rdlabo (中文(简体) )](https://twitter.com/rdlabo) | [(原始内容存档于2018-10-21). rdlabo.dev](https://rdlabo.dev/) |
| 萨尼恩·萨拉斯·迪亚斯 | [萨尼恩·萨拉斯·迪亚斯](https://github.com/distante) | [萨宁萨拉斯](https://twitter.com/SaninnSalas) | —— 说 |

维持状况:积极维持

## 贡献者

[![](https://contrib.rocks/image?repo=capacitor-community/admob)](https://github.com/capacitor-community/admob/graphs/contributors)

制造的 [贡献者-img](https://contrib.rocks/)。 。 。 .

## 演示

[解码器在这里.](https://github.com/capacitor-community/admob/tree/main/demo)

### 截图

|  | 横幅 | 暂停 | 奖励 | App 打开 |
| --- | --- | --- | --- | --- |
| **iOS系统** | ![](https://npmcn.com/package/%40capacitor-community/admob/demo/screenshots/ios_banner.png) | ![](https://npmcn.com/package/%40capacitor-community/admob/demo/screenshots/ios_interstitial.png) | ![](https://npmcn.com/package/%40capacitor-community/admob/demo/screenshots/ios_reward.png) | ![](https://npmcn.com/package/%40capacitor-community/admob/demo/screenshots/ios_open.png) |
| **机器人** | ![](https://npmcn.com/package/%40capacitor-community/admob/demo/screenshots/md_banner.png) | ![](https://npmcn.com/package/%40capacitor-community/admob/demo/screenshots/md_interstitial.png) | ![](https://npmcn.com/package/%40capacitor-community/admob/demo/screenshots/md_reward.png) | ![](https://npmcn.com/package/%40capacitor-community/admob/demo/screenshots/md_open.png) |

## 概览

本地 AdMob 的电容社区插件 。 这个插件将Google Mobile Ads SDK包为iOS和Android,这样你就可以在Capacitor apps上显示横幅,间距,奖励,奖励间距,并应用开口的广告. 它还涵盖Google用户消息平台(UMP)的同意和iOS上的App Track透明帮助.

## 安装

这个插件已经将 Google Mobile Ads SDK 载入 。 安装软件包, 然后添加您的 AdMob **应用程序** 在AndroidManifest/Info.plist中识别身份. Google 开始的指南 [机器人](https://developers.google.com/admob/android/quick-start) 财务报告和审定财务报表 [iOS系统](https://developers.google.com/admob/ios/quick-start) 解释 app ID 和 SKadNetwork 标识符( Apple 的广告转换 ID); 不添加第二个 Mobile Ad 依赖性 .

此插件目标 `@capacitor-community/admob` **页:1** 和8.5或更后(在v8之内) 它支持iOS 15或后期和Android API 24或后期.

```bash
npm install @capacitor-community/admob
npx cap sync
```

如果您仍然使用 Capacitor 7, 安装 `@capacitor-community/admob@7`。 。 。 .

### 谷歌移动广告 SDK 版本

这个主要版本的针头 Google Mobile Ads SDK **25.4.x 信息技术** 机器人和 **13.11.0 国家** 在 iOS (Swift 软件包管理器和CocoaPods) 上。 离开这些版本 除非你有特别的需要。 谷歌的音乐 [Android 的下个 Gen SDK](https://developers.google.com/admob/android/next-gen) 等待到下一个插件主机。 见 [移徙](https://docs.rdlabo.dev/projects/capacitor-admob/docs/migration) 因为针后的政策.

### Android 配置

单位 `android/app/src/main/AndroidManifest.xml`,在 `<application>`数字 :

```xml
<meta-data
  android:name="com.google.android.gms.ads.APPLICATION_ID"
  android:value="@string/admob_app_id" />
```

单位 `android/app/src/main/res/values/strings.xml`数字 :

```xml
<string name="admob_app_id">[APP_ID]</string>
```

替换 `[APP_ID]` 与您的广告移动 **应用程序** 身份证 不是广告单位的身份证.

#### 变量

你可以离开这些未设置。 在你的应用程序中覆盖它们 `variables.gradle` 只有在您需要特定的文物版本时:

| 变量 | 艺术 | 默认 |
| --- | --- | --- |
| `playServicesAdsVersion` | `com.google.android.gms:play-services-ads` | `25.4.+` |
| `userMessagingPlatformVersion` | `com.google.android.ump:user-messaging-platform` | `4.0.0` |
| `androidxCoreKTXVersion` | `androidx.core:core-ktx` | `1.15.0` |

### iOS 配置

在最外侧处添加以下内容 `<dict>` 内 `ios/App/App/Info.plist`数字 :

```xml
<key>GADIsAdManagerApp</key>
<true/>
<key>GADApplicationIdentifier</key>
<string>[APP_ID]</string>
<key>SKAdNetworkItems</key>
<array>
  <dict>
    <key>SKAdNetworkIdentifier</key>
    <string>cstr6suwn9.skadnetwork</string>
  </dict>
</array>
<key>NSUserTrackingUsageDescription</key>
<string>This identifier will be used to deliver personalized ads to you.</string>
```

替换 `[APP_ID]` 使用您的 AdMob 应用程序标识,并描述您在 `NSUserTrackingUsageDescription`。 。 。 .

这个 `SKAdNetworkItems` 片段包括谷歌自己的标识符. 从 Google 添加其他ID [iOS 设置指南](https://developers.google.com/admob/ios/quick-start#update_your_infoplist)。 。 。 .

### 解决问题

如果可可花不能解决 `Google-Mobile-Ads-SDK`数字 :

```text
[error] Error running update: Analyzing dependencies
[!] CocoaPods could not find compatible versions for pod "Google-Mobile-Ads-SDK":
```

运行 `pod repo update` 内 `ios/`,则 `npx cap sync ios` 再来一次.

## 首个测试横幅

在安装和平台设置后,请求同意,在可能请求发布广告时初始化SDK,并显示Google演示横幅. 使用平台横幅 ID [测试](https://docs.rdlabo.dev/projects/capacitor-admob/docs/testing)——不要为首次检查创建自己的广告单位.

打电话 `startAdMob` 从用户动作或UI准备就绪后(例如按钮或后导航钩),而不仅仅是在模块评价时间.

```ts
import { Capacitor } from '@capacitor/core';
import { AdMob, AdmobConsentStatus, BannerAdOptions, BannerAdSize, BannerAdPosition } from '@capacitor-community/admob';

const bannerAdId =
  Capacitor.getPlatform() === 'ios'
    ? 'ca-app-pub-3940256099942544/2934735716'
    : 'ca-app-pub-3940256099942544/6300978111';

async function startAdMob() {
  let consentInfo = await AdMob.requestConsentInfo();
  if (consentInfo.isConsentFormAvailable && consentInfo.status === AdmobConsentStatus.REQUIRED) {
    consentInfo = await AdMob.showConsentForm();
  }

  if (!consentInfo.canRequestAds) {
    // Consent not ready — no banner is shown.
    return;
  }

  await AdMob.initialize();

  const options: BannerAdOptions = {
    adId: bannerAdId,
    adSize: BannerAdSize.ADAPTIVE_BANNER,
    position: BannerAdPosition.BOTTOM_CENTER,
    margin: 0,
  };
  await AdMob.showBanner(options);
}
```

预期结果:何时 `canRequestAds` 真实的, 在本地屏幕下方出现 Google 测试横幅 。 何时 `canRequestAds` 是不正确的,函数返回,没有显示横幅。 横幅坐落在WebView之上,可以覆盖 HTML - 见 [广告](https://docs.rdlabo.dev/projects/capacitor-admob/docs/banner) 设置您的布局 。 细节 : [配置](https://docs.rdlabo.dev/projects/capacitor-admob/docs/configuration), (中文(简体) ), [同意](https://docs.rdlabo.dev/projects/capacitor-admob/docs/consent),以及 [测试](https://docs.rdlabo.dev/projects/capacitor-admob/docs/testing)。 。 。 .

## 通过广告目标选择

| 目标 | 临时格式 | 指南 |
| --- | --- | --- |
| 在应用内容旁保持广告可见度 | 横幅 | [广告](https://docs.rdlabo.dev/projects/capacitor-admob/docs/banner) |
| 在自然休息时显示全屏广告而不给予奖励 | 暂停 | [暂停](https://docs.rdlabo.dev/projects/capacitor-admob/docs/interstitial) |
| 提供一份专门的奖励经验 | 奖励 | [奖励广告](https://docs.rdlabo.dev/projects/capacitor-admob/docs/rewarded) |
| 在自然过渡时提供奖励 | 奖励的间歇 | [奖励广告](https://docs.rdlabo.dev/projects/capacitor-admob/docs/rewarded) |
| 将一个开放的应用体验货币化 | App 打开 | [App 打开广告](https://docs.rdlabo.dev/projects/capacitor-admob/docs/app-open) |

## 文档

开始 [安装](https://npmcn.com/package/%40capacitor-community/admob/#readme-installation) 以上,则 [配置](https://docs.rdlabo.dev/projects/capacitor-admob/docs/configuration) 财务报告和审定财务报表 [同意](https://docs.rdlabo.dev/projects/capacitor-admob/docs/consent)。运行第一个测试横幅,然后使用 [测试](https://docs.rdlabo.dev/projects/capacitor-admob/docs/testing) 用于演示单元和设备。 从上表中选择一个广告格式。 同样的指南也载于 [文档网站](https://docs.rdlabo.dev/projects/capacitor-admob) (英语和日语). 如果您在 npm 打开了这个 README, 请使用该站点来向导 `docs/` 文件也包含在软件包中。 方法签名见以下API部分.

-   [配置](https://docs.rdlabo.dev/projects/capacitor-admob/docs/configuration) —— 说 `AdMob.initialize` 和SDK选项.
-   [同意](https://docs.rdlabo.dev/projects/capacitor-admob/docs/consent) ——隐私同意和iOS跟踪授权.
-   [测试](https://docs.rdlabo.dev/projects/capacitor-admob/docs/testing) 演示广告单位、测试装置和同意测试.
-   [广告](https://docs.rdlabo.dev/projects/capacitor-admob/docs/banner) ——旗帜选项,生命周期,事件.
-   [土著广告](https://npmcn.com/package/%40capacitor-community/admob/docs/native-ads.md) ——饲料放置,造型,生命周期等活动.
-   全屏广告:
    -   [暂停](https://docs.rdlabo.dev/projects/capacitor-admob/docs/interstitial) ——负载,展示,以及多部已准备好的广告.
    -   [奖励广告](https://docs.rdlabo.dev/projects/capacitor-admob/docs/rewarded) ——奖励视频,奖励互通,服务器侧核查.
-   [App 打开广告](https://docs.rdlabo.dev/projects/capacitor-admob/docs/app-open) ——负载并呈现在前地过渡上.
-   [特别活动](https://docs.rdlabo.dev/projects/capacitor-admob/docs/events) 共享生命周期事件、错误和收入数据.
-   [移徙指南](https://docs.rdlabo.dev/projects/capacitor-admob/docs/migration) ——在v8.2.0和早期版本中升级步骤和行为变化.

## 指数

-   [`initialize(...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-initialize)
-   [`trackingAuthorizationStatus()`](https://npmcn.com/package/%40capacitor-community/admob/#readme-trackingauthorizationstatus)
-   [`requestTrackingAuthorization()`](https://npmcn.com/package/%40capacitor-community/admob/#readme-requesttrackingauthorization)
-   [`setApplicationMuted(...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-setapplicationmuted)
-   [`setApplicationVolume(...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-setapplicationvolume)
-   [`loadAppOpen(...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-loadappopen)
-   [`showAppOpen(...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-showappopen)
-   [`isAppOpenLoaded(...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-isappopenloaded)
-   [`addListener(AppOpenAdPluginEvents.Loaded, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerappopenadplugineventsloaded-)
-   [`addListener(AppOpenAdPluginEvents.FailedToLoad, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerappopenadplugineventsfailedtoload-)
-   [`addListener(AppOpenAdPluginEvents.Opened, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerappopenadplugineventsopened-)
-   [`addListener(AppOpenAdPluginEvents.Closed, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerappopenadplugineventsclosed-)
-   [`addListener(AppOpenAdPluginEvents.FailedToShow, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerappopenadplugineventsfailedtoshow-)
-   [`addListener(AppOpenAdPluginEvents.AdImpression, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerappopenadplugineventsadimpression-)
-   [`showBanner(...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-showbanner)
-   [`hideBanner()`](https://npmcn.com/package/%40capacitor-community/admob/#readme-hidebanner)
-   [`resumeBanner()`](https://npmcn.com/package/%40capacitor-community/admob/#readme-resumebanner)
-   [`removeBanner()`](https://npmcn.com/package/%40capacitor-community/admob/#readme-removebanner)
-   [`prepareBanner(...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-preparebanner)
-   [`getAdaptiveBannerSize(...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-getadaptivebannersize)
-   [`getBannerSize()`](https://npmcn.com/package/%40capacitor-community/admob/#readme-getbannersize)
-   [`addListener(BannerAdPluginEvents.SizeChanged, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerbanneradplugineventssizechanged-)
-   [`addListener(BannerAdPluginEvents.Loaded, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerbanneradplugineventsloaded-)
-   [`addListener(BannerAdPluginEvents.FailedToLoad, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerbanneradplugineventsfailedtoload-)
-   [`addListener(BannerAdPluginEvents.Opened, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerbanneradplugineventsopened-)
-   [`addListener(BannerAdPluginEvents.Closed, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerbanneradplugineventsclosed-)
-   [`addListener(BannerAdPluginEvents.AdImpression, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerbanneradplugineventsadimpression-)
-   [`addListener(BannerAdPluginEvents.AdPaid, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerbanneradplugineventsadpaid-)
-   [`requestConsentInfo(...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-requestconsentinfo)
-   [`showPrivacyOptionsForm()`](https://npmcn.com/package/%40capacitor-community/admob/#readme-showprivacyoptionsform)
-   [`showConsentForm()`](https://npmcn.com/package/%40capacitor-community/admob/#readme-showconsentform)
-   [`resetConsentInfo()`](https://npmcn.com/package/%40capacitor-community/admob/#readme-resetconsentinfo)
-   [`prepareInterstitial(...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-prepareinterstitial)
-   [`showInterstitial(...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-showinterstitial)
-   [`addListener(InterstitialAdPluginEvents.FailedToLoad, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerinterstitialadplugineventsfailedtoload-)
-   [`addListener(InterstitialAdPluginEvents.Loaded, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerinterstitialadplugineventsloaded-)
-   [`addListener(InterstitialAdPluginEvents.Dismissed, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerinterstitialadplugineventsdismissed-)
-   [`addListener(InterstitialAdPluginEvents.FailedToShow, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerinterstitialadplugineventsfailedtoshow-)
-   [`addListener(InterstitialAdPluginEvents.Showed, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerinterstitialadplugineventsshowed-)
-   [`addListener(InterstitialAdPluginEvents.AdImpression, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerinterstitialadplugineventsadimpression-)
-   [`prepareRewardVideoAd(...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-preparerewardvideoad)
-   [`showRewardVideoAd(...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-showrewardvideoad)
-   [`addListener(RewardAdPluginEvents.adClicked, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerrewardadplugineventsadclicked-)
-   [`addListener(RewardAdPluginEvents.FailedToLoad, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerrewardadplugineventsfailedtoload-)
-   [`addListener(RewardAdPluginEvents.Loaded, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerrewardadplugineventsloaded-)
-   [`addListener(RewardAdPluginEvents.Rewarded, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerrewardadplugineventsrewarded-)
-   [`addListener(RewardAdPluginEvents.Dismissed, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerrewardadplugineventsdismissed-)
-   [`addListener(RewardAdPluginEvents.FailedToShow, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerrewardadplugineventsfailedtoshow-)
-   [`addListener(RewardAdPluginEvents.Showed, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerrewardadplugineventsshowed-)
-   [`addListener(RewardAdPluginEvents.AdImpression, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerrewardadplugineventsadimpression-)
-   [`prepareRewardInterstitialAd(...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-preparerewardinterstitialad)
-   [`showRewardInterstitialAd(...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-showrewardinterstitialad)
-   [`addListener(RewardInterstitialAdPluginEvents.FailedToLoad, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerrewardinterstitialadplugineventsfailedtoload-)
-   [`addListener(RewardInterstitialAdPluginEvents.Loaded, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerrewardinterstitialadplugineventsloaded-)
-   [`addListener(RewardInterstitialAdPluginEvents.Rewarded, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerrewardinterstitialadplugineventsrewarded-)
-   [`addListener(RewardInterstitialAdPluginEvents.Dismissed, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerrewardinterstitialadplugineventsdismissed-)
-   [`addListener(RewardInterstitialAdPluginEvents.FailedToShow, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerrewardinterstitialadplugineventsfailedtoshow-)
-   [`addListener(RewardInterstitialAdPluginEvents.Showed, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerrewardinterstitialadplugineventsshowed-)
-   [`addListener(RewardInterstitialAdPluginEvents.AdImpression, ...)`](https://npmcn.com/package/%40capacitor-community/admob/#readme-addlistenerrewardinterstitialadplugineventsadimpression-)
-   [接口](https://npmcn.com/package/%40capacitor-community/admob/#readme-interfaces)
-   [类型异名](https://npmcn.com/package/%40capacitor-community/admob/#readme-type-aliases)
-   [数字](https://npmcn.com/package/%40capacitor-community/admob/#readme-enums)

## API 密码

### 初始化(...)

```typescript
initialize(options?: AdMobInitializationOptions | undefined) => Promise<void>
```

初始化了Google移动ads SDK.

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[AdMobInitializationOptions](https://npmcn.com/package/%40capacitor-community/admob/#readme-admobinitializationoptions)` | 可选 SDK 初始化设置 . |

**自:** 1.1.2 国家

* * *

### 认证状态 ()

```typescript
trackingAuthorizationStatus() => Promise<TrackingAuthorizationStatusInterface>
```

返回当前 iOS 14 的 App Track 透明化授权状态 . 回返 `authorized` 在早期的iOS版本,Android,和Web.

**回返情况:** `Promise<[TrackingAuthorizationStatusInterface](https://npmcn.com/package/%40capacitor-community/admob/#readme-trackingauthorizationstatusinterface)>`

**自:** 3.1.0 (中文(简体) )

* * *

### 跟踪认证( )

```typescript
requestTrackingAuthorization() => Promise<void>
```

请求在iOS 14上及以后的App跟踪透明授权. 决心不采取行动 之前的iOS版本,Android,和网络.

**自:** 5.2.0 (中文(简体) )

* * *

### 设置 应用

```typescript
setApplicationMuted(options: ApplicationMutedOptions) => Promise<void>
```

向Google Mobile Ads SDK报告应用程序音频是否变音.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[ApplicationMutedOptions](https://npmcn.com/package/%40capacitor-community/admob/#readme-applicationmutedoptions)` |

**自:** 4.1.1 国家

* * *

### 应用程序卷(...)

```typescript
setApplicationVolume(options: ApplicationVolumeOptions) => Promise<void>
```

向Google Mobile Ads SDK报告应用音频量.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[ApplicationVolumeOptions](https://npmcn.com/package/%40capacitor-community/admob/#readme-applicationvolumeoptions)` |

**自:** 4.1.1 国家

* * *

### 加载App Open (...)

```typescript
loadAppOpen(options: AppOpenAdOptions) => Promise<AdLoadInfo>
```

装入 App Open 广告并返回已装入的广告单位ID .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[AppOpenAdOptions](https://npmcn.com/package/%40capacitor-community/admob/#readme-appopenadoptions)` |

**回返情况:** `Promise<[AdLoadInfo](https://npmcn.com/package/%40capacitor-community/admob/#readme-adloadinfo)>`

* * *

### 显示 App 打开(...)

```typescript
showAppOpen(options?: AdShowOptions | undefined) => Promise<void>
```

显示装入的 App Open 广告 .

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[AdShowOptions](https://npmcn.com/package/%40capacitor-community/admob/#readme-adshowoptions)` | 可选的 Pass { adId } 显示一个特定的已准备好的广告, 而不是最近的广告 . |

* * *

### 是 App OpenLoaded (...) 移动

```typescript
isAppOpenLoaded(options?: AdShowOptions | undefined) => Promise<{ value: boolean; }>
```

检查是否装入 App Open 广告 .

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[AdShowOptions](https://npmcn.com/package/%40capacitor-community/admob/#readme-adshowoptions)` | 可选的 通过一个广告来检查一个特定的准备的广告,而不是最近的广告. |

**回返情况:** `Promise<{ value: boolean; }>`

* * *

### 添加倾听器( App OpenAdPluginEvents ) 。 已装入,... )

```typescript
addListener(eventName: AppOpenAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
```

收听 App Open 广告加载事件.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[AppOpenAdPluginEvents.Loaded](https://npmcn.com/package/%40capacitor-community/admob/#readme-appopenadpluginevents)` |
| **`listenerFunc`** | `(info: [AdLoadInfo](https://npmcn.com/package/%40capacitor-community/admob/#readme-adloadinfo)) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加倾听器( App OpenAdPluginEvents. 失败的ToLoad,...)

```typescript
addListener(eventName: AppOpenAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
```

听取 App Open 广告装入失败 .

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[AppOpenAdPluginEvents.FailedToLoad](https://npmcn.com/package/%40capacitor-community/admob/#readme-appopenadpluginevents)` |
| **`listenerFunc`** | `(error: [AdMobError](https://npmcn.com/package/%40capacitor-community/admob/#readme-admoberror)) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加倾听器( App OpenAdPluginEvents ) 。 已打开,... )

```typescript
addListener(eventName: AppOpenAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>
```

听App Open广告打开事件.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[AppOpenAdPluginEvents.Opened](https://npmcn.com/package/%40capacitor-community/admob/#readme-appopenadpluginevents)` |
| **`listenerFunc`** | `() => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加倾听器( App OpenAdPluginEvents ) 。 关闭,... )

```typescript
addListener(eventName: AppOpenAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>
```

听App公开广告 关闭事件.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[AppOpenAdPluginEvents.Closed](https://npmcn.com/package/%40capacitor-community/admob/#readme-appopenadpluginevents)` |
| **`listenerFunc`** | `() => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加收听器( App OpenAdPluginEvents. 失败的ToShow,...)

```typescript
addListener(eventName: AppOpenAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
```

收听App Open广告显示失败.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[AppOpenAdPluginEvents.FailedToShow](https://npmcn.com/package/%40capacitor-community/admob/#readme-appopenadpluginevents)` |
| **`listenerFunc`** | `(error: [AdMobError](https://npmcn.com/package/%40capacitor-community/admob/#readme-admoberror)) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加倾听器( App OpenAdPluginEvents ) 。 叹为观止. )

```typescript
addListener(eventName: AppOpenAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
```

听App Open印象级广告收入事件.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[AppOpenAdPluginEvents.AdImpression](https://npmcn.com/package/%40capacitor-community/admob/#readme-appopenadpluginevents)` |
| **`listenerFunc`** | `(data: [AdMobRevenueData](https://npmcn.com/package/%40capacitor-community/admob/#readme-admobrevenuedata)) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 显示 Banner (...)

```typescript
showBanner(options: BannerAdOptions) => Promise<void>
```

显示横幅广告.

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[BannerAdOptions](https://npmcn.com/package/%40capacitor-community/admob/#readme-banneradoptions)` | [备选](https://npmcn.com/package/%40capacitor-community/admob/#readme-adoptions) |

**自:** 1.1.2 国家

* * *

### 隐藏 Banner ()

```typescript
hideBanner() => Promise<void>
```

隐藏当前旗帜而不破坏它.

**自:** 1.1.2 国家

* * *

### 复选 Banner ()

```typescript
resumeBanner() => Promise<void>
```

显示先前隐藏的横幅 .

**自:** 1.1.2 国家

* * *

### 删除 Banner ()

```typescript
removeBanner() => Promise<void>
```

销毁当前横幅并删除屏幕上的横幅.

**自:** 1.1.2 国家

* * *

### 准备 Banner (...)

```typescript
prepareBanner(options: BannerAdOptions) => Promise<void>
```

在不改变当前显示的情况下预装下一条横幅. 装入时决定 。 呼叫显示 Banner () 有匹配选项来显示它 . 准备再次替换先前的准备; 删除 Banner () 取消它 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[BannerAdOptions](https://npmcn.com/package/%40capacitor-community/admob/#readme-banneradoptions)` |

* * *

### 获得Adaptive BannerSize(...)

```typescript
getAdaptiveBannerSize(options?: { width?: number | undefined; } | undefined) => Promise<AdMobBannerSize>
```

在不创建或装入广告的情况下计算嵌入式适应性横幅大小. 使用当前安全区域可使用的宽度,除非提供宽度. 尺寸在Android上为dp,在iOS上为分. 旋转后重新计算 或可用宽度变化。 明确的宽度不会改变显示 Banner () 的大小 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `{ width?: number; }` |

**回返情况:** `Promise<[AdMobBannerSize](https://npmcn.com/package/%40capacitor-community/admob/#readme-admobbannersize)>`

* * *

### 获取 BannerSize ()

```typescript
getBannerSize() => Promise<AdMobBannerSize>
```

返回 Dp (Android) 或点 (iOS) 中当前显示的横幅大小 . 在装入或隐藏、删除或失败之前返回零维. 不创建、加载或显示广告.

**回返情况:** `Promise<[AdMobBannerSize](https://npmcn.com/package/%40capacitor-community/admob/#readme-admobbannersize)>`

* * *

### 添加倾听器( BannerAdPluginEvents) 。 大小变化,. )

```typescript
addListener(eventName: BannerAdPluginEvents.SizeChanged, listenerFunc: (info: AdMobBannerSize) => void) => Promise<PluginListenerHandle>
```

监听显示的横幅尺寸的更改 .

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`eventName`** | `[BannerAdPluginEvents.SizeChanged](https://npmcn.com/package/%40capacitor-community/admob/#readme-banneradpluginevents)` | 横幅 |
| **`listenerFunc`** | `(info: [AdMobBannerSize](https://npmcn.com/package/%40capacitor-community/admob/#readme-admobbannersize)) => void` |  |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

**自:** 3.0.0 (单位:千美元)

* * *

### 添加倾听器( BannerAdPluginEvents) 。 已装入,... )

```typescript
addListener(eventName: BannerAdPluginEvents.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>
```

听旗下广告加载事件.

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`eventName`** | `[BannerAdPluginEvents.Loaded](https://npmcn.com/package/%40capacitor-community/admob/#readme-banneradpluginevents)` | 旗下标记 |
| **`listenerFunc`** | `() => void` |  |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

**自:** 3.0.0 (单位:千美元)

* * *

### 添加收听器( BannerAdPluginEvents. fault ToLoad,...)

```typescript
addListener(eventName: BannerAdPluginEvents.FailedToLoad, listenerFunc: (info: AdMobError) => void) => Promise<PluginListenerHandle>
```

听旗下广告装入失败.

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`eventName`** | `[BannerAdPluginEvents.FailedToLoad](https://npmcn.com/package/%40capacitor-community/admob/#readme-banneradpluginevents)` | 横幅已失败 |
| **`listenerFunc`** | `(info: [AdMobError](https://npmcn.com/package/%40capacitor-community/admob/#readme-admoberror)) => void` |  |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

**自:** 3.0.0 (单位:千美元)

* * *

### 添加倾听器( BannerAdPluginEvents) 。 已打开,... )

```typescript
addListener(eventName: BannerAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>
```

听旗子覆盖打开的事件.

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`eventName`** | `[BannerAdPluginEvents.Opened](https://npmcn.com/package/%40capacitor-community/admob/#readme-banneradpluginevents)` | 已打开 |
| **`listenerFunc`** | `() => void` |  |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

**自:** 3.0.0 (单位:千美元)

* * *

### 添加倾听器( BannerAdPluginEvents) 。 关闭,... )

```typescript
addListener(eventName: BannerAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>
```

听旗子 覆盖关闭的事件.

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`eventName`** | `[BannerAdPluginEvents.Closed](https://npmcn.com/package/%40capacitor-community/admob/#readme-banneradpluginevents)` | 已关闭 |
| **`listenerFunc`** | `() => void` |  |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

**自:** 3.0.0 (单位:千美元)

* * *

### 添加倾听器( BannerAdPluginEvents. Adimpression,...)

```typescript
addListener(eventName: BannerAdPluginEvents.AdImpression, listenerFunc: () => void) => Promise<PluginListenerHandle>
```

听旗下印象事件.

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`eventName`** | `[BannerAdPluginEvents.AdImpression](https://npmcn.com/package/%40capacitor-community/admob/#readme-banneradpluginevents)` | 图像 |
| **`listenerFunc`** | `() => void` |  |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

**自:** 3.0.0 (单位:千美元)

* * *

### 添加倾听器( BannerAdPluginEvents.AdPaid,...)

```typescript
addListener(eventName: BannerAdPluginEvents.AdPaid, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
```

听旗下印象级广告收入事件.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[BannerAdPluginEvents.AdPaid](https://npmcn.com/package/%40capacitor-community/admob/#readme-banneradpluginevents)` |
| **`listenerFunc`** | `(data: [AdMobRevenueData](https://npmcn.com/package/%40capacitor-community/admob/#readme-admobrevenuedata)) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 请求同意信息(...)

```typescript
requestConsentInfo(options?: AdmobConsentRequestOptions | undefined) => Promise<AdmobConsentInfo>
```

请求用户同意信息

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[AdmobConsentRequestOptions](https://npmcn.com/package/%40capacitor-community/admob/#readme-admobconsentrequestoptions)` | 同意请求 |

**回返情况:** `Promise<[AdmobConsentInfo](https://npmcn.com/package/%40capacitor-community/admob/#readme-admobconsentinfo)>`

**自:** 5.0.0 (单位:千美元)

* * *

### 显示空闲选项格式( )

```typescript
showPrivacyOptionsForm() => Promise<void>
```

显示一个 google 隐私选项表( 由您的 GDPR 信件配置) .

**自:** 7.0.3 信息技术

* * *

### 显示同意格式 ()

```typescript
showConsentForm() => Promise<AdmobConsentInfo>
```

显示 google 用户同意表(从您的 GDPR 信件配置中提交) .

**回返情况:** `Promise<[AdmobConsentInfo](https://npmcn.com/package/%40capacitor-community/admob/#readme-admobconsentinfo)>`

**自:** 5.0.0 (单位:千美元)

* * *

### 重新设置 ConsentInfo ()

```typescript
resetConsentInfo() => Promise<void>
```

恢复UMP SDK状态. 调用请求 ConsentInfo 函数再次允许用户修改其同意

**自:** 5.0.0 (单位:千美元)

* * *

### 准备 Interstital (...)

```typescript
prepareInterstitial(options: AdOptions) => Promise<AdLoadInfo>
```

装入相间广告并返回已装入的广告单位ID.

SDK 载入失败用本地错误消息和一个字符串拒绝 `code`。 。 。 . 代码是特定平台的;失败的ToLoad事件暴露出与数字相同的代码.

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[AdOptions](https://npmcn.com/package/%40capacitor-community/admob/#readme-adoptions)` | [备选](https://npmcn.com/package/%40capacitor-community/admob/#readme-adoptions) |

**回返情况:** `Promise<[AdLoadInfo](https://npmcn.com/package/%40capacitor-community/admob/#readme-adloadinfo)>`

**自:** 1.1.2 国家

* * *

### 显示中间(...)

```typescript
showInterstitial(options?: AdShowOptions | undefined) => Promise<void>
```

显示已装入的间歇性广告 .

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[AdShowOptions](https://npmcn.com/package/%40capacitor-community/admob/#readme-adshowoptions)` | 可选的 Pass { adId } 显示一个特定的已准备好的广告, 而不是最近的广告 . |

**自:** 1.1.2 国家

* * *

### 添加倾听器( Interstitual AdPluginEvents. fault ToLoad,...)

```typescript
addListener(eventName: InterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
```

监听间歇式加载失败 .

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[InterstitialAdPluginEvents.FailedToLoad](https://npmcn.com/package/%40capacitor-community/admob/#readme-interstitialadpluginevents)` |
| **`listenerFunc`** | `(error: [AdMobError](https://npmcn.com/package/%40capacitor-community/admob/#readme-admoberror)) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加倾听器( InterstitalAdPluginEvents) 。 已装入,... )

```typescript
addListener(eventName: InterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
```

静态加载事件.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[InterstitialAdPluginEvents.Loaded](https://npmcn.com/package/%40capacitor-community/admob/#readme-interstitialadpluginevents)` |
| **`listenerFunc`** | `(info: [AdLoadInfo](https://npmcn.com/package/%40capacitor-community/admob/#readme-adloadinfo)) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加倾听器( InterstitalAdPluginEvents) 。 解职. )

```typescript
addListener(eventName: InterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
```

静静地接听 驳回事件.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[InterstitialAdPluginEvents.Dismissed](https://npmcn.com/package/%40capacitor-community/admob/#readme-interstitialadpluginevents)` |
| **`listenerFunc`** | `() => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加倾听器( InterstitalAdPluginEvents) 。 显示失败,...)

```typescript
addListener(eventName: InterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
```

静听广告显示失败.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[InterstitialAdPluginEvents.FailedToShow](https://npmcn.com/package/%40capacitor-community/admob/#readme-interstitialadpluginevents)` |
| **`listenerFunc`** | `(error: [AdMobError](https://npmcn.com/package/%40capacitor-community/admob/#readme-admoberror)) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加倾听器( InterstitalAdPluginEvents) 。 现出. )

```typescript
addListener(eventName: InterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
```

静态广告的监听显示事件.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[InterstitialAdPluginEvents.Showed](https://npmcn.com/package/%40capacitor-community/admob/#readme-interstitialadpluginevents)` |
| **`listenerFunc`** | `() => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加倾听器( InterstitalAdPluginEvents) 。 叹为观止. )

```typescript
addListener(eventName: InterstitialAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
```

倾听间印象级广告收入事件.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[InterstitialAdPluginEvents.AdImpression](https://npmcn.com/package/%40capacitor-community/admob/#readme-interstitialadpluginevents)` |
| **`listenerFunc`** | `(data: [AdMobRevenueData](https://npmcn.com/package/%40capacitor-community/admob/#readme-admobrevenuedata)) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 准备 RewardVideoAd(...)

```typescript
prepareRewardVideoAd(options: RewardAdOptions) => Promise<AdLoadInfo>
```

装入奖励广告并返回已装入的广告单位ID.

SDK 载入失败用本地错误消息和一个字符串拒绝 `code`。 。 。 . 代码是特定平台的;失败的ToLoad事件暴露出与数字相同的代码.

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[RewardAdOptions](https://npmcn.com/package/%40capacitor-community/admob/#readme-rewardadoptions)` | [奖励选项](https://npmcn.com/package/%40capacitor-community/admob/#readme-rewardadoptions) |

**回返情况:** `Promise<[AdLoadInfo](https://npmcn.com/package/%40capacitor-community/admob/#readme-adloadinfo)>`

**自:** 1.1.2 国家

* * *

### 显示奖励视频(...)

```typescript
showRewardVideoAd(options?: AdShowOptions | undefined) => Promise<AdMobRewardItem>
```

显示已加载的奖励广告,并在用户获得奖励时解决.

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[AdShowOptions](https://npmcn.com/package/%40capacitor-community/admob/#readme-adshowoptions)` | 可选的 Pass { adId } 显示一个特定的已准备好的广告, 而不是最近的广告 . |

**回返情况:** `Promise<[AdMobRewardItem](https://npmcn.com/package/%40capacitor-community/admob/#readme-admobrewarditem)>`

**自:** 1.1.2 国家

* * *

### 添加倾听器( RewardAdPluginEvents.ad) 点击,...)

```typescript
addListener(eventName: RewardAdPluginEvents.adClicked, listenerFunc: () => void) => Promise<PluginListenerHandle>
```

收听被奖励广告SDK所收录的点击,包括获得奖励后. 点击并不意味着用户获得了奖励.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[RewardAdPluginEvents.adClicked](https://npmcn.com/package/%40capacitor-community/admob/#readme-rewardadpluginevents)` |
| **`listenerFunc`** | `() => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加倾听器( RewardAdPluginEvents.faultToLoad,...)

```typescript
addListener(eventName: RewardAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
```

收听奖励广告装入失败.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[RewardAdPluginEvents.FailedToLoad](https://npmcn.com/package/%40capacitor-community/admob/#readme-rewardadpluginevents)` |
| **`listenerFunc`** | `(error: [AdMobError](https://npmcn.com/package/%40capacitor-community/admob/#readme-admoberror)) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加 listener( RewardAdPluginEvents) 键盘。 已装入,... )

```typescript
addListener(eventName: RewardAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
```

收听奖励广告加载事件.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[RewardAdPluginEvents.Loaded](https://npmcn.com/package/%40capacitor-community/admob/#readme-rewardadpluginevents)` |
| **`listenerFunc`** | `(info: [AdLoadInfo](https://npmcn.com/package/%40capacitor-community/admob/#readme-adloadinfo)) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加 listener( RewardAdPluginEvents) 键盘。 获赏. )

```typescript
addListener(eventName: RewardAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardItem) => void) => Promise<PluginListenerHandle>
```

收听挣取的奖励活动.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[RewardAdPluginEvents.Rewarded](https://npmcn.com/package/%40capacitor-community/admob/#readme-rewardadpluginevents)` |
| **`listenerFunc`** | `(reward: [AdMobRewardItem](https://npmcn.com/package/%40capacitor-community/admob/#readme-admobrewarditem)) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加 listener( RewardAdPluginEvents) 键盘。 解职. )

```typescript
addListener(eventName: RewardAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
```

收听奖赏广告 解雇事件.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[RewardAdPluginEvents.Dismissed](https://npmcn.com/package/%40capacitor-community/admob/#readme-rewardadpluginevents)` |
| **`listenerFunc`** | `() => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加收听器( RewardAdPluginEvents. 失败的ToShow,...)

```typescript
addListener(eventName: RewardAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
```

收听奖励广告显示失败.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[RewardAdPluginEvents.FailedToShow](https://npmcn.com/package/%40capacitor-community/admob/#readme-rewardadpluginevents)` |
| **`listenerFunc`** | `(error: [AdMobError](https://npmcn.com/package/%40capacitor-community/admob/#readme-admoberror)) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加 listener( RewardAdPluginEvents) 键盘。 现出. )

```typescript
addListener(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
```

收听奖励广告 显示事件.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[RewardAdPluginEvents.Showed](https://npmcn.com/package/%40capacitor-community/admob/#readme-rewardadpluginevents)` |
| **`listenerFunc`** | `() => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加倾听器( RewardAdPluginEvents.Adimpression,...)

```typescript
addListener(eventName: RewardAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
```

收听奖赏级广告收入事件.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[RewardAdPluginEvents.AdImpression](https://npmcn.com/package/%40capacitor-community/admob/#readme-rewardadpluginevents)` |
| **`listenerFunc`** | `(data: [AdMobRevenueData](https://npmcn.com/package/%40capacitor-community/admob/#readme-admobrevenuedata)) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 准备 RewardInterstitalAd (...)

```typescript
prepareRewardInterstitialAd(options: RewardInterstitialAdOptions) => Promise<AdLoadInfo>
```

装入奖励的间歇广告并返回已装入的广告单位ID.

SDK 载入失败用本地错误消息和一个字符串拒绝 `code`。 。 。 . 代码是特定平台的;失败的ToLoad事件暴露出与数字相同的代码.

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[RewardInterstitialAdOptions](https://npmcn.com/package/%40capacitor-community/admob/#readme-rewardinterstitialadoptions)` | [奖励内部 备选](https://npmcn.com/package/%40capacitor-community/admob/#readme-rewardinterstitialadoptions) |

**回返情况:** `Promise<[AdLoadInfo](https://npmcn.com/package/%40capacitor-community/admob/#readme-adloadinfo)>`

**自:** 1.1.2 国家

* * *

### 显示 RewardInterstitionAd(...)

```typescript
showRewardInterstitialAd(options?: AdShowOptions | undefined) => Promise<AdMobRewardInterstitialItem>
```

显示一个已加载的悬疑广告,并在用户获得悬疑奖时解决.

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[AdShowOptions](https://npmcn.com/package/%40capacitor-community/admob/#readme-adshowoptions)` | 可选的 Pass { adId } 显示一个特定的已准备好的广告, 而不是最近的广告 . |

**回返情况:** `Promise<[AdMobRewardInterstitialItem](https://npmcn.com/package/%40capacitor-community/admob/#readme-admobrewardinterstitialitem)>`

**自:** 1.1.2 国家

* * *

### 添加倾听器( RewardInterstial AdPluginEvents.faultToLoad,...)

```typescript
addListener(eventName: RewardInterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
```

收听有奖的间歇性广告 装入失败.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[RewardInterstitialAdPluginEvents.FailedToLoad](https://npmcn.com/package/%40capacitor-community/admob/#readme-rewardinterstitialadpluginevents)` |
| **`listenerFunc`** | `(error: [AdMobError](https://npmcn.com/package/%40capacitor-community/admob/#readme-admoberror)) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加Listener( RewardInterstial AdPluginEvents) 键盘。 已装入,... )

```typescript
addListener(eventName: RewardInterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>
```

收听受奖的间歇式广告.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[RewardInterstitialAdPluginEvents.Loaded](https://npmcn.com/package/%40capacitor-community/admob/#readme-rewardinterstitialadpluginevents)` |
| **`listenerFunc`** | `(info: [AdLoadInfo](https://npmcn.com/package/%40capacitor-community/admob/#readme-adloadinfo)) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加Listener( RewardInterstial AdPluginEvents) 键盘。 获赏. )

```typescript
addListener(eventName: RewardInterstitialAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardInterstitialItem) => void) => Promise<PluginListenerHandle>
```

收听挣取的奖励活动.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[RewardInterstitialAdPluginEvents.Rewarded](https://npmcn.com/package/%40capacitor-community/admob/#readme-rewardinterstitialadpluginevents)` |
| **`listenerFunc`** | `(reward: [AdMobRewardInterstitialItem](https://npmcn.com/package/%40capacitor-community/admob/#readme-admobrewardinterstitialitem)) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加Listener( RewardInterstial AdPluginEvents) 键盘。 解职. )

```typescript
addListener(eventName: RewardInterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>
```

听到的奖励 暂停事件.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[RewardInterstitialAdPluginEvents.Dismissed](https://npmcn.com/package/%40capacitor-community/admob/#readme-rewardinterstitialadpluginevents)` |
| **`listenerFunc`** | `() => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加倾听器( RewardInterstial AdPluginEvents. 失败了ToShow,...)

```typescript
addListener(eventName: RewardInterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>
```

收听有奖的间歇性广告显示失败.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[RewardInterstitialAdPluginEvents.FailedToShow](https://npmcn.com/package/%40capacitor-community/admob/#readme-rewardinterstitialadpluginevents)` |
| **`listenerFunc`** | `(error: [AdMobError](https://npmcn.com/package/%40capacitor-community/admob/#readme-admoberror)) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加Listener( RewardInterstial AdPluginEvents) 键盘。 现出. )

```typescript
addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>
```

收听有奖的暂停广告 显示的事件.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[RewardInterstitialAdPluginEvents.Showed](https://npmcn.com/package/%40capacitor-community/admob/#readme-rewardinterstitialadpluginevents)` |
| **`listenerFunc`** | `() => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 添加收听器( RewardInterstitional AdPluginEvents.AdImpress,...)

```typescript
addListener(eventName: RewardInterstitialAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>
```

收听悬赏性印象级广告收入事件.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `[RewardInterstitialAdPluginEvents.AdImpression](https://npmcn.com/package/%40capacitor-community/admob/#readme-rewardinterstitialadpluginevents)` |
| **`listenerFunc`** | `(data: [AdMobRevenueData](https://npmcn.com/package/%40capacitor-community/admob/#readme-admobrevenuedata)) => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/admob/#readme-pluginlistenerhandle)>`

* * *

### 接口

#### 自动启动选项

| Prop | 类型 | 说明 | 默认 | 自兹 |
| --- | --- | --- | --- | --- |
| **`testingDevices`** | `string[]` | 当 QQlink 时作为测试设备注册的设备ID [AdMob Initialization 选项。初始化](https://npmcn.com/package/%40capacitor-community/admob/#readme-admobinitializationoptions){\\fn华文楷体\\fs16\\1che0e0e0}是 `true`。注册设备的请求接收测试广告,不会产生无效流量. |  | 1.2.0 (中文(简体) ) |
| **`initializeForTesting`** | `boolean` | 是否注册QQlink [AdMob Initialization 选项.测试 设备](https://npmcn.com/package/%40capacitor-community/admob/#readme-admobinitializationoptions)作为测试设备. | `false` | 1.2.0 (中文(简体) ) |
| **`tagForChildDirectedTreatment`** | `boolean` | 为了《儿童在线隐私保护法》的目的,有一个名为“儿童指导治疗”的设置. |  | 3.1.0 (中文(简体) ) |
| **`tagForUnderAgeOfConsent`** | `boolean` | 使用此功能时,将在未来所有广告请求中包含一个欧洲同意年龄下的用户标记参数(TFUA). |  | 3.1.0 (中文(简体) ) |
| **`maxAdContentRating`** | `[MaxAdContentRating](https://npmcn.com/package/%40capacitor-community/admob/#readme-maxadcontentrating)` | 广告内容的最高评级适用于所有广告请求. 评分较高的广告不包括在内. |  | 3.1.0 (中文(简体) ) |

#### 跟踪认证状态

目前iOS App跟踪透明授权状态.

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`status`** | `'authorized' | 'denied' | 'notDetermined' | 'restricted'` | App Track Intelligence报告的授权状态. |

#### 应用程序选中选项

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`muted`** | `boolean` | 告知SDK应用音量已变音. 注:当应用卷被报告为哑音或被设定为0. 这可能会限制更广泛的视频广告集的子集服务. | 4.1.1 国家 |

#### 应用程序Volume 选项

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`volume`** | `0 | 1 | 0.1 | 0.2 | 0.3 | 0.4 | 0.5 | 0.6 | 0.7 | 0.8 | 0.9` | 如果您的应用有自己的音量控制(如自定义音乐或音效音量),向Google Mobile Ads SDK披露应用音量,允许视频广告尊重应用音量设置. 使用支持值从 0.0( silent)到 1.0( 完整音量) . | 4.1.1 国家 |

#### AdLoadInfo 数据

广告装入成功后返回信息 .

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`adUnitId`** | `string` | 装入广告的广告单位标识. |

#### 应用程序打开选项

装入 App Open 广告的选项 .

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`adId`** | `string` | 要加载的 App Open 广告单位 ID . |

#### 显示选项

选择先前装入的广告以显示或检查的选项 .

\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ------ ------------- --- ---- - --

## 常见问题

### @capacitor-community/admob 是什么？

AdMob 的本地插件

### 如何安装 @capacitor-community/admob？

在项目目录运行 npm install @capacitor-community/admob，或使用 pnpm add / yarn add / bun add。

### @capacitor-community/admob 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @capacitor-community/admob 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @capacitor-community/admob 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @capacitor-community/admob 可以商用吗？

@capacitor-community/admob 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @capacitor-community/admob 的下载量有多少？

根据 npm 官方下载统计，@capacitor-community/admob 在 2026/10/09 – 2026/11/07 这 30 天内被下载 373,053 次，日均约 12,435 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @capacitor-community/admob 还在维护吗？

最新版本 8\.4\.0 发布于 2026/11/16（今天）；至今共发布 99 个版本，其中过去 12 个月发布了 39 个；首次发布于 2020/06/27。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

