EMI-INDO / emi-indo-cordova-plugin-admob

Cordova Plugin Admob Android | IOS
ISC License
12 stars 2 forks source link
admob admob-plus-cordova construct3 cordova-plugin-admob cordova-plugin-admob-free cordova-plugin-admob-pro javascript

emi-indo-cordova-plugin-admob

Cordova Plugin Admob Android and IOS

Mobile Ads SDK (Android: 23.5.0) Release Notes:

User Messaging Platform (UMP Android: 3.1.0) Release Notes:

Mobile Ads SDK (IOS: 11.10.0) Release Notes:

User Messaging Platform (UMP IOS: 2.6.0) Release Notes:

IAB Europe Transparency & Consent Framework (CPM: 2.2.0)

New example

Minimum Cordova Engines

IOS Ad Support IOS 18 *

[!WARNING]

  • emi-indo-cordova-plugin-admob@1.5.2 or higher
  • Minimum supported Xcode version up to 15.3 or higher
  • minimum deployment-target: 12.2

    Minimum macOS | Xcode, and others

  • minimum macOS 14.4 or higher
  • Xcode min 15.3 > or higher
  • Command Line Tools 15.3 or higher
  • minimum SwiftVersion: 5.10 or higher
  • Everything is included in plugin.xml
  • SKAdNetworkIdentifier Deprecated
  • Dependency: pod MerchantKit (not needed)

IOS

[!WARNING]

  • emi-indo-cordova-plugin-admob@1.5.1
  • Minimum supported Xcode version to 14.3
  • Maximum supported Xcode version up to 15.2

    Minimum macOS | Xcode, and others

  • Monterey
  • Xcode min 14.3 > max 15.2
  • Command Line Tools 14.1 or higher https://developers.google.com/admob/ios/quick-start
Guaranteed income using this plugin #14 > __Note__ > - ## It's Not a fork, it's purely rewritten, clean of 3rd party code. > __Note__ > - ### No Ad-Sharing > - ### No Remote Control > - ### I guarantee 100% revenue for you. > - [Code source:](https://github.com/googleads/googleads-mobile-android-examples) - Admob: > -

VIDEO Test Collapsible banner ads

Video

VIDEO Test UMP or CMP SDK Android

Video

VIDEO Test UMP or CMP SDK IOS

Video

VIDEO Test Ad Type with Xcode/IOS

Video

VIDEO Test Collapsible banner autoResize with Xcode/IOS

Video

💰Sponsor this project

PayPal

Check all release notes:

Features

Features #1
  • initialize
  • targeting
  • globalSettings
  • AppTrackingTransparency (ATT)
  • CMP SDK
  • UMP SDK
  • App Open Ads
  • Banner Ads
  • Interstitial Ads
  • Rewarded Ads
  • Mediation
  • impression-level-ad-revenue

Installation

Remove

cordova plugin rm emi-indo-cordova-plugin-admob

Note IOS

[!NOTE]

  • To prevent some warnings or errors in xcode later, it is best after adding platforms and plugins cd/project root/command line run cordova prepare.
  • after that just cd platform/ios command line run pod install --repo-update

Import the Mobile Ads SDK IOS

Then from the command line run:

>>> Device Ready <<<

Methods: #2
 

cordova.plugins.emiAdmobPlugin.initialize({

  isUsingAdManagerRequest: true, // true = AdManagerAdRequest.Builder | false = AdRequest.Builder (Default true)
  isResponseInfo: true, // Default false (Debug true)
  isConsentDebug: true, // Default false (Debug true)

  }

document.addEventListener('on.sdkInitialization', (data) => {
// JSON.stringify(data)
   const sdkVersion = data.version;
// const adAdapter = data.adapters;
// const conStatus = data.consentStatus;
// const gdprApplie = data.gdprApplies;
// const purposeConsent = data.purposeConsents;
// const vendorConsents = data.vendorConsents;
// const conTCString = data.consentTCString;
// const additionalConsent = data.additionalConsent;
console.log("On Sdk Initialization version: " + sdkVersion);

});

 // Support Platform: Android | IOS
cordova.plugins.emiAdmobPlugin.globalSettings({config_globalSettings}); // Optional
cordova.plugins.emiAdmobPlugin.targeting({config_Targeting}); // Optional
// UMP SDK 3.1.0
cordova.plugins.emiAdmobPlugin.getConsentRequest(); // (Platform: Both)  // Deprecated
cordova.plugins.emiAdmobPlugin.consentReset(); // (Platform: Both) // Optional
cordova.plugins.emiAdmobPlugin.showPrivacyOptionsForm(); // (Platform: Both) // Optional
// CMP SDK 2.2.0
 // Optional
cordova.plugins.emiAdmobPlugin.requestIDFA(); // UMP SDK to handle Apple's App Tracking Transparency (ATT) (Platform: IOS)
cordova.plugins.emiAdmobPlugin.getIabTfc((IABTFC) => { console.log(JSONstringify(IABTFC)) }); // CMP SDK 2.2 (Platform: Both)

Note setDebugGeography #2 Testing is very easy, no need for VPN, TEST-DEVICE-HASHED-ID, or anything else, everything has been made programmatically. must be false if the application is released to the play store / app store. consent from will continue to be called regardless of its status 0,1,2,3, until the value is changed to false. isConsentDebug: true | false
  • example
  •  
    
    document.addEventListener("deviceready", function(){
    
    document.addEventListener('on.sdkInitialization', (data) => {
    // JSON.stringify(data)
       const sdkVersion = data.version;
    // const adAdapter = data.adapters;
       const conStatus = data.consentStatus;
    // const gdprApplie = data.gdprApplies;
    // const purposeConsent = data.purposeConsents;
    // const vendorConsents = data.vendorConsents;
    // const conTCString = data.consentTCString;
    // const additionalConsent = data.additionalConsent;
    console.log("On Sdk Initialization version: " + data.consentStatus);
    console.log("On Consent Status: " + conStatus);
    
    });
    
    // cordova.plugins.emiAdmobPlugin.getConsentRequest( (ststus) => { console.log("Consent Status: " + ststus) }); // Deprecated
    // cordova.plugins.emiAdmobPlugin.showPrivacyOptionsForm();
    
    }, false);
    
    
    Event UMP SDK #3
     
     on.get.consent.status
     
  • example:#4
  •  
    document.addEventListener('on.get.consent.status', () => {
    
       console.log("on get consent status");
    
    });
    
    Event CMP SDK #5
     
    on.getIabTfc
    on.TCString.expired
    on.TCString.remove
     
    Note #6 TCString expires 360 days, plugin automatically deletes it after 360 days. call consentRest()
  • example: #7
  •  
    document.addEventListener('on.TCString.expired', () => {
    
       console.log("on TCString expires 360 days");
       cordova.plugins.emiAdmobPlugin.consentReset();
    
    });
    

    AppOpenAd ADS

    Methods:
     
     // Support Platform: Android | IOS
     cordova.plugins.emiAdmobPlugin.loadAppOpenAd({config});
     cordova.plugins.emiAdmobPlugin.showAppOpenAd(); // default
    
     
  • example:
  •  
    
     cordova.plugins.emiAdmobPlugin.loadAppOpenAd({ adUnitId: App_Open_ID, autoShow: true }); 
     ```
    
    Event
     
     on.appOpenAd.loaded
     on.appOpenAd.failed.loaded
     on.appOpenAd.dismissed
     on.appOpenAd.failed.show
     on.appOpenAd.show
     on.appOpenAd.revenue
    
     (DEBUG)
     on.appOpenAd.responseInfo
     
  • example:
  •  
    document.addEventListener('on.appOpenAd.loaded', () => {
    
       console.log("On App Open Ad loaded");
    
    });
    
    
    Methods:
     
    cordova.plugins.emiAdmobPlugin.styleBannerAd({ padding: 50, margins: 50 });  // (Optional only android)
    cordova.plugins.emiAdmobPlugin.loadBannerAd({config});
    cordova.plugins.emiAdmobPlugin.showBannerAd(); // default
    cordova.plugins.emiAdmobPlugin.hideBannerAd(); // default
    cordova.plugins.emiAdmobPlugin.removeBannerAd(); // default
    
  • example:
  •  
    
    ```
    const bannerConfig = {
    
       adUnitId: "ca-app-pub-3940256099942544/9214589741", //Banner_ID,
       position: "bottom-center",
       size: "responsive_adaptive", // autoResize: true (only responsive_adaptive)
       collapsible: "bottom", // position: top | bottom (disable, empty string)
       autoResize: true, // on.screen.rotated === orientation.portrait || on.screen.rotated === orientation.landscape
       autoShow: true, // boolean
    
    }
    
    cordova.plugins.emiAdmobPlugin.loadBannerAd(bannerConfig);
    ```
    
    
    Position type string
    top-right
    top-center
    left
    center
    right
    bottom-center
    bottom-right
    
    Size type string
    
    responsive_adaptive
    anchored_adaptive
    full_width_adaptive
    in_line_adaptive
    banner
    large_banner
    medium_rectangle
    full_banner
    leaderboard
    fluid
    
    
    Event
    on.banner.load
    on.banner.failed.load
    on.banner.click
    on.banner.close
    on.banner.impression
    on.banner.open
     // new
    on.banner.revenue
    on.banner.remove
    on.banner.hide
     // new
     on.is.collapsible
     on.bannerAd.responseInfo
    
  • example:
  •  
    document.addEventListener('on.banner.load', () => {
    
       console.log("on banner load");
    
    });
    
    document.addEventListener('on.is.collapsible', function(event) {
    // bannerConfig collapsible: "bottom", // position: top | bottom (disable, empty string)
    console.log("Collapsible Status: " + event.collapsible);
    
    });
    

    FULL Banner basic:

    Interstitial ADS

    Methods:
     
     // Support Platform: Android | IOS
    cordova.plugins.emiAdmobPlugin.loadInterstitialAd({config});
    cordova.plugins.emiAdmobPlugin.showInterstitialAd(); // default
    
     
  • example:
  •  
    
     cordova.plugins.emiAdmobPlugin.loadInterstitialAd({ adUnitId: "ca-app-pub-3940256099942544/1033173712", autoShow: true });
     ```
    
    
    Event
     
    on.interstitial.loaded
    on.interstitial.failed.load
    on.interstitial.click
    on.interstitial.dismissed
    on.interstitial.failed.show
    on.interstitial.impression
    on.interstitial.show
     // new
     on.interstitial.revenue
     on.interstitialAd.responseInfo
     
  • example:
  •  
    document.addEventListener('on.interstitial.loaded', () => {
    
       console.log("on interstitial Ad loaded");
    
    });
    
    // all events that contain the keyword dismissed there is a block to load the ad after it is closed by the user.
    // 'on.interstitial.dismissed' | 'on.rewardedInt.dismissed' | 'on.rewarded.dismissed'
    document.addEventListener('on.interstitial.dismissed', () => {
    
       console.log("on interstitial Ad dismissed");
       console.log("you can load ads automatically after the ads are closed by users");
       // loadInterstitialAd();
    
    });
    
    

    FULL Interstitial basic:

    Rewarded Interstitial ADS

    Methods:
     
     // Support Platform: Android | IOS
    cordova.plugins.emiAdmobPlugin.loadRewardedInterstitialAd({config});
    cordova.plugins.emiAdmobPlugin.showRewardedInterstitialAd(); // default
     
  • example:
  •  
    
     cordova.plugins.emiAdmobPlugin.loadRewardedInterstitialAd({ adUnitId: Rewarded_Interstitial_ID, autoShow: true });
    
    
    Event
     
    on.rewardedInt.loaded
    on.rewardedInt.failed.load
    on.rewardedInt.click
    on.rewardedInt.dismissed
    on.rewardedInt.failed.show
    on.rewardedInt.impression
    on.rewardedInt.showed
    on.rewardedInt.userEarnedReward
     // new
    on.rewardedInt.revenue
    on.rewardedInt.ad.skip
    on.rewardedIntAd.responseInfo
     
  • example:
  •  
    document.addEventListener('on.rewardedInt.loaded', () => {
    
       console.log("on rewarded Interstitial load");
    
    });
    
    // all events that contain the keyword dismissed there is a block to load the ad after it is closed by the user.
    // 'on.interstitial.dismissed' | 'on.rewardedInt.dismissed' | 'on.rewarded.dismissed'
    document.addEventListener('on.rewardedInt.dismissed', () => {
    
       console.log("on interstitial Ad dismissed");
       console.log("you can load ads automatically after the ads are closed by users");
       // loadRewardedInterstitialAd();
    
    });
    
    

    FULL Rewarded Interstitial basic: Not yet updated index.html

    Rewarded ADS

    Methods:
     
     // Support Platform: Android | IOS
    cordova.plugins.emiAdmobPlugin.loadRewardedAd({config});
    cordova.plugins.emiAdmobPlugin.showRewardedAd(); // default
     
  • example:
  •  
    
     cordova.plugins.emiAdmobPlugin.loadRewardedAd({ adUnitId: Rewarded_ID, autoShow: true });
    
    
    Event
     
    on.rewarded.loaded
    on.rewarded.failed.load
    on.rewarded.click
    on.rewarded.dismissed
    on.rewarded.failed.show
    on.rewarded.impression
    on.rewarded.show
    on.reward.userEarnedReward
     // new
    on.rewarded.revenue
    on.rewarded.ad.skip
    on.rewardedAd.responseInfo
    
     
  • example:
  •  
    document.addEventListener('on.rewarded.loaded', () => {
    
       console.log("on rewarded Ad loaded");
    
    });
    
    // all events that contain the keyword dismissed there is a block to load the ad after it is closed by the user.
    // 'on.interstitial.dismissed' | 'on.rewardedInt.dismissed' | 'on.rewarded.dismissed'
    document.addEventListener('on.rewarded.dismissed', () => {
    
       console.log("on interstitial Ad dismissed");
       console.log("you can load ads automatically after the ads are closed by users");
       // loadRewardedAd();
    
    });
    
    

    FULL Rewarded basic:

    New Method (Only Android)

    Ad Request Control

    [!WARNING]

    • isUsingAdManagerRequest: true
    • Must run before ad load
    targetingAdRequest
     
    
    // Check documentation:  https://developers.google.com/ad-manager/mobile-ads-sdk/android/targeting
    
    ```
    const configAdRequest = {
    
    // enabled, disabled
    customTargetingEnabled: false,
    categoryExclusionsEnabled: false,
    ppIdEnabled: false,
    contentURLEnabled: false,
    brandSafetyEnabled: false,
    
    // set Value
    customTargetingValue:  ["24", "25", "26"],     // age 
    categoryExclusionsValue: "automobile",       // automobile or boat
    ppIdValue: "AB123456789",    
    contentURLValue: "https://www.example.com",
    brandSafetyArr: ["https://www.mycontenturl1.com", "https://www.mycontenturl2.com"],
    
    }
    
    cordova.plugins.emiAdmobPlugin.targetingAdRequest(configAdRequest);
    ```
    
    
    setPersonalizationState
    
    // Check documentation:  https://developers.google.com/ad-manager/mobile-ads-sdk/android/targeting
    
    cordova.plugins.emiAdmobPlugin.setPersonalizationState({
    
    setPersonalizationState: "disabled" // type string: disabled | enabled
    
    });
    
    
    setPPS
    
    // Check documentation:  https://developers.google.com/ad-manager/mobile-ads-sdk/android/targeting
    
    ```
    cordova.plugins.emiAdmobPlugin.setPPS({
    
    ppsEnabled: false, // enabled, disabled
    iabContent: "IAB_AUDIENCE_1_1",  // Type string value: IAB_AUDIENCE_1_1 or IAB_CONTENT_2_2
    ppsArrValue: [6,284],  // type arr 
    
    });
    
    ```
    
    
    Example:
    
    // Check documentation:  https://developers.google.com/ad-manager/mobile-ads-sdk/android/targeting
    
    ```
    function callSetPPS(){
    
    cordova.plugins.emiAdmobPlugin.setPPS({
    
    ppsEnabled: true, // enabled, disabled
    iabContent: "IAB_AUDIENCE_1_1",  // Type string value: IAB_AUDIENCE_1_1 or IAB_CONTENT_2_2
    ppsArrValue: [6,284],  // type arr 
    
    });
    
    }
    
    if (callSetPPS()){
    
       cordova.plugins.emiAdmobPlugin.loadRewardedAd({ adUnitId: Rewarded_ID, autoShow: true });
    
    }
    
    ```
    
    

    New Method (Only IOS)

    /*

    Sometimes the consent form in IOS is difficult to display, because ATT has been set by the user, The problem is TCString null, causing very few admob ads to load, This method will force the consent form to be displayed, whatever the user's decision TCString will not be null.

    */

    // Use your own logic, this is just an example
    
      let userGdpr = null; // global Variable
      let userTCString = null; // global Variable
    
      document.addEventListener('on.sdkInitialization', (data) => {
      userGdpr = data.gdprApplies;
      userTCString = data.consentTCString;
     });
    
     if (userGdpr === 1 && userTCString === null){
    
      cordova.plugins.emiAdmobPlugin.forceDisplayPrivacyForm();
    
    }

    GLOBAL EVENT Screen (Optional)

    Event:
     
    on.screen.rotated
    on.orientation.portrait
    on.orientation.landscape
    
    Features and Coming soon #13 ## Features - SDK initialize - targeting - globalSettings - App Open Ads - Banner Ads - Interstitial Ads - Rewarded Ads - Rewarded interstitial Ads - [Consent Not yet updated](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/example/Advanced%20topics/consent.html) - Mediation - impression-level-ad-revenue - GDPR IAB TFCv2.2 - AppTrackingTransparency (ATT) - Collapsible banner ads (BETA) ## Coming soon - App Open Ads ( Finished ) - User Consent ( Finished ) - Mediation ( Finished ) - https://developers.google.com/admob/android/native/start - https://developers.google.com/admob/android/impression-level-ad-revenue ( Finished ) v1.1.9 - https://developers.google.com/admob/android/ssv - https://developers.google.com/admob/android/privacy/gdpr ( Finished ) v1.4.0 [index.html](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/example/Advanced%20topics/consent_GDPR_IAB_TFCv2.2.html) - https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/ ( Finished ) v1.4.0 [index.html](https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/example/Advanced%20topics/consent_GDPR_IAB_TFCv2.2.html)

    IAB Europe Transparency & Consent Framework

    Example How to read consent choices #12 // index.html https://github.com/EMI-INDO/emi-indo-cordova-plugin-admob/blob/main/example/Advanced%20topics/consent_GDPR_IAB_TFCv2.2.html ```sh // >>>>>>>> New features (UMP) SDK v2.1.0 // https://developers.google.com/admob/android/privacy/gdpr /* If the user chooses not to display ads, you can restrict access to the app, or ban it, until they change their decision back, Just call showPrivacyOptionsForm(); */ cordova.plugins.emiAdmobPlugin.getIabTfc( (info) => { // How to read consent choices console.log("IABTCF_gdprApplies: " + info.IABTCF_gdprApplies); console.log("IABTCF_PurposeConsents: " + info.IABTCF_PurposeConsents); console.log("IABTCF_TCString: " + info.IABTCF_TCString); // A small example var fundingChoices; fundingChoices = info.IABTCF_PurposeConsents; if (fundingChoices === "1111111111"){ // Enable app features. loadRewardedAd(); } else if (fundingChoices === "") { // disable app features. } else { // You have to test everything yourself. console.log(info); } }, (error) => { console.log("Error: " + error); }); ```

    Admob Mediation (supports both platforms)

    Mediation #9 ## get Mediation Adapter Name isResponseInfo: true, // debug Default false // (debugging) ## Meta Audience Network [Integrate Meta Audience Network with bidding :](https://developers.google.com/admob/android/mediation/meta) - (Adapter default: 6.13.7.0) ### Installation ```sh cordova plugin add emi-indo-cordova-plugin-mediation-meta ``` - ================================ ## Unity Ads [Integrate Unity Ads with Mediation :](https://developers.google.com/admob/android/mediation/unity) - (Adapter default: 4.6.1.0) ### Installation ```sh cordova plugin add emi-indo-cordova-plugin-mediation-unity ``` - ================================ ## AppLovin Ads [Integrate AppLovin with Mediation :](https://developers.google.com/admob/android/mediation/applovin) - (Adapter default: 11.8.2.0) ### Installation ```sh cordova plugin add emi-indo-cordova-plugin-mediation-applovin ``` - ================================ ## AdColony Ads [Integrate AdColony with Mediation :](https://developers.google.com/admob/android/mediation/adcolony) - (Adapter default: 4.8.0.1) ### Installation ```sh cordova plugin add emi-indo-cordova-plugin-mediation-adcolony ``` - ================================ ## Chartboost Ads [Integrate Chartboost with Mediation :](https://developers.google.com/admob/android/mediation/chartboost) - (Adapter default: 9.2.1.0) ### Installation ```sh cordova plugin add emi-indo-cordova-plugin-mediation-chartboost ``` - ================================ ## ironSource Ads [Integrate ironSource with Mediation :](https://developers.google.com/admob/android/mediation/ironsource) - (Adapter default: 7.2.7.0) ### Installation ```sh cordova plugin add emi-indo-cordova-plugin-mediation-ironsource ```

    Variables name or preference name

    Variables name #10 > __Warning__ > This is so that if I don't have time to update the Mediation Adapter version later, you can do it yourself as below. - Cordova CLI Update Adapter version with Variables ```sh cordova plugin add emi-indo-cordova-plugin-mediation-meta --save --variable META_ADAPTER_VERSION="xxxxx" --variable IOS_META_ADAPTER_VERSION="xxxxx" ``` - Update Adapter version with config.xml ```sh ``` ### Variables Name - --variable META_ADAPTER_VERSION="xxxxx" --variable IOS_META_ADAPTER_VERSION="xxxxx" - --variable UNITY_ADAPTER_VERSION="xxxxx" --variable IOS_UNITY_ADAPTER_VERSION="xxxxx" - --variable APPLOVIN_ADAPTER_VERSION="xxxxx" --variable IOS_APPLOVIN_ADAPTER_VERSION="xxxxx" - --variable ADCOLONY_ADAPTER_VERSION="xxxxx" --variable IOS_ADCOLONY_ADAPTER_VERSION="xxxxx" - --variable CHARTBOOST_ADAPTER_VERSION="xxxxx" --variable IOS_CHARTBOOST_ADAPTER_VERSION="xxxxx" - --variable IRONSOURCE_ADAPTER_VERSION="xxxxx" --variable IOS_IRONSOURCE_ADAPTER_VERSION="xxxxx" ### preference name ## (ANDROID) - META_ADAPTER_VERSION - UNITY_ADAPTER_VERSION - APPLOVIN_ADAPTER_VERSION - ADCOLONY_ADAPTER_VERSION - CHARTBOOST_ADAPTER_VERSION - IRONSOURCE_ADAPTER_VERSION ## (IOS) - IOS_META_ADAPTER_VERSION - IOS_UNITY_ADAPTER_VERSION - IOS_APPLOVIN_ADAPTER_VERSION - IOS_ADCOLONY_ADAPTER_VERSION - IOS_CHARTBOOST_ADAPTER_VERSION - IOS_IRONSOURCE_ADAPTER_VERSION - ================================

    💰Sponsor this project

    PayPal

    Earn more money, with other ad networks.

    Other plugins #11 - ### emi-indo-cordova-plugin-fan [Facebook Audience Network:](https://github.com/EMI-INDO/emi-indo-cordova-plugin-fan) - Ads: - ### emi-indo-cordova-plugin-unityads [Cordova Plugin Unity:](https://github.com/EMI-INDO/emi-indo-cordova-plugin-unityads) - Ads: ## New Open AI - ### emi-indo-cordova-plugin-open-ai [Cordova Plugin Open Ai:](https://github.com/EMI-INDO/emi-indo-cordova-plugin-open-ai) - Open AI: ## New Firebase Analytics - ### emi-indo-cordova-plugin-fanalytics [Cordova Plugin Firebase Analytics:](https://github.com/EMI-INDO/emi-indo-cordova-plugin-fanalytics) - Firebase Analytics: