@capacitor-community/admob

中文文档
8.4.0发布于 2026/11/16MITTypeScriptESM + CJS构建来源已验证近 30 天下载 37.3万

AdMob 的本地插件

中文使用文档
文档目录76 节
  1. 广告
  2. 维护者
  3. 贡献者
  4. 演示
  5. 截图
  6. 概览
  7. 安装
  8. 谷歌移动广告 SDK 版本
  9. Android 配置
  10. iOS 配置
  11. 解决问题
  12. 首个测试横幅
  13. 通过广告目标选择
  14. 文档
  15. 指数
  16. API 密码
  17. 初始化(...)
  18. 认证状态 ()
  19. 跟踪认证( )
  20. 设置 应用
  21. 应用程序卷(...)
  22. 加载App Open (...)
  23. 显示 App 打开(...)
  24. 是 App OpenLoaded (...) 移动
  25. 添加倾听器( App OpenAdPluginEvents ) 。 已装入,... )
  26. 添加倾听器( App OpenAdPluginEvents. 失败的ToLoad,...)
  27. 添加倾听器( App OpenAdPluginEvents ) 。 已打开,... )
  28. 添加倾听器( App OpenAdPluginEvents ) 。 关闭,... )
  29. 添加收听器( App OpenAdPluginEvents. 失败的ToShow,...)
  30. 添加倾听器( App OpenAdPluginEvents ) 。 叹为观止. )
  31. 显示 Banner (...)
  32. 隐藏 Banner ()
  33. 复选 Banner ()
  34. 删除 Banner ()
  35. 准备 Banner (...)
  36. 获得Adaptive BannerSize(...)
  37. 获取 BannerSize ()
  38. 添加倾听器( BannerAdPluginEvents) 。 大小变化,. )
  39. 添加倾听器( BannerAdPluginEvents) 。 已装入,... )
  40. 添加收听器( BannerAdPluginEvents. fault ToLoad,...)
  41. 添加倾听器( BannerAdPluginEvents) 。 已打开,... )
  42. 添加倾听器( BannerAdPluginEvents) 。 关闭,... )
  43. 添加倾听器( BannerAdPluginEvents. Adimpression,...)
  44. 添加倾听器( BannerAdPluginEvents.AdPaid,...)
  45. 请求同意信息(...)
  46. 显示空闲选项格式( )
  47. 显示同意格式 ()
  48. 重新设置 ConsentInfo ()
  49. 准备 Interstital (...)
  50. 显示中间(...)
  51. 添加倾听器( Interstitual AdPluginEvents. fault ToLoad,...)
  52. 添加倾听器( InterstitalAdPluginEvents) 。 已装入,... )
  53. 添加倾听器( InterstitalAdPluginEvents) 。 解职. )
  54. 添加倾听器( InterstitalAdPluginEvents) 。 显示失败,...)
  55. 添加倾听器( InterstitalAdPluginEvents) 。 现出. )
  56. 添加倾听器( InterstitalAdPluginEvents) 。 叹为观止. )
  57. 准备 RewardVideoAd(...)
  58. 显示奖励视频(...)
  59. 添加倾听器( RewardAdPluginEvents.ad) 点击,...)
  60. 添加倾听器( RewardAdPluginEvents.faultToLoad,...)
  61. 添加 listener( RewardAdPluginEvents) 键盘。 已装入,... )
  62. 添加 listener( RewardAdPluginEvents) 键盘。 获赏. )
  63. 添加 listener( RewardAdPluginEvents) 键盘。 解职. )
  64. 添加收听器( RewardAdPluginEvents. 失败的ToShow,...)
  65. 添加 listener( RewardAdPluginEvents) 键盘。 现出. )
  66. 添加倾听器( RewardAdPluginEvents.Adimpression,...)
  67. 准备 RewardInterstitalAd (...)
  68. 显示 RewardInterstitionAd(...)
  69. 添加倾听器( RewardInterstial AdPluginEvents.faultToLoad,...)
  70. 添加Listener( RewardInterstial AdPluginEvents) 键盘。 已装入,... )
  71. 添加Listener( RewardInterstial AdPluginEvents) 键盘。 获赏. )
  72. 添加Listener( RewardInterstial AdPluginEvents) 键盘。 解职. )
  73. 添加倾听器( RewardInterstial AdPluginEvents. 失败了ToShow,...)
  74. 添加Listener( RewardInterstial AdPluginEvents) 键盘。 现出. )
  75. 添加收听器( RewardInterstitional AdPluginEvents.AdImpress,...)
  76. 接口


广告

@capacitor-community/admob

本地 AdMob 的电容社区插件 .

阅读全部文档


维护者

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

维持状况:积极维持

贡献者

制造的 贡献者-img。 。 。 .

演示

解码器在这里.

截图

横幅暂停奖励App 打开
iOS系统
机器人

概览

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

安装

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

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

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 等待到下一个插件主机。 见 移徙 因为针后的政策.

Android 配置

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

<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数字 :

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

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

变量

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

变量艺术默认
playServicesAdsVersioncom.google.android.gms:play-services-ads25.4.+
userMessagingPlatformVersioncom.google.android.ump:user-messaging-platform4.0.0
androidxCoreKTXVersionandroidx.core:core-ktx1.15.0

iOS 配置

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

<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 设置指南。 。 。 .

解决问题

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

[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 测试——不要为首次检查创建自己的广告单位.

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

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 - 见 广告 设置您的布局 。 细节 : 配置, (中文(简体) ), 同意,以及 测试。 。 。 .

通过广告目标选择

目标临时格式指南
在应用内容旁保持广告可见度横幅广告
在自然休息时显示全屏广告而不给予奖励暂停暂停
提供一份专门的奖励经验奖励奖励广告
在自然过渡时提供奖励奖励的间歇奖励广告
将一个开放的应用体验货币化App 打开App 打开广告

文档

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

  • 配置 —— 说 AdMob.initialize 和SDK选项.
  • 同意 ——隐私同意和iOS跟踪授权.
  • 测试 演示广告单位、测试装置和同意测试.
  • 广告 ——旗帜选项,生命周期,事件.
  • 土著广告 ——饲料放置,造型,生命周期等活动.
  • 全屏广告:
    • 暂停 ——负载,展示,以及多部已准备好的广告.
    • 奖励广告 ——奖励视频,奖励互通,服务器侧核查.
  • App 打开广告 ——负载并呈现在前地过渡上.
  • 特别活动 共享生命周期事件、错误和收入数据.
  • 移徙指南 ——在v8.2.0和早期版本中升级步骤和行为变化.

指数

API 密码

初始化(...)

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

初始化了Google移动ads SDK.

参数类型说明
optionsAdMobInitializationOptions可选 SDK 初始化设置 .

自: 1.1.2 国家


认证状态 ()

trackingAuthorizationStatus() => Promise<TrackingAuthorizationStatusInterface>

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

回返情况: Promise<TrackingAuthorizationStatusInterface>

自: 3.1.0 (中文(简体) )


跟踪认证( )

requestTrackingAuthorization() => Promise<void>

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

自: 5.2.0 (中文(简体) )


设置 应用

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

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

参数类型
optionsApplicationMutedOptions

自: 4.1.1 国家


应用程序卷(...)

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

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

参数类型
optionsApplicationVolumeOptions

自: 4.1.1 国家


加载App Open (...)

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

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

参数类型
optionsAppOpenAdOptions

回返情况: Promise<AdLoadInfo>


显示 App 打开(...)

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

显示装入的 App Open 广告 .

参数类型说明
optionsAdShowOptions可选的 Pass { adId } 显示一个特定的已准备好的广告, 而不是最近的广告 .

是 App OpenLoaded (...) 移动

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

检查是否装入 App Open 广告 .

参数类型说明
optionsAdShowOptions可选的 通过一个广告来检查一个特定的准备的广告,而不是最近的广告.

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


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

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

收听 App Open 广告加载事件.

参数类型
eventNameAppOpenAdPluginEvents.Loaded
listenerFunc(info: AdLoadInfo) => void

回返情况: Promise<PluginListenerHandle>


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

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

听取 App Open 广告装入失败 .

参数类型
eventNameAppOpenAdPluginEvents.FailedToLoad
listenerFunc(error: AdMobError) => void

回返情况: Promise<PluginListenerHandle>


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

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

听App Open广告打开事件.

参数类型
eventNameAppOpenAdPluginEvents.Opened
listenerFunc() => void

回返情况: Promise<PluginListenerHandle>


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

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

听App公开广告 关闭事件.

参数类型
eventNameAppOpenAdPluginEvents.Closed
listenerFunc() => void

回返情况: Promise<PluginListenerHandle>


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

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

收听App Open广告显示失败.

参数类型
eventNameAppOpenAdPluginEvents.FailedToShow
listenerFunc(error: AdMobError) => void

回返情况: Promise<PluginListenerHandle>


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

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

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

参数类型
eventNameAppOpenAdPluginEvents.AdImpression
listenerFunc(data: AdMobRevenueData) => void

回返情况: Promise<PluginListenerHandle>


显示 Banner (...)

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

显示横幅广告.

参数类型说明
optionsBannerAdOptions备选

自: 1.1.2 国家


隐藏 Banner ()

hideBanner() => Promise<void>

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

自: 1.1.2 国家


复选 Banner ()

resumeBanner() => Promise<void>

显示先前隐藏的横幅 .

自: 1.1.2 国家


删除 Banner ()

removeBanner() => Promise<void>

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

自: 1.1.2 国家


准备 Banner (...)

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

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

参数类型
optionsBannerAdOptions

获得Adaptive BannerSize(...)

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

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

参数类型
options{ width?: number; }

回返情况: Promise<AdMobBannerSize>


获取 BannerSize ()

getBannerSize() => Promise<AdMobBannerSize>

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

回返情况: Promise<AdMobBannerSize>


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

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

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

参数类型说明
eventNameBannerAdPluginEvents.SizeChanged横幅
listenerFunc(info: AdMobBannerSize) => void

回返情况: Promise<PluginListenerHandle>

自: 3.0.0 (单位:千美元)


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

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

听旗下广告加载事件.

参数类型说明
eventNameBannerAdPluginEvents.Loaded旗下标记
listenerFunc() => void

回返情况: Promise<PluginListenerHandle>

自: 3.0.0 (单位:千美元)


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

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

听旗下广告装入失败.

参数类型说明
eventNameBannerAdPluginEvents.FailedToLoad横幅已失败
listenerFunc(info: AdMobError) => void

回返情况: Promise<PluginListenerHandle>

自: 3.0.0 (单位:千美元)


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

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

听旗子覆盖打开的事件.

参数类型说明
eventNameBannerAdPluginEvents.Opened已打开
listenerFunc() => void

回返情况: Promise<PluginListenerHandle>

自: 3.0.0 (单位:千美元)


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

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

听旗子 覆盖关闭的事件.

参数类型说明
eventNameBannerAdPluginEvents.Closed已关闭
listenerFunc() => void

回返情况: Promise<PluginListenerHandle>

自: 3.0.0 (单位:千美元)


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

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

听旗下印象事件.

参数类型说明
eventNameBannerAdPluginEvents.AdImpression图像
listenerFunc() => void

回返情况: Promise<PluginListenerHandle>

自: 3.0.0 (单位:千美元)


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

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

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

参数类型
eventNameBannerAdPluginEvents.AdPaid
listenerFunc(data: AdMobRevenueData) => void

回返情况: Promise<PluginListenerHandle>


请求同意信息(...)

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

请求用户同意信息

参数类型说明
optionsAdmobConsentRequestOptions同意请求

回返情况: Promise<AdmobConsentInfo>

自: 5.0.0 (单位:千美元)


显示空闲选项格式( )

showPrivacyOptionsForm() => Promise<void>

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

自: 7.0.3 信息技术


显示同意格式 ()

showConsentForm() => Promise<AdmobConsentInfo>

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

回返情况: Promise<AdmobConsentInfo>

自: 5.0.0 (单位:千美元)


重新设置 ConsentInfo ()

resetConsentInfo() => Promise<void>

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

自: 5.0.0 (单位:千美元)


准备 Interstital (...)

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

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

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

参数类型说明
optionsAdOptions备选

回返情况: Promise<AdLoadInfo>

自: 1.1.2 国家


显示中间(...)

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

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

参数类型说明
optionsAdShowOptions可选的 Pass { adId } 显示一个特定的已准备好的广告, 而不是最近的广告 .

自: 1.1.2 国家


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

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

监听间歇式加载失败 .

参数类型
eventNameInterstitialAdPluginEvents.FailedToLoad
listenerFunc(error: AdMobError) => void

回返情况: Promise<PluginListenerHandle>


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

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

静态加载事件.

参数类型
eventNameInterstitialAdPluginEvents.Loaded
listenerFunc(info: AdLoadInfo) => void

回返情况: Promise<PluginListenerHandle>


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

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

静静地接听 驳回事件.

参数类型
eventNameInterstitialAdPluginEvents.Dismissed
listenerFunc() => void

回返情况: Promise<PluginListenerHandle>


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

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

静听广告显示失败.

参数类型
eventNameInterstitialAdPluginEvents.FailedToShow
listenerFunc(error: AdMobError) => void

回返情况: Promise<PluginListenerHandle>


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

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

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

参数类型
eventNameInterstitialAdPluginEvents.Showed
listenerFunc() => void

回返情况: Promise<PluginListenerHandle>


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

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

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

参数类型
eventNameInterstitialAdPluginEvents.AdImpression
listenerFunc(data: AdMobRevenueData) => void

回返情况: Promise<PluginListenerHandle>


准备 RewardVideoAd(...)

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

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

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

参数类型说明
optionsRewardAdOptions奖励选项

回返情况: Promise<AdLoadInfo>

自: 1.1.2 国家


显示奖励视频(...)

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

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

参数类型说明
optionsAdShowOptions可选的 Pass { adId } 显示一个特定的已准备好的广告, 而不是最近的广告 .

回返情况: Promise<AdMobRewardItem>

自: 1.1.2 国家


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

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

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

参数类型
eventNameRewardAdPluginEvents.adClicked
listenerFunc() => void

回返情况: Promise<PluginListenerHandle>


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

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

收听奖励广告装入失败.

参数类型
eventNameRewardAdPluginEvents.FailedToLoad
listenerFunc(error: AdMobError) => void

回返情况: Promise<PluginListenerHandle>


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

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

收听奖励广告加载事件.

参数类型
eventNameRewardAdPluginEvents.Loaded
listenerFunc(info: AdLoadInfo) => void

回返情况: Promise<PluginListenerHandle>


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

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

收听挣取的奖励活动.

参数类型
eventNameRewardAdPluginEvents.Rewarded
listenerFunc(reward: AdMobRewardItem) => void

回返情况: Promise<PluginListenerHandle>


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

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

收听奖赏广告 解雇事件.

参数类型
eventNameRewardAdPluginEvents.Dismissed
listenerFunc() => void

回返情况: Promise<PluginListenerHandle>


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

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

收听奖励广告显示失败.

参数类型
eventNameRewardAdPluginEvents.FailedToShow
listenerFunc(error: AdMobError) => void

回返情况: Promise<PluginListenerHandle>


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

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

收听奖励广告 显示事件.

参数类型
eventNameRewardAdPluginEvents.Showed
listenerFunc() => void

回返情况: Promise<PluginListenerHandle>


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

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

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

参数类型
eventNameRewardAdPluginEvents.AdImpression
listenerFunc(data: AdMobRevenueData) => void

回返情况: Promise<PluginListenerHandle>


准备 RewardInterstitalAd (...)

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

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

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

参数类型说明
optionsRewardInterstitialAdOptions奖励内部 备选

回返情况: Promise<AdLoadInfo>

自: 1.1.2 国家


显示 RewardInterstitionAd(...)

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

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

参数类型说明
optionsAdShowOptions可选的 Pass { adId } 显示一个特定的已准备好的广告, 而不是最近的广告 .

回返情况: Promise<AdMobRewardInterstitialItem>

自: 1.1.2 国家


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

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

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

参数类型
eventNameRewardInterstitialAdPluginEvents.FailedToLoad
listenerFunc(error: AdMobError) => void

回返情况: Promise<PluginListenerHandle>


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

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

收听受奖的间歇式广告.

参数类型
eventNameRewardInterstitialAdPluginEvents.Loaded
listenerFunc(info: AdLoadInfo) => void

回返情况: Promise<PluginListenerHandle>


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

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

收听挣取的奖励活动.

参数类型
eventNameRewardInterstitialAdPluginEvents.Rewarded
listenerFunc(reward: AdMobRewardInterstitialItem) => void

回返情况: Promise<PluginListenerHandle>


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

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

听到的奖励 暂停事件.

参数类型
eventNameRewardInterstitialAdPluginEvents.Dismissed
listenerFunc() => void

回返情况: Promise<PluginListenerHandle>


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

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

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

参数类型
eventNameRewardInterstitialAdPluginEvents.FailedToShow
listenerFunc(error: AdMobError) => void

回返情况: Promise<PluginListenerHandle>


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

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

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

参数类型
eventNameRewardInterstitialAdPluginEvents.Showed
listenerFunc() => void

回返情况: Promise<PluginListenerHandle>


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

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

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

参数类型
eventNameRewardInterstitialAdPluginEvents.AdImpression
listenerFunc(data: AdMobRevenueData) => void

回返情况: Promise<PluginListenerHandle>


接口

自动启动选项

Prop类型说明默认自兹
testingDevicesstring[]当 QQlink 时作为测试设备注册的设备ID AdMob Initialization 选项。初始化{\fn华文楷体\fs16\1che0e0e0}是 true。注册设备的请求接收测试广告,不会产生无效流量.1.2.0 (中文(简体) )
initializeForTestingboolean是否注册QQlink AdMob Initialization 选项.测试 设备作为测试设备.false1.2.0 (中文(简体) )
tagForChildDirectedTreatmentboolean为了《儿童在线隐私保护法》的目的,有一个名为“儿童指导治疗”的设置.3.1.0 (中文(简体) )
tagForUnderAgeOfConsentboolean使用此功能时,将在未来所有广告请求中包含一个欧洲同意年龄下的用户标记参数(TFUA).3.1.0 (中文(简体) )
maxAdContentRatingMaxAdContentRating广告内容的最高评级适用于所有广告请求. 评分较高的广告不包括在内.3.1.0 (中文(简体) )

跟踪认证状态

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

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

应用程序选中选项

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

应用程序Volume 选项

Prop类型说明自兹
volume0 | 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类型说明
adUnitIdstring装入广告的广告单位标识.

应用程序打开选项

装入 App Open 广告的选项 .

Prop类型说明
adIdstring要加载的 App Open 广告单位 ID .

显示选项

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

**************************************************************************************************************************************************************************************************************************************************************** |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ------ ------------- --- ---- - --

版本与发布记录

@capacitor-community/admob 共发布 99 个版本,首次发布于 2020/06/27;过去 12 个月发布了 39 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
8.4.0latest2026/11/16今天
8.3.2-beta.pr509.shab23015c90e5fbeta2026/11/16今天
8.3.2-beta.pr508.shab18b9d12fcf92026/11/16今天
8.3.2-beta.pr507.sha711dbedd3e682026/11/16今天
8.3.2-beta.pr505.shae80d59bcafe62026/11/16今天
8.3.22026/11/16今天

其他发布通道:next → 8.0.0-0,beta → 8.3.2-beta.pr509.shab23015c90e5f。

关于 @capacitor-community/admob 的常见问题

@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 和提交记录判断。