taptap-ad

2

Install

npm install taptap-ad
npx cap sync

API

• initialize(...)
• echo(...)
• trackingAuthorizationStatus()
• requestTrackingAuthorization()
• setApplicationMuted(...)
• setApplicationVolume(...)
• Interfaces
• Enums

initialize(...)

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

Initialize AdMob with AdMobInitializationOptions

| Param | Type | Description | | ------------- | --------------------------------------------------------------------------------- | -------------------------------------------------------------------- | | options | AdMobInitializationOptions | AdMobInitializationOptions |

Since: 1.1.2

echo(...)

echo(options: { value: string; }) => Promise<{ value: string; }>

| Param | Type | | ------------- | ------------------------------- | | options | { value: string; } |

Returns: Promise<{ value: string; }>

trackingAuthorizationStatus()

trackingAuthorizationStatus() => Promise<TrackingAuthorizationStatusInterface>

Confirm requestTrackingAuthorization status (iOS >14)

Returns: Promise<TrackingAuthorizationStatusInterface>

Since: 3.1.0

requestTrackingAuthorization()

requestTrackingAuthorization() => Promise<void>

request requestTrackingAuthorization (iOS >14). This is deprecated method. We recommend UMP Consent.

Since: 5.2.0

setApplicationMuted(...)

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

Report application mute state to AdMob SDK

| Param | Type | | ------------- | --------------------------------------------------------------------------- | | options | ApplicationMutedOptions |

Since: 4.1.1

setApplicationVolume(...)

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

Report application volume to AdMob SDK

| Param | Type | | ------------- | ----------------------------------------------------------------------------- | | options | ApplicationVolumeOptions |

Since: 4.1.1

Interfaces

AdMobInitializationOptions

| Prop | Type | Description | Default | Since | | ---------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- | | testingDevices | string[] | An Array of devices IDs that will be marked as tested devices if {@link AdMobInitializationOptions.initializeForTesting} is true (Real Ads will be served to Testing devices, but they will not count as 'real'). | | 1.2.0 | | initializeForTesting | boolean | If set to true, the devices on {@link AdMobInitializationOptions.testingDevices} will be registered to receive test production ads. | false | 1.2.0 | | tagForChildDirectedTreatment | boolean | For purposes of the Children's Online Privacy Protection Act (COPPA), there is a setting called tagForChildDirectedTreatment. | | 3.1.0 | | tagForUnderAgeOfConsent | boolean | 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. | | 3.1.0 | | maxAdContentRating | MaxAdContentRating | As an app developer, you can indicate whether you want Google to treat your content as child-directed when you make an ad request. | | 3.1.0 |

TrackingAuthorizationStatusInterface

| Prop | Type | | ------------ | ------------------------------------------------------------------------ | | status | 'authorized' | 'denied' | 'notDetermined' | 'restricted' |

ApplicationMutedOptions

| Prop | Type | Description | Since | | ----------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | | muted | boolean | 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. | 4.1.1 |

ApplicationVolumeOptions

| Prop | Type | Description | Since | | ------------ | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- | | volume | 0 | 1 | 0.1 | 0.2 | 0.3 | 0.4 | 0.5 | 0.6 | 0.7 | 0.8 | 0.9 | 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. | 4.1.1 |

Enums

MaxAdContentRating

| Members | Value | Description | | ---------------------- | ------------------------------- | ----------------------------------------------------------- | | General | 'General' | Content suitable for general audiences, including families. | | ParentalGuidance | 'ParentalGuidance' | Content suitable for most audiences with parental guidance. | | Teen | 'Teen' | Content suitable for teen and older audiences. | | MatureAudience | 'MatureAudience' | Content suitable only for mature audiences. |