Merge pull request #61 from pozirk/master

Some updates

Author: pozirk

.github/workflows/main.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        example: [appopen, banner, interstitial, rewarded]
+        example: [admobtest]
     steps:
       - name: Checkout
         uses: actions/checkout@main
@@ -28,7 +28,6 @@ jobs:
       - name: Install Haxe Libraries
         run: |
           haxelib install lime --quiet --never --skip-dependencies
-          haxelib install extension-androidtools --quiet --never --skip-dependencies
           haxelib dev extension-admob .
 
       - name: Setup hxcpp Library
@@ -58,7 +57,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        example: [appopen, banner, interstitial, rewarded]
+        example: [admobtest]
     steps:
       - name: Checkout
         uses: actions/checkout@main

LICENSE.md

@@ -3,7 +3,7 @@ License
 
 The MIT License (MIT)
 
-Copyright (c) 2023 Pozirk Games (https://www.pozirk.com/)
+Copyright (c) 2025 Haxe/Lime/NME/OpenFL contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -21,7 +21,7 @@ To install **extension-admob**, follow these steps:
 3. **Project Configuration** (Add the following code to your **project.xml** file)
    ```xml
    <section if="cpp">
-   	<haxelib name="extension-admob" if="mobile" />
+     <haxelib name="extension-admob" if="mobile" />
    </section>
    ```
 
@@ -44,74 +44,89 @@ To configure **extension-admob** for your project, follow these steps:
 
 3. **GDPR Consent Management**  
    Beginning January 16, 2024, Google requires publishers serving ads in the EEA and UK to use a certified consent management platform (CMP). This extension integrates Google's UMP SDK to display a consent dialog during the first app launch. Ads may not function if the user does not provide consent.
+   
+3. **Initializing Admob extension**  
+   If GDPR consent dialog and/or iOS 14+ tracking authorization dialog are required, they are should automatically upon Admob initialization.
+   ```haxe
+   import extension.admob.*;
+   ...
+   Admob.setCallback(function(event:String, message:String):Void
+   {
+      if (event == AdmobEvent.INIT_OK)
+        //you can load your ads here
+   });
+   Admob.init();
+   ```
 
 4. **Checking GDPR Consent Requirements**  
-   You can determine if the GDPR consent dialog is required based on the user's location:
+   After consenting (or not) to show ads, user must have an option to change his choice.
+   To give this choice an access to GDPR consent dialog should be provided somewhere in the app.
+   You can determine if the GDPR consent dialog is required (ie user is from EEA or UK):
    ```haxe
-   if (extension.admob.Admob.isPrivacyOptionsRequired())
+   if (Admob.isPrivacyOptionsRequired())
        trace("GDPR consent dialog is required.");
    ```
+   
+5. **Reopen Privacy Options Dialog**  
+   If needed, allow users to manage their GDPR consent options again.
+   ```haxe
+   Admob.showPrivacyOptionsForm();
+   ```
 
-5. **Verify User Consent**
+6. **Verify User Consent**  
    Check if the user has consented to personalized ads:
    ```haxe
-   if (extension.admob.Admob.getConsent() == extension.admob.AdmobConsent.FULL)
+   if (Admob.getConsent() == AdmobConsent.FULL)
     trace("User consented to personalized ads.");
    else
-    trace("User did not consent to personalized ads. Ads may not work.");
+    trace("User did not consent to personalized ads.");
    ```
 
-6. **Check Consent for Specific Purposes**
+7. **Check Consent for Specific Purposes**  
    Verify if the user has consented to individual purposes, such as purpose 0:
    ```haxe
-   if (extension.admob.Admob.hasConsentForPurpose(0) == 1)
+   if (Admob.hasConsentForPurpose(0) == 1)
     trace("User has consented to purpose 0.");
    else
     trace("User has not consented to purpose 0.");
    ```
 
-7. Reopen Privacy Options Dialog
-   If needed, allow users to manage their consent options again.
-   ```haxe
-   extension.admob.Admob.showPrivacyOptionsForm();
-   ```
-
-8. Load and Show Ads
+8. **Load and Show Ads**  
    Add the following snippets to display ads in your app:
 
    - **Banner Ad**
      ```haxe
-     extension.admob.Admob.showBanner("ca-app-pub-XXXX/XXXXXXXXXX");
+     Admob.showBanner("ca-app-pub-XXXX/XXXXXXXXXX");
      ```
 
    - **Interstitial Ad**
      ```haxe
-     extension.admob.Admob.onStatus.add(function(event:String, message:String):Void
+     Admob.setCallback(function(event:String, message:String):Void
      {
-     	if (event == extension.admob.AdmobEvent.INTERSTITIAL_LOADED)
-     		extension.admob.Admob.showInterstitial();
+       if (event == AdmobEvent.INTERSTITIAL_LOADED)
+         Admob.showInterstitial();
      });
-     extension.admob.Admob.loadInterstitial("ca-app-pub-XXXX/XXXXXXXXXX");
+     Admob.loadInterstitial("ca-app-pub-XXXX/XXXXXXXXXX");
      ```
 
    - **Rewarded Ad**
      ```haxe
-     extension.admob.Admob.onStatus.add(function(event:String, message:String):Void
+     Admob.setCallback(function(event:String, message:String):Void
      {
-     	if (event == extension.admob.AdmobEvent.REWARDED_LOADED)
-     		extension.admob.Admob.showRewarded();
+       if (event == AdmobEvent.REWARDED_LOADED)
+         Admob.showRewarded();
      });
-     extension.admob.Admob.loadRewarded("ca-app-pub-XXXX/XXXXXXXXXX");
+     Admob.loadRewarded("ca-app-pub-XXXX/XXXXXXXXXX");
      ```
 
    - **App Open Ad**
      ```haxe
-     extension.admob.Admob.onStatus.add(function(event:String, message:String):Void
+     Admob.setCallback(function(event:String, message:String):Void
      {
-     	if (event == extension.admob.AdmobEvent.APP_OPEN_LOADED)
-     		extension.admob.Admob.showAppOpen();
+       if (event == AdmobEvent.APP_OPEN_LOADED)
+         Admob.showAppOpen();
      });
-     extension.admob.Admob.loadAppOpen("ca-app-pub-XXXX/XXXXXXXXXX");
+     Admob.loadAppOpen("ca-app-pub-XXXX/XXXXXXXXXX");
      ```
 
 ### Disclaimer
@@ -124,4 +139,4 @@ To configure **extension-admob** for your project, follow these steps:
 
 The MIT License (MIT) - [LICENSE.md](LICENSE.md)
 
-Copyright (c) 2023 Pozirk Games contributors
+Copyright (c) 2025 Haxe/Lime/NME/OpenFL contributors

examples/appopen/project.xml examples/admobtest/project.xml

@@ -6,14 +6,13 @@
 	<!-- https://developers.google.com/admob/ios/quick-start -->
 	<setenv name="ADMOB_APPID" value="ca-app-pub-3940256099942544~1458002511" if="ios" />
 
-	<meta title="Extension-Admob Test" package="org.openfl.lime.samples.helloworld" version="1.0.0" company="OpenFL" />
+	<meta title="Extension-Admob Test" package="org.haxe.extensions.admob" version="1.0.0" company="Home-made Extensions Inc." />
 
 	<app main="Main" path="export" file="EATest" />
 
 	<source path="source" />
 
 	<haxelib name="lime" />
-	<haxelib name="extension-androidtools" if="android" />
 	<haxelib name="extension-admob" />
 
 	<haxeflag name="-dce" value="full" />

examples/admobtest/source/Main.hx

@@ -0,0 +1,90 @@
+package;
+
+import extension.admob.*;
+
+class Main extends lime.app.Application
+{
+#if android
+	//these are test ids from here: https://developers.google.com/admob/android/test-ads
+	private static final APP_OPEN_ID:String = "ca-app-pub-3940256099942544/9257395921";
+	private static final REWARDED_ID:String = "ca-app-pub-3940256099942544/5224354917";
+	private static final INTERSTITIAL_ID:String = "ca-app-pub-3940256099942544/1033173712";
+	private static final ADAPTIVE_BANNER_ID:String = "ca-app-pub-3940256099942544/9214589741";
+	private static final BANNER_ID:String = "ca-app-pub-3940256099942544/6300978111";
+#elseif ios
+	//https://developers.google.com/ad-manager/mobile-ads-sdk/ios/test-ads
+	private static final APP_OPEN_ID:String = "/21775744923/example/app-open";
+	private static final REWARDED_ID:String = "/21775744923/example/rewarded";
+	private static final INTERSTITIAL_ID:String = "/21775744923/example/interstitial";
+	private static final ADAPTIVE_BANNER_ID:String = "/21775744923/example/adaptive-banner";
+	private static final BANNER_ID:String = "/21775744923/example/fixed-size-banner";
+#end
+
+	public function onCallback(event:String, message:String)
+	{
+		switch(event)
+		{
+			case AdmobEvent.INIT_OK:
+				Admob.setVolume(0.5);
+				trace("isPrivacyOptionsRequired", Admob.isPrivacyOptionsRequired());
+				trace("getConsent", Admob.getConsent());
+				trace("hasConsentForPurpose", Admob.hasConsentForPurpose(0));
+				Admob.loadAppOpen(APP_OPEN_ID);
+				
+			case AdmobEvent.APP_OPEN_LOADED:
+				Admob.showAppOpen();
+				
+			case AdmobEvent.APP_OPEN_DISMISSED, AdmobEvent.APP_OPEN_FAILED_TO_LOAD, AdmobEvent.APP_OPEN_FAILED_TO_SHOW:
+				Admob.loadRewarded(REWARDED_ID);
+
+			case AdmobEvent.REWARDED_LOADED:
+				Admob.showRewarded();
+
+			case AdmobEvent.REWARDED_DISMISSED, AdmobEvent.REWARDED_FAILED_TO_LOAD, AdmobEvent.REWARDED_FAILED_TO_SHOW:
+				Admob.loadInterstitial(INTERSTITIAL_ID);
+
+			case AdmobEvent.INTERSTITIAL_LOADED:
+				Admob.showInterstitial();
+
+			case AdmobEvent.INTERSTITIAL_DISMISSED, AdmobEvent.INTERSTITIAL_FAILED_TO_LOAD, AdmobEvent.INTERSTITIAL_FAILED_TO_SHOW:
+				Admob.showBanner(ADAPTIVE_BANNER_ID);
+				//Admob.showBanner(BANNER_ID, AdmobBannerSize.BANNER, AdmobBannerAlign.TOP);
+
+			case AdmobEvent.APP_OPEN_CLICKED, AdmobEvent.INTERSTITIAL_CLICKED, AdmobEvent.REWARDED_CLICKED, AdmobEvent.BANNER_CLICKED:
+				trace("DINHEIRO!");
+
+			case AdmobEvent.REWARDED_EARNED:
+				trace("REWARD EARNED");
+		}
+
+		trace(event, message);
+	}
+
+	public override function onWindowCreate():Void
+	{
+		Admob.setCallback(onCallback);
+		Admob.init(true); //It feels like in iOS, you still need to set test mode even with test ids for all the ads variants to work
+	}
+
+	public override function render(context:lime.graphics.RenderContext):Void
+	{
+		switch (context.type)
+		{
+			case CAIRO:
+				context.cairo.setSourceRGB(0.75, 1, 0);
+				context.cairo.paint();
+			case CANVAS:
+				context.canvas2D.fillStyle = '#BFFF00';
+				context.canvas2D.fillRect(0, 0, window.width, window.height);
+			case DOM:
+				context.dom.style.backgroundColor = '#BFFF00';
+			case FLASH:
+				context.flash.graphics.beginFill(0xBFFF00);
+				context.flash.graphics.drawRect(0, 0, window.width, window.height);
+			case OPENGL | OPENGLES | WEBGL:
+				context.webgl.clearColor(0.75, 1, 0, 1);
+				context.webgl.clear(context.webgl.COLOR_BUFFER_BIT);
+			default:
+		}
+	}
+}