@capacitor-community/admob
Advanced tools
@capacitor-community/admob - npm Package Compare versions
Comparing version 4.1.0 to 4.2.0
@@ -98,2 +98,84 @@ { | ||
| { | ||
| "name": "setApplicationMuted", | ||
| "signature": "(options: ApplicationMutedOptions) => Promise<void>", | ||
| "parameters": [ | ||
| { | ||
| "name": "options", | ||
| "docs": "", | ||
| "type": "ApplicationMutedOptions" | ||
| } | ||
| ], | ||
| "returns": "Promise<void>", | ||
| "tags": [ | ||
| { | ||
| "name": "see", | ||
| "text": [ | ||
| { | ||
| "text": "https", | ||
| "kind": "text" | ||
| }, | ||
| { | ||
| "text": "://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/3547038-trackingauthorizationstatus", | ||
| "kind": "text" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "name": "since", | ||
| "text": [ | ||
| { | ||
| "text": "4.1.1", | ||
| "kind": "text" | ||
| } | ||
| ] | ||
| } | ||
| ], | ||
| "docs": "Report application mute state to AdMob SDK", | ||
| "complexTypes": [ | ||
| "ApplicationMutedOptions" | ||
| ], | ||
| "slug": "setapplicationmuted" | ||
| }, | ||
| { | ||
| "name": "setApplicationVolume", | ||
| "signature": "(options: ApplicationVolumeOptions) => Promise<void>", | ||
| "parameters": [ | ||
| { | ||
| "name": "options", | ||
| "docs": "", | ||
| "type": "ApplicationVolumeOptions" | ||
| } | ||
| ], | ||
| "returns": "Promise<void>", | ||
| "tags": [ | ||
| { | ||
| "name": "see", | ||
| "text": [ | ||
| { | ||
| "text": "https", | ||
| "kind": "text" | ||
| }, | ||
| { | ||
| "text": "://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/3547038-trackingauthorizationstatus", | ||
| "kind": "text" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "name": "since", | ||
| "text": [ | ||
| { | ||
| "text": "4.1.1", | ||
| "kind": "text" | ||
| } | ||
| ] | ||
| } | ||
| ], | ||
| "docs": "Report application volume to AdMob SDK", | ||
| "complexTypes": [ | ||
| "ApplicationVolumeOptions" | ||
| ], | ||
| "slug": "setapplicationvolume" | ||
| }, | ||
| { | ||
| "name": "showBanner", | ||
@@ -1105,3 +1187,5 @@ "signature": "(options: BannerAdOptions) => Promise<void>", | ||
| "AdMobInitializationOptions", | ||
| "MaxAdContentRating" | ||
| "MaxAdContentRating", | ||
| "ApplicationMutedOptions", | ||
| "ApplicationVolumeOptions" | ||
| ] | ||
@@ -1306,3 +1390,3 @@ }, | ||
| ], | ||
| "docs": "WAs an app developer,\nyou can indicate whether you want Google to treat your content as child-directed when you make an ad request.", | ||
| "docs": "As an app developer,\nyou can indicate whether you want Google to treat your content as child-directed when you make an ad request.", | ||
| "complexTypes": [ | ||
@@ -1321,3 +1405,5 @@ "MaxAdContentRating" | ||
| "AdMobPlugin", | ||
| "MaxAdContentRating" | ||
| "MaxAdContentRating", | ||
| "ApplicationMutedOptions", | ||
| "ApplicationVolumeOptions" | ||
| ] | ||
@@ -1353,2 +1439,102 @@ }, | ||
| { | ||
| "name": "ApplicationMutedOptions", | ||
| "slug": "applicationmutedoptions", | ||
| "docs": "", | ||
| "tags": [], | ||
| "methods": [], | ||
| "properties": [ | ||
| { | ||
| "name": "muted", | ||
| "tags": [ | ||
| { | ||
| "text": [ | ||
| { | ||
| "text": "https", | ||
| "kind": "text" | ||
| }, | ||
| { | ||
| "text": "://developers.google.com/admob/android/global-settings", | ||
| "kind": "text" | ||
| } | ||
| ], | ||
| "name": "see" | ||
| }, | ||
| { | ||
| "text": [ | ||
| { | ||
| "text": "4.1.1", | ||
| "kind": "text" | ||
| } | ||
| ], | ||
| "name": "since" | ||
| } | ||
| ], | ||
| "docs": "To inform the SDK that the app volume has been muted.\nNote: Video ads that are ineligible to be shown with muted audio are not returned for ad requests made,\nwhen the app volume is reported as muted or set to a value of 0. This may restrict a subset of the broader video ads pool from serving.", | ||
| "complexTypes": [], | ||
| "type": "boolean | undefined" | ||
| } | ||
| ], | ||
| "importObject": [ | ||
| "BannerDefinitions", | ||
| "InterstitialDefinitions", | ||
| "RewardDefinitions", | ||
| "TrackingAuthorizationStatusInterface", | ||
| "AdMobDefinitions", | ||
| "AdMobPlugin", | ||
| "AdMobInitializationOptions", | ||
| "MaxAdContentRating", | ||
| "ApplicationVolumeOptions" | ||
| ] | ||
| }, | ||
| { | ||
| "name": "ApplicationVolumeOptions", | ||
| "slug": "applicationvolumeoptions", | ||
| "docs": "", | ||
| "tags": [], | ||
| "methods": [], | ||
| "properties": [ | ||
| { | ||
| "name": "volume", | ||
| "tags": [ | ||
| { | ||
| "text": [ | ||
| { | ||
| "text": "https", | ||
| "kind": "text" | ||
| }, | ||
| { | ||
| "text": "://developers.google.com/admob/android/global-settings", | ||
| "kind": "text" | ||
| } | ||
| ], | ||
| "name": "see" | ||
| }, | ||
| { | ||
| "text": [ | ||
| { | ||
| "text": "4.1.1", | ||
| "kind": "text" | ||
| } | ||
| ], | ||
| "name": "since" | ||
| } | ||
| ], | ||
| "docs": "If your app has its own volume controls (such as custom music or sound effect volumes),\ndisclosing app volume to the Google Mobile Ads SDK allows video ads to respect app volume settings.\nenable set 0.0 - 1.0, any float allowed.", | ||
| "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", | ||
| "InterstitialDefinitions", | ||
| "RewardDefinitions", | ||
| "TrackingAuthorizationStatusInterface", | ||
| "AdMobDefinitions", | ||
| "AdMobPlugin", | ||
| "AdMobInitializationOptions", | ||
| "MaxAdContentRating", | ||
| "ApplicationMutedOptions" | ||
| ] | ||
| }, | ||
| { | ||
| "name": "BannerAdOptions", | ||
@@ -1355,0 +1541,0 @@ "slug": "banneradoptions", |
@@ -22,2 +22,16 @@ import type { BannerDefinitions } from './banner'; | ||
| trackingAuthorizationStatus(): Promise<TrackingAuthorizationStatusInterface>; | ||
| /** | ||
| * Report application mute state to AdMob SDK | ||
| * | ||
| * @see https://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/3547038-trackingauthorizationstatus | ||
| * @since 4.1.1 | ||
| */ | ||
| setApplicationMuted(options: ApplicationMutedOptions): Promise<void>; | ||
| /** | ||
| * Report application volume to AdMob SDK | ||
| * | ||
| * @see https://developer.apple.com/documentation/apptrackingtransparency/attrackingmanager/3547038-trackingauthorizationstatus | ||
| * @since 4.1.1 | ||
| */ | ||
| setApplicationVolume(options: ApplicationVolumeOptions): Promise<void>; | ||
| } | ||
@@ -66,3 +80,3 @@ export interface AdMobInitializationOptions { | ||
| /** | ||
| * WAs an app developer, | ||
| * As an app developer, | ||
| * you can indicate whether you want Google to treat your content as child-directed when you make an ad request. | ||
@@ -93,2 +107,24 @@ * | ||
| } | ||
| export interface ApplicationMutedOptions { | ||
| /** | ||
| * To inform the SDK that the app volume has been muted. | ||
| * Note: Video ads that are ineligible to be shown with muted audio are not returned for ad requests made, | ||
| * when the app volume is reported as muted or set to a value of 0. This may restrict a subset of the broader video ads pool from serving. | ||
| * | ||
| * @see https://developers.google.com/admob/android/global-settings | ||
| * @since 4.1.1 | ||
| */ | ||
| muted?: boolean; | ||
| } | ||
| export interface ApplicationVolumeOptions { | ||
| /** | ||
| * If your app has its own volume controls (such as custom music or sound effect volumes), | ||
| * disclosing app volume to the Google Mobile Ads SDK allows video ads to respect app volume settings. | ||
| * enable set 0.0 - 1.0, any float allowed. | ||
| * | ||
| * @see https://developers.google.com/admob/android/global-settings | ||
| * @since 4.1.1 | ||
| */ | ||
| volume?: 0.0 | 0.1 | 0.2 | 0.3 | 0.4 | 0.5 | 0.6 | 0.7 | 0.8 | 0.9 | 1.0; | ||
| } | ||
| export {}; |
| import { WebPlugin } from '@capacitor/core'; | ||
| import type { AdMobPlugin } from '.'; | ||
| import type { AdMobPlugin, ApplicationMutedOptions, ApplicationVolumeOptions } from '.'; | ||
| import type { AdMobRewardItem } from './reward'; | ||
@@ -11,2 +11,4 @@ import type { AdOptions, AdLoadInfo } from './shared'; | ||
| trackingAuthorizationStatus(): Promise<TrackingAuthorizationStatusInterface>; | ||
| setApplicationMuted(options: ApplicationMutedOptions): Promise<void>; | ||
| setApplicationVolume(options: ApplicationVolumeOptions): Promise<void>; | ||
| showBanner(options: AdOptions): Promise<void>; | ||
@@ -13,0 +15,0 @@ hideBanner(): Promise<void>; |
@@ -20,2 +20,8 @@ import { WebPlugin } from '@capacitor/core'; | ||
| } | ||
| async setApplicationMuted(options) { | ||
| console.log('setApplicationMuted', options); | ||
| } | ||
| async setApplicationVolume(options) { | ||
| console.log('setApplicationVolume', options); | ||
| } | ||
| async showBanner(options) { | ||
@@ -22,0 +28,0 @@ console.log('showBanner', options); |
@@ -192,2 +192,8 @@ 'use strict'; | ||
| } | ||
| async setApplicationMuted(options) { | ||
| console.log('setApplicationMuted', options); | ||
| } | ||
| async setApplicationVolume(options) { | ||
| console.log('setApplicationVolume', options); | ||
| } | ||
| async showBanner(options) { | ||
@@ -194,0 +200,0 @@ console.log('showBanner', options); |
@@ -189,2 +189,8 @@ var AdMobPlugin = (function (exports, core) { | ||
| } | ||
| async setApplicationMuted(options) { | ||
| console.log('setApplicationMuted', options); | ||
| } | ||
| async setApplicationVolume(options) { | ||
| console.log('setApplicationVolume', options); | ||
| } | ||
| async showBanner(options) { | ||
@@ -191,0 +197,0 @@ console.log('showBanner', options); |
| { | ||
| "name": "@capacitor-community/admob", | ||
| "version": "4.1.0", | ||
| "version": "4.2.0", | ||
| "description": "A native plugin for AdMob", | ||
@@ -5,0 +5,0 @@ "main": "dist/plugin.cjs.js", |
@@ -9,3 +9,3 @@ <p align="center"><br><img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" /></p> | ||
| <p align="center"> | ||
| <img src="https://img.shields.io/maintenance/yes/2022?style=flat-square" /> | ||
| <img src="https://img.shields.io/maintenance/yes/2023?style=flat-square" /> | ||
| <!-- <a href="https://github.com/capacitor-community/example/actions?query=workflow%3A%22CI%22"><img src="https://img.shields.io/github/workflow/status/capacitor-community/example/CI?style=flat-square" /></a> --> | ||
@@ -258,2 +258,4 @@ <a href="https://www.npmjs.com/package/@capacitor-community/admob"><img src="https://img.shields.io/npm/l/@capacitor-community/admob?style=flat-square" /></a> | ||
| * [`trackingAuthorizationStatus()`](#trackingauthorizationstatus) | ||
| * [`setApplicationMuted(...)`](#setapplicationmuted) | ||
| * [`setApplicationVolume(...)`](#setapplicationvolume) | ||
| * [`showBanner(...)`](#showbanner) | ||
@@ -322,2 +324,32 @@ * [`hideBanner()`](#hidebanner) | ||
| ### setApplicationMuted(...) | ||
| ```typescript | ||
| setApplicationMuted(options: ApplicationMutedOptions) => Promise<void> | ||
| ``` | ||
| Report application mute state to AdMob SDK | ||
| | Param | Type | | ||
| | ------------- | --------------------------------------------------------------------------- | | ||
| | **`options`** | <code><a href="#applicationmutedoptions">ApplicationMutedOptions</a></code> | | ||
| -------------------- | ||
| ### setApplicationVolume(...) | ||
| ```typescript | ||
| setApplicationVolume(options: ApplicationVolumeOptions) => Promise<void> | ||
| ``` | ||
| Report application volume to AdMob SDK | ||
| | Param | Type | | ||
| | ------------- | ----------------------------------------------------------------------------- | | ||
| | **`options`** | <code><a href="#applicationvolumeoptions">ApplicationVolumeOptions</a></code> | | ||
| -------------------- | ||
| ### showBanner(...) | ||
@@ -723,3 +755,3 @@ | ||
| | **`tagForUnderAgeOfConsent`** | <code>boolean</code> | When using this feature, a Tag For Users under the Age of Consent in Europe (TFUA) parameter will be included in all future ad requests. | | ||
| | **`maxAdContentRating`** | <code><a href="#maxadcontentrating">MaxAdContentRating</a></code> | WAs an app developer, you can indicate whether you want Google to treat your content as child-directed when you make an ad request. | | ||
| | **`maxAdContentRating`** | <code><a href="#maxadcontentrating">MaxAdContentRating</a></code> | As an app developer, you can indicate whether you want Google to treat your content as child-directed when you make an ad request. | | ||
@@ -734,2 +766,16 @@ | ||
| #### ApplicationMutedOptions | ||
| | Prop | Type | Description | | ||
| | ----------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | **`muted`** | <code>boolean</code> | To inform the SDK that the app volume has been muted. Note: Video ads that are ineligible to be shown with muted audio are not returned for ad requests made, when the app volume is reported as muted or set to a value of 0. This may restrict a subset of the broader video ads pool from serving. | | ||
| #### ApplicationVolumeOptions | ||
| | Prop | Type | Description | | ||
| | ------------ | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| | **`volume`** | <code>0 \| 1 \| 0.1 \| 0.2 \| 0.3 \| 0.4 \| 0.5 \| 0.6 \| 0.7 \| 0.8 \| 0.9</code> | If your app has its own volume controls (such as custom music or sound effect volumes), disclosing app volume to the Google Mobile Ads SDK allows video ads to respect app volume settings. enable set 0.0 - 1.0, any float allowed. | | ||
| #### BannerAdOptions | ||
@@ -736,0 +782,0 @@ |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by5.32%
270643
- Lines of code
- increased by7.48%
3477
- Number of lines in readme file
- increased by5.11%
947
No dependency changes