+ Ad
+
+ Ad
+
+
+
+constructor()
+
+
+
+ 
+
+[Basic-Ads](https://basic.lexilabs.app/basic-ads) [](https://central.sonatype.com/artifact/app.lexilabs.basic/basic-ads)
+
+A Kotlin Multiplatform library to rapidly get Gooble AdMob running on Android and iOS
+
+
+
+
+### How it works
+Basic-Ads uses the existing Android and iOS Google AdMob libraries to display ads as `Composables`.
+A [full walkthrough](https://medium.com/@robert.jamison/composable-ads-f8795924aa0d) is available on my Medium Blog.
+
+## Preparation
+For **Android**, complete the steps in AdMob's instructions:
+
+* [Configure your app](https://developers.google.com/admob/android/quick-start#import_the_mobile_ads_sdk)
+
+For **iOS**, complete the steps in AdMob's instructions:
+
+* [Import the Mobile Ads SDK](https://developers.google.com/admob/ios/quick-start#import_the_mobile_ads_sdk)
+
+* [Update your Info.plist](https://developers.google.com/admob/ios/quick-start#update_your_infoplist)
+
+***NOTE: For Xcode 13+, you can update your [Custom iOS Target Properties](https://useyourloaf.com/blog/xcode-13-missing-info.plist/).***
+
+## Installation
+Add your dependencies from Maven
+```toml
+# in your 'libs.versions.toml' file
+[versions]
+lexilabs-basic = "+" # gets the latest version
+google-play-services-ads = "+" # you did this during the preparation step
+
+[libraries]
+lexilabs-basic-images = { module = "app.lexilabs.basic:basic-ads", version.ref = "lexilabs-basic"}
+google-play-services-ads = { module = "com.google.android.gms:play-services-ads", version.ref = "google-play-services-ads"}
+```
+
+then include the library in your gradle build
+```kotlin
+// in your 'composeApp/build.gradle.kts' file
+sourceSets {
+ commonMain.dependencies {
+ implementation(libs.lexilabs.basic.ads)
+ implementation(libs.google.play.services.ads)
+ }
+}
+```
+
+## Usage
+Call [BasicAds.initialize] in your `commonMain` before building ads.
+***NOTE: You do not need to initialize within each platform.***
+
+```kotlin
+// in your 'composeApp/src/commonMain/App.kt' file
+@OptIn(DependsOnGoogleMobileAds::class)
+@Composable
+fun App() {
+ // You'll need to access your platform-specific context (Android) or null (iOS) to pass as an `Any?` argument
+ BasicAds.initialize(
+ platformContext
+ )
+ //...
+}
+```
+
+Now you can build ads:
+
+```kotlin
+// in your 'composeApp/src/commonMain/AdScreen.kt' file
+@Composable
+fun AdScreen() {
+ BannerAd() // Results in a Test Banner Ad being created
+ // You'll need to access your platform-specific Activity (Android) or null (iOS) to pass as an `Any?` argument
+ InterstitialAd(activity) // Results in a Test Interstitial Ad being created
+ RewardedInterstitialAd(activity) // Results in a Test Rewarded Interstitial Ad (Beta) being created
+ RewardedAd(activity) // Results in a Test Rewarded Ad being created
+}
+```
+
+If you want to customize your ad experience, you can take advantage of lambdas:
+```kotlin
+// in your 'composeApp/src/commonMain/AdScreen.kt' file
+@Composable
+fun AdScreen() {
+ // You'll need to access your platform-specific Activity (Android) or null (iOS) to pass as an `Any?` argument
+ RewardedAd(
+ activity = activity,
+ adUnitId = AdUnitId.autoSelect(
+ "YOUR_ANDROID_AD_UNIT_ID",
+ "YOUR_IOS_AD_UNIT_ID"
+ ),
+ onDismissed = {
+ doSomethingElse()
+ },
+ onRewardEarned = {
+ playSomeCoolSound()
+ }
+ )
+}
+```
+
+In case you need it, here's some [additional documentation](https://basic.lexilabs.app/basic-ads)
+
+### \[Advanced Users Only\] How to deal with building this garbage
+1. Find a large cup. It must exist in the real world.
+2. Fill said cup to the brim with some sort of caffeinated beverage.
+3. Click `File` > `Invalidate Caches...`, check all boxes and hit `invalidate and restart`
+4. Click `Sync` for gradle if banner exists. Ignore the flood of warning lights and klaxons.
+5. Click `Build` > `Clean Cache`. Ignore the plethora of errors
+6.Once complete, click `Build` > `Rebuild Project`. NOTE: Despite religious preference, prayer is encouraged.
diff --git a/basic-ads/build.gradle.kts b/basic-ads/build.gradle.kts
new file mode 100644
index 0000000..a324a58
--- /dev/null
+++ b/basic-ads/build.gradle.kts
@@ -0,0 +1,102 @@
+import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget
+
+plugins {
+ alias(libs.plugins.multiplatform)
+ alias(libs.plugins.android.library)
+ alias(libs.plugins.kotlinx.binary.compatibility.validator)
+ alias(libs.plugins.dokka)
+ alias(libs.plugins.native.cocoapods)
+ alias(libs.plugins.composeCompiler)
+ `maven-publish`
+ signing
+}
+
+kotlin {
+
+ // FORCES CHECK OF PUBLIC API DECLARATIONS
+ explicitApi()
+
+ listOf(
+ iosX64(), // mobile
+ iosArm64(), // mobile
+ iosSimulatorArm64(), // mobile
+ ).forEach {
+ it.binaries.framework {
+ baseName = "basic-ads"
+ isStatic = true
+ }
+ }
+
+ cocoapods {
+ ios.deploymentTarget = libs.versions.ios.deploymentTarget.get()
+ framework {
+ baseName = "GoogleMobileAds"
+ // Enable "isStatic", build, disable "isStatic", then build again.
+// isStatic = true
+ }
+ noPodspec()
+ pod("Google-Mobile-Ads-SDK") {
+ moduleName = "GoogleMobileAds"
+ version = libs.versions.adMob.cocoapods.get()
+ extraOpts += listOf("-compiler-option", "-fmodules")
+ }
+ }
+
+ sourceSets {
+ commonMain.dependencies {
+ implementation(libs.compose.foundation)
+ implementation(libs.annotations)
+ implementation(project(":basic-logging"))
+ }
+ androidMain.dependencies {
+ implementation(libs.compose.ui)
+ compileOnly(libs.google.play.services.ads)
+ }
+ iosMain.dependencies {}
+ }
+
+ //https://kotlinlang.org/docs/native-objc-interop.html#export-of-kdoc-comments-to-generated-objective-c-headers
+ targets.withTypeRequests and loads a fullscreen AdMob ad and notifies load completion via onLoaded lambda. Loaded ads are stored privately in each instantiation of AdLoader. As long as showInterstitialAd is called from the same AdLoader instance, the ad will display.
Requests and loads a fullscreen AdMob ad and notifies load completion via onLoaded lambda. Loaded ads are stored privately in each instantiation of AdLoader. As long as showRewardedAd is called from the same AdLoader instance, the ad will display.
Requests and loads a fullscreen AdMob ad and notifies load completion via onLoaded lambda. Loaded ads are stored privately in each instantiation of AdLoader. As long as showRewardedInterstitialAd is called from the same AdLoader instance, the ad will display.
Submits an AdRequest and returns the resulting AdRequest Loaded ads are stored privately in each instantiation of AdLoader. As long as showInterstitialAd is called from the same AdLoader instance, the ad will display.
Shows a fullscreen AdMob ad and notifies when the user closes the ad via onDismissed lambda. Loaded ads are stored privately in each instantiation of AdLoader. As long as loadInterstitialAd is called from the same AdLoader instance, the ad will display.
Shows a rewarded and fullscreen AdMob ad. It notifies when the user closes the ad via onDismissed lambda and when the user earned a reward within the ad using lambda onRewardEarned Loaded ads are stored privately in each instantiation of AdLoader. As long as loadRewardedAd is called from the same AdLoader instance, the ad will display.
Shows a rewarded and fullscreen AdMob ad. It notifies when the user closes the ad via onDismissed lambda and when the user earned a reward within the ad using lambda onRewardEarned Loaded ads are stored privately in each instantiation of AdLoader. As long as loadRewardedInterstitialAd is called from the same AdLoader instance, the ad will display.
Requests and loads a fullscreen AdMob ad and notifies load completion via onLoaded lambda. Loaded ads are stored privately in each instantiation of AdLoader. As long as showInterstitialAd is called from the same AdLoader instance, the ad will display.
rjamison@lexilabs.app
Android Activity or iOS null value stored in an Any variable
Lambda expression that executes when the AdRequest has fully loaded
Requests and loads a fullscreen AdMob ad and notifies load completion via onLoaded lambda. Loaded ads are stored privately in each instantiation of AdLoader. As long as showRewardedAd is called from the same AdLoader instance, the ad will display.
rjamison@lexilabs.app
Android Activity or iOS null value stored in an Any variable
Lambda expression that executes when the AdRequest has fully loaded
Requests and loads a fullscreen AdMob ad and notifies load completion via onLoaded lambda. Loaded ads are stored privately in each instantiation of AdLoader. As long as showRewardedInterstitialAd is called from the same AdLoader instance, the ad will display.
rjamison@lexilabs.app
Android Activity or iOS null value stored in an Any variable
Lambda expression that executes when the AdRequest has fully loaded
Shows a fullscreen AdMob ad and notifies when the user closes the ad via onDismissed lambda. Loaded ads are stored privately in each instantiation of AdLoader. As long as loadInterstitialAd is called from the same AdLoader instance, the ad will display.
rjamison@lexilabs.app
Android Activity or iOS null value stored in an Any variable
Lambda expression that executes when the user closes the ad
Shows a rewarded and fullscreen AdMob ad. It notifies when the user closes the ad via onDismissed lambda and when the user earned a reward within the ad using lambda onRewardEarned Loaded ads are stored privately in each instantiation of AdLoader. As long as loadRewardedAd is called from the same AdLoader instance, the ad will display.
rjamison@lexilabs.app
Android Activity or iOS null value stored in an Any variable
Lambda expression that executes when the user closes the ad
Lambda expression that executes when the user earns a reward from the ad
Shows a rewarded and fullscreen AdMob ad. It notifies when the user closes the ad via onDismissed lambda and when the user earned a reward within the ad using lambda onRewardEarned Loaded ads are stored privately in each instantiation of AdLoader. As long as loadRewardedInterstitialAd is called from the same AdLoader instance, the ad will display.
rjamison@lexilabs.app
Android Activity or iOS null value stored in an Any variable
Lambda expression that executes when the user closes the ad
Lambda expression that executes when the user earns a reward from the ad
Based on the AdMob implementation of AdSize, this module enables Android-like syntax to be used multiplatform.
The width of the ad in whatever unit of measurement Google came up with
The height of the ad in whatever unit of measurement Google came up with
Provides a way of selecting an AdMob AdUnitId by platform during runtime. This function works for any ad type.
An object used to hold functions related to AdMob AdUnitIds
I have no idea what this does, but its here and it works on Android and iOS
Android Context or null for iOS, passed in an Any variable
The domain name of which errors occur on
The main module for instantiating Android and iOS implementations of AdMob
The domain name of which errors occur on
I have no idea what this does, but its here and it works on Android and iOS
The main function for instantiating Android and iOS implementations of AdMob. It is equivalent to Android's MobileAds.Initialize(context).
This opens the Debug Menu, which I have never personally done myself.
Mutes or unmutes ads
The main function for instantiating Android and iOS implementations of AdMob. It is equivalent to Android's MobileAds.Initialize(context).
Android Context or null for iOS, passed in an Any variable
when run outside the MainThread
This opens the Debug Menu, which I have never personally done myself.
Android Context or null for iOS, passed in an Any variable
Mutes or unmutes ads
a Boolean value that should evaluate true when muted and false when unmuted
For Android, complete the steps in AdMob's instructions:
For iOS, complete the steps in AdMob's instructions:
NOTE: For Xcode 13+, you can update your Custom iOS Target Properties.
Once complete, you'll need to call BasicAds.initialize in your commonMain before calling for ads.
NOTE: You do not need to initialize within each platform.
This API is not considered 'production' until reaching version 1.0.0 or higher
Loads and displays an Interstitial Ad using a Composable.
Your AdMob AdUnitId String
Lambda that executes when the user closes the ad
Returns a representation of an immutable list of all enum entries, in the order they're declared.
This method may be used to iterate over the enum entries.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
The maximum content rating of the ads you wish to display
The privacy level of the ads
Should ads be appropriate for children
Should ads be limited to content for children under the age of consent
Sets the initial configuration of your AdMob instance for Android and iOS
The maximum content rating of the ads you wish to display
The privacy level of the ads
Should ads be appropriate for children
Should ads be limited to content for children under the age of consent
The maximum content rating of the ads you wish to display
The privacy level of the ads
Should ads be appropriate for children
Should ads be limited to content for children under the age of consent
Loads and displays a Rewarded Ad using a Composable.
Your AdMob AdUnitId String
Lambda that executes when the user closes the ad
Lambda that executes when the user has earned an ad-related reward
Loads and displays a Rewarded Interstitial Ad using a Composable.
Your AdMob AdUnitId String
Lambda that executes when the user closes the ad
Lambda that executes when the user has earned an ad-related reward
For Android, complete the steps in AdMob's instructions:
This API is not considered 'production' until reaching version 1.0.0 or higher
Sets the initial configuration of your AdMob instance for Android and iOS
Loads and displays an Interstitial Ad using a Composable.
Loads and displays a Rewarded Ad using a Composable.
Loads and displays a Rewarded Interstitial Ad using a Composable.