Skip to content

Latest commit

 

History

History
133 lines (93 loc) · 5.71 KB

README.md

File metadata and controls

133 lines (93 loc) · 5.71 KB
Raw

simpleam, Simple AdMob

Simple AdMob support for monetizing your android projects made with python. Firstly was designed for pygame android applications, but I guess it can be used in other frameworks? This "module" is inspired by KivMob, so you should definitely check it out too.

Now I`ll explain here the basic usage of this "module":
Take in mind, this module requires from you basic knowledge of p4a and buidozer. In case you dont understand something, you can check Google firebase docs or example folder.

Modifications to buildozer.spec file:

  • android.permissions = INTERNET, ACCESS_NETWORK_STATE, AD_ID
  • android.api = 33
  • android.ndk = 25b
  • android.gradle_dependencies = com.google.android.gms:play-services-ads:22.1.0,com.google.gms:google-services:4.3.15,androidx.work:work-runtime:2.7.1
  • p4a.branch = master
  • android.meta_data = com.google.android.gms.ads.APPLICATION_ID=ca-app-pub-3940256099942544~3347511713 (TEST app ID, in release use your own app ID)
  • android.add_src = java

It's better to mention, that you dont actually need to download jnius on your pc. Buildozer can download it when building your app.

To use the module, you have to initialize mobile ads first. You can do it by this function:
simpleam.simpleam_init()

Now, you can actually create some objects. Let's create a banner:
banner = simpleam.Banner(ad_id=None, position="BOTTOM", size="SMART_BANNER")

This will create a banner in the bottom part of the screen, with "smart" size, which will automatically pick the best banner size.
Position should be a constant, representing a layout.Gravity class constant. For example, "LEFT" = Gravity.LEFT, "CENTER" = Gravity.CENTER etc.
For more, check this documentation

Banner size however, can be a constant or custom tuple (Which of course not always can be displayed. Use constant size) SMART_BANNER would be the best, because it automatically scales depending on your device screen. But if you want use other sizes, you can pass a (x, y) argument, or other constants

That's all cool and anything, but how do I display the banner itself?

Firstly, you have to load an ad.
banner.load_ad()
All AdMob objects have this method, so it's quite similar. It basically creates an ad builder, which then requests an ad from google.
The loading itself takes time, so you have to plan how to use ads effectively

You can also filter ad, by passing in a dict argument: 

ad_filters = {"children": True, "family": True} 
#children - ad is designed for shildren. family - ad is designed for families. Quite simple.
banner.load_ad(ad_filters)

After loading an ad, you can actually display it. Banner has a method to change it`s visibility: 

banner.set_visibility(True) 
#True - visible, False - invisible`

And that's it! Congratulations on your first ad object!

The next ad object is Interstitial. It's a fast ad that appears on the fullscreen. It's quite easy to setup.

interstitial = simpleam.Interstitial(ad_id=None)
interstitial.load_ad(filters = {})
interstitial.show()

There are some differences:

  1. Interstitial can take 2 AdMob IDs. 1 - Image interstitial ID, and 2 - Video interstitial ID. Quite simple. Want video? Create interstitial with video ID. No? Create without.
  2. Interstitial and Rewarded instead of set_visibility() method, have show method.
  3. Interstitial and Rewarded also have is_loaded() method, which indicates, if your ad is loaded. Use it in needed situations.

And now the last thing, Rewarded ad. It takes some code examples, but I couldnt say it's hard to understand. Let's start from the template:

points = 0
rewarded = simplead.Rewarded(ad_id=None)

class FullScreenContentCallbacks:
    def onAdClicked (self):
        print("simpleam: FullScreenContentCallbacks : onAdClicked")
    def onAdDismissedFullScreenContent(self):
        print("simpleam: FullScreenContentCallbacks : onAdDismissedFullScreenContent")
    def onAdFailedToShowFullScreenContent(self, adError):
        print(f"simpleam: FullScreenContentCallbacks : onAdFailedToShowFullScreenContent : {adError.toString()}")
    def onAdImpression(self):
        print("simpleam: FullScreenContentCallbacks : onAdImpression")
    def onAdShowedFullScreenContent(self):
        print("simpleam: FullScreenContentCallbacks : onAdShowedFullScreenContent")

class PaidEventCallbacks:
    def onPaidEvent(self, value):
        print(f"simpleam: PaidEventCallbacks : onPaidEvent : code : {value.getCurrencyCode()}, precision : {value.getPrecisionType()}, value: {value.getValueMicros()}")      
        
class OnUserEarnedRewardCallbacks:
    def onUserEarnedReward(self, reward):
        print(f"simpleam: OnUserEarnedRewardCallbacks : onUserEarnedReward : amount : {reward.getAmount()}, type  : {reward.getType()}")   
		points += 50

# Loads our listeners in the rewarded ad class. Now we can load a video
rewarded.set_FullScreenContentCallbacks(self, FullScreenContentCallbacks()):        
rewarded.set_OnUserEarnedRewardListener(self, OnUserEarnedRewardCallbacks()):
rewarded.set_OnPaidEventListener(self, PaidEventCallbacks()):
rewarded.load_ad()

if rewarded.is_loaded():
	rewarded.show()
# I`ll be back in 10 seconds.

Be careful, because sometimes ad can fail to load!

And that's it!

I hope this guide makes sense. If you still have a confusion, check out example folder. And I, wish you goodluck monetizing your pygame, android projects!

DONT FORGET TO USE TEST IDS WHEN TESTING. GOOGLE WILL BAN YOUR ACCOUNT