feat: add admob

Author: arch10

.idea/gradle.xml

@@ -109,6 +109,7 @@ dependencies {
     implementation 'com.google.firebase:firebase-crashlytics-ktx'
     implementation 'com.google.firebase:firebase-analytics-ktx'
     implementation 'com.google.firebase:firebase-perf-ktx'
+    implementation("com.google.firebase:firebase-config")
 
     // room
     def roomVersion = "2.6.1"
@@ -120,6 +121,10 @@ dependencies {
     implementation("com.google.android.play:core:1.10.3")
     implementation("com.google.android.play:core-ktx:1.8.1")
 
+    // google adMob
+    implementation 'com.google.android.gms:play-services-ads:22.6.0'
+    implementation("com.google.android.ump:user-messaging-platform:2.1.0")
+
     // test
     testImplementation 'junit:junit:4.13.2'
 

.idea/kotlinc.xml

@@ -17,6 +17,9 @@
         android:label="@string/app_name"
         android:supportsRtl="true"
         android:theme="@style/BaseTheme">
+        <meta-data
+            android:name="com.google.android.gms.ads.APPLICATION_ID"
+            android:value="ca-app-pub-2673776259760115~8162653366"/>
         <activity
             android:name=".ui.main.MainActivity"
             android:exported="true">

.idea/misc.xml

@@ -42,6 +42,8 @@ import com.gigaworks.tech.calculator.ui.main.helper.removeNumberSeparator
 import com.gigaworks.tech.calculator.ui.main.viewmodel.MainViewModel
 import com.gigaworks.tech.calculator.ui.settings.SettingsActivity
 import com.gigaworks.tech.calculator.ui.view.CalculatorEditText
+import com.gigaworks.tech.calculator.util.ADS_DISABLED
+import com.gigaworks.tech.calculator.util.ADS_ENABLED
 import com.gigaworks.tech.calculator.util.AccentTheme
 import com.gigaworks.tech.calculator.util.AngleType
 import com.gigaworks.tech.calculator.util.AppPreference
@@ -51,13 +53,25 @@ import com.gigaworks.tech.calculator.util.CLICK_ABOUT
 import com.gigaworks.tech.calculator.util.CLICK_CLEAR
 import com.gigaworks.tech.calculator.util.CLICK_HISTORY
 import com.gigaworks.tech.calculator.util.CLICK_MEMORY
+import com.gigaworks.tech.calculator.util.CLICK_PRIVACY_SETTINGS
 import com.gigaworks.tech.calculator.util.CLICK_SETTINGS
 import com.gigaworks.tech.calculator.util.CLICK_TUTORIAL
 import com.gigaworks.tech.calculator.util.EVALUATE
+import com.gigaworks.tech.calculator.util.GoogleMobileAdsConsentManager
 import com.gigaworks.tech.calculator.util.NumberSeparator
 import com.gigaworks.tech.calculator.util.SHARE_EXPRESSION
 import com.gigaworks.tech.calculator.util.getAccentTheme
+import com.gigaworks.tech.calculator.util.logD
+import com.gigaworks.tech.calculator.util.logE
+import com.gigaworks.tech.calculator.util.visible
+import com.google.android.gms.ads.AdRequest
+import com.google.android.gms.ads.MobileAds
+import com.google.firebase.Firebase
+import com.google.firebase.remoteconfig.FirebaseRemoteConfig
+import com.google.firebase.remoteconfig.get
+import com.google.firebase.remoteconfig.remoteConfig
 import dagger.hilt.android.AndroidEntryPoint
+import java.util.concurrent.atomic.AtomicBoolean
 import kotlin.math.sqrt
 
 
@@ -66,6 +80,8 @@ class MainActivity : BaseActivity<ActivityMainBinding>() {
 
     private val viewModel: MainViewModel by viewModels()
     private var mCurrentAnimator: Animator? = null
+    private val isMobileAdsInitializeCalled = AtomicBoolean(false)
+    private lateinit var googleMobileAdsConsentManager: GoogleMobileAdsConsentManager
 
     override fun onCreate(savedInstanceState: Bundle?) {
         val appPreference = AppPreference(this)
@@ -81,7 +97,74 @@ class MainActivity : BaseActivity<ActivityMainBinding>() {
         setAppTheme()
 
         // Add onBackPressedDispatcher callback
-        onBackPressedDispatcher.addCallback(this,onBackPressedCallback)
+        onBackPressedDispatcher.addCallback(this, onBackPressedCallback)
+
+        // setup remote config
+        setupRemoteConfig()
+
+        // enable Google ads
+        enableAds()
+
+    }
+
+    private fun initializeMobileAdsSdk() {
+        if (isMobileAdsInitializeCalled.getAndSet(true)) {
+            return
+        }
+        MobileAds.initialize(this) {}
+        logD("Consent granted: ${googleMobileAdsConsentManager.canRequestAds}")
+        val adRequest = AdRequest.Builder().build()
+        binding.adView.loadAd(adRequest)
+        logEvent(ADS_ENABLED)
+    }
+
+    private fun enableAds() {
+        googleMobileAdsConsentManager =
+            GoogleMobileAdsConsentManager.getInstance(applicationContext)
+        val remoteConfig = Firebase.remoteConfig
+        val shouldEnableAds = remoteConfig["enable_ads"].asBoolean()
+        logD("enable_ads=$shouldEnableAds")
+        if (!shouldEnableAds) {
+            logD("disabling ads due to remote config")
+            logEvent(ADS_DISABLED)
+            binding.adView.visible(false)
+            return
+        }
+
+        logD("Google Mobile Ads SDK Version: ${MobileAds.getVersion()}")
+        googleMobileAdsConsentManager.gatherConsent(this) { error ->
+            if (error != null) {
+                // Consent not obtained in current session.
+                logE("${error.errorCode}: ${error.message}")
+            }
+
+            if (googleMobileAdsConsentManager.canRequestAds) {
+                initializeMobileAdsSdk()
+            }
+
+            if (googleMobileAdsConsentManager.isPrivacyOptionsRequired) {
+                // Regenerate the options menu to include a privacy setting.
+                invalidateOptionsMenu()
+            }
+        }
+
+        if (googleMobileAdsConsentManager.canRequestAds) {
+            initializeMobileAdsSdk()
+        }
+
+    }
+
+    private fun setupRemoteConfig() {
+        val remoteConfig: FirebaseRemoteConfig = Firebase.remoteConfig
+        remoteConfig.setDefaultsAsync(R.xml.remote_config_defaults)
+        remoteConfig.activate()
+        remoteConfig.fetchAndActivate().addOnCompleteListener(this) {
+            if (it.isSuccessful) {
+                logD("Remote config fetch success")
+            } else {
+                logD("Remote config fetch failed")
+            }
+        }
     }
 
     private val buttonClick = View.OnClickListener {
@@ -329,6 +412,8 @@ class MainActivity : BaseActivity<ActivityMainBinding>() {
 
     override fun onCreateOptionsMenu(menu: Menu): Boolean {
         menuInflater.inflate(R.menu.main_menu, menu)
+        val privacySettings = menu.findItem(R.id.privacy_settings)
+        privacySettings?.isVisible = googleMobileAdsConsentManager.isPrivacyOptionsRequired
         return super.onCreateOptionsMenu(menu)
     }
 
@@ -359,14 +444,17 @@ class MainActivity : BaseActivity<ActivityMainBinding>() {
                 logEvent(CLICK_SETTINGS)
                 startActivity(Intent(this, SettingsActivity::class.java))
             }
+
             R.id.history -> {
                 logEvent(CLICK_HISTORY)
                 startActivity(Intent(this, HistoryActivity::class.java))
             }
+
             R.id.about -> {
                 logEvent(CLICK_ABOUT)
                 startActivity(Intent(this, AboutActivity::class.java))
             }
+
             R.id.share -> {
                 val sharedEquation = getShareEquation()
                 if (sharedEquation.isNotEmpty()) {
@@ -385,10 +473,21 @@ class MainActivity : BaseActivity<ActivityMainBinding>() {
                     Toast.makeText(this, getString(R.string.share_error), Toast.LENGTH_SHORT).show()
                 }
             }
+
             R.id.tutorial -> {
                 logEvent(CLICK_TUTORIAL)
                 showTutorial()
             }
+
+            R.id.privacy_settings -> {
+                logEvent(CLICK_PRIVACY_SETTINGS)
+                googleMobileAdsConsentManager.showPrivacyOptionsForm(this) { formError ->
+                    if (formError != null) {
+                        logE("${formError.errorCode}: ${formError.message}")
+                        Toast.makeText(this, formError.message, Toast.LENGTH_SHORT).show()
+                    }
+                }
+            }
         }
         return super.onOptionsItemSelected(item)
     }

app/build.gradle

@@ -7,8 +7,19 @@ import androidx.lifecycle.viewModelScope
 import com.gigaworks.tech.calculator.R
 import com.gigaworks.tech.calculator.domain.History
 import com.gigaworks.tech.calculator.repository.HistoryRepository
-import com.gigaworks.tech.calculator.ui.main.helper.*
-import com.gigaworks.tech.calculator.util.*
+import com.gigaworks.tech.calculator.ui.main.helper.addNumberSeparator
+import com.gigaworks.tech.calculator.ui.main.helper.getResult
+import com.gigaworks.tech.calculator.ui.main.helper.isExpressionBalanced
+import com.gigaworks.tech.calculator.ui.main.helper.isNumber
+import com.gigaworks.tech.calculator.ui.main.helper.prepareExpression
+import com.gigaworks.tech.calculator.ui.main.helper.roundMyAnswer
+import com.gigaworks.tech.calculator.ui.main.helper.tryBalancingBrackets
+import com.gigaworks.tech.calculator.util.AngleType
+import com.gigaworks.tech.calculator.util.AppPreference
+import com.gigaworks.tech.calculator.util.AppTheme
+import com.gigaworks.tech.calculator.util.CalculationException
+import com.gigaworks.tech.calculator.util.CalculationMessage
+import com.gigaworks.tech.calculator.util.NumberSeparator
 import dagger.hilt.android.lifecycle.HiltViewModel
 import kotlinx.coroutines.launch
 import javax.inject.Inject
@@ -138,7 +149,7 @@ class MainViewModel @Inject constructor(
             AppPreference.NUMBER_SEPARATOR,
             NumberSeparator.INTERNATIONAL.name
         )
-        return NumberSeparator.values().find { it.name == numberSeparator }
+        return NumberSeparator.entries.find { it.name == numberSeparator }
             ?: NumberSeparator.INTERNATIONAL
     }
 

app/src/main/AndroidManifest.xml

@@ -24,6 +24,9 @@ const val CLICK_HISTORY = "click_history"
 //click tutorial
 const val CLICK_TUTORIAL = "click_tutorial"
 
+//click privacy settings
+const val CLICK_PRIVACY_SETTINGS = "click_privacy_settings"
+
 //click about
 const val CLICK_ABOUT = "click_about"
 
@@ -64,4 +67,10 @@ const val FOLLOW_ME = "follow_me"
 const val JOIN_BETA = "join_beta"
 
 //trigger feedback
-const val TRIGGER_STORE_FEEDBACK = "trigger_store_feedback"
+const val TRIGGER_STORE_FEEDBACK = "trigger_store_feedback"
+
+//disable ads
+const val ADS_DISABLED = "ads_disabled"
+
+//enable ads
+const val ADS_ENABLED = "ads_enabled"

app/src/main/java/com/gigaworks/tech/calculator/ui/main/MainActivity.kt

@@ -37,6 +37,10 @@ fun Activity.logD(msg: String?) {
     printLogD(this.getClassName(), msg)
 }
 
+fun Activity.logW(msg: String?) {
+    printLogW(this.getClassName(), msg)
+}
+
 fun Activity.logE(msg: String?) {
     printLogE(this.getClassName(), msg)
 }