Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/admob-plus/admob-plus/llms.txt

Use this file to discover all available pages before exploring further.

The AdMobConfig interface defines the configuration options for initializing the AdMob SDK. It extends RequestConfig to include both global ad request settings and app-level settings.

​
Interface

interface AdMobConfig extends RequestConfig {
  appMuted?: boolean;
  appVolume?: number;
  sameAppKey?: boolean; // deprecated
  publisherFirstPartyIDEnabled?: boolean;
}

​
Properties

​
appMuted
boolean
Controls whether the app’s audio is muted for ads. When set to true, ad audio will be muted.
​
appVolume
number
Sets the app’s audio volume for ads. Value should be between 0.0 (silent) and 1.0 (full volume).
​
publisherFirstPartyIDEnabled
boolean
Enables publisher-provided first-party identifiers for improved ad targeting and measurement.
​
sameAppKey
boolean
deprecated
Deprecated: Use publisherFirstPartyIDEnabled instead.

​
Inherited from RequestConfig

​
maxAdContentRating
MaxAdContentRating
Maximum ad content rating for ads shown in the app. See RequestConfig for details.
​
tagForChildDirectedTreatment
boolean | null
Indicates whether to tag ad requests for child-directed treatment. See RequestConfig for details.
​
tagForUnderAgeOfConsent
boolean | null
Indicates whether the user is under the age of consent. See RequestConfig for details.
​
testDeviceIds
string[]
Array of test device IDs for receiving test ads. See RequestConfig for details.

​
Usage Example

import { AdMob } from '@admob-plus/cordova';

// Configure AdMob with global settings
await AdMob.configure({
  // App audio settings
  appMuted: false,
  appVolume: 0.8,
  
  // Privacy and compliance
  publisherFirstPartyIDEnabled: true,
  tagForChildDirectedTreatment: false,
  tagForUnderAgeOfConsent: false,
  
  // Ad content rating
  maxAdContentRating: 'PG',
  
  // Testing
  testDeviceIds: ['DEVICE_ID_1', 'DEVICE_ID_2']
});