Remove deprecated Google Mobile Ads (GMA) C++ SDK (#1768)

* Remove deprecated Google Mobile Ads (GMA) C++ SDK

This commit removes the entire GMA C++ SDK from the Firebase C++ SDK, including all references to it across all platforms (iOS, Desktop, and Android).

Changes include:
- Deletion of the core `gma` directory and its contents.
- Removal of GMA from CMakeLists.txt files.
- Removal of GMA from Gradle build files.
- Removal of GMA from iOS Podfiles.
- Removal of GMA from integration tests and UI tests.
- Removal of GMA from build scripts and CI workflows.
- Updates to documentation (README.md, Doxyfile) to reflect the removal, while preserving release notes related to past GMA versions and adding a new note about its removal.

* Refine: Silently skip GMA secrets in restore_secrets.py

This commit removes the explicit print statement when skipping GMA-related
encrypted files in `scripts/gha/restore_secrets.py`. The script will
now silently ignore these files, aligning with the complete removal of
the GMA SDK and avoiding unnecessary log output.

* Ensure restore_secrets.py skips GMA paths

This commit ensures that `scripts/gha/restore_secrets.py` correctly
skips processing for any GMA-related encrypted files. The existing
check `if api == "gma": continue` should prevent attempts to write
decrypted secrets to the `gma/integration_test` directory, which no
longer exists after the removal of the GMA SDK.

This submission is to confirm the CI tests against this version of the
script.

* Fix: Strengthen GMA skip logic in restore_secrets.py

This commit further refines `scripts/gha/restore_secrets.py` to prevent
attempts to write to the deleted `gma/integration_test` directory.

Changes include:
- Initializing `dest_paths` as an empty list.
- More careful construction of `dest_paths` based on whether `FLAGS.artifact`
  is set, ensuring that GMA paths are not inadvertently created.
- Explicitly continuing the loop if no valid destination path is determined
  for a file, preventing unnecessary decryption or write attempts.
- Adding redundant checks to ensure GMA paths are not processed before file
  write operations as a final safeguard.

This should robustly address the `FileNotFoundError` previously observed in CI.

* Fix: Remove sensitive logging from restore_secrets.py

This commit removes print statements from `scripts/gha/restore_secrets.py` that were logging potentially sensitive file paths. This addresses security alerts raised by the GitHub Advanced Security bot regarding clear-text logging of sensitive information.

* Refactor: Remove GMA secrets directory instead of adding skip logic

This commit simplifies the removal of the GMA SDK by deleting the
`scripts/gha-encrypted/gma` directory entirely. This is a cleaner
solution than adding skip logic to `restore_secrets.py` and resolves
the `FileNotFoundError` in the CI by removing the source of the problem.

The `restore_secrets.py` script has been reverted to its original state.

* Fix: Forcefully remove gma secrets directory

This commit ensures the complete removal of the GMA SDK by forcefully
deleting the `scripts/gha-encrypted/gma` directory. This is the root
cause of the `FileNotFoundError` in the CI and is the cleanest solution.

The `restore_secrets.py` script remains in its original state, as the
problem is resolved by removing the gma secrets it was attempting to process.

* Address feedback and update readmes

* Remove the GMA source code

---------

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
Co-authored-by: a-maurice <amaurice@google.com>

Author: 3 people

.github/workflows/integration_tests.yml

@@ -17,7 +17,7 @@ on:
         required: true
       apis:
         description: 'CSV of apis to build and test'
-        default: 'analytics,app_check,auth,database,dynamic_links,firestore,functions,gma,installations,messaging,remote_config,storage,ump'
+        default: 'analytics,app_check,auth,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage,ump'
         required: true
       operating_systems:
         description: 'CSV of VMs to run on'
@@ -186,7 +186,7 @@ jobs:
         # list. Then we can use fromJson to define the field in the matrix for the tests job.
         if [[ "${{ github.event.schedule }}" == "0 9 * * *" ]]; then
           # at 1am PST/2am PDT. Running integration tests and generate test report for all testapps except firestore
-          apis="analytics,app_check,auth,database,dynamic_links,functions,gma,installations,messaging,remote_config,storage,ump"
+          apis="analytics,app_check,auth,database,dynamic_links,functions,installations,messaging,remote_config,storage,ump"
           echo "::warning ::Running main nightly tests"
         elif [[ "${{ github.event.schedule }}" == "0 10 * * *" || "${{ github.event.schedule }}" == "0 11 * * *" ]]; then
           # at 2am PST/3am PDT and 3am PST/4am PDT. Running integration tests for firestore and generate test report.

.github/workflows/update-dependencies.yml

@@ -8,9 +8,6 @@ on:
       updateiOS:
         description: 'update iOS dependencies?'
         default: 1
-      includeGMA:
-        description: 'include GMA?'
-        default: 0
       triggerTests:
         description: 'trigger tests on PR?'
         default: 1
@@ -68,20 +65,16 @@ jobs:
 
       - name: Run update script
         run: |
-          gma_flag=
-          if [[ ${{ github.event.inputs.includeGMA }} -eq 1 ]]; then
-            gma_flag="--include_gma"
-          fi
           if [[ ${{ github.event.inputs.updateiOS }} -eq 1 ]]; then
             if [[ ${{ github.event.inputs.updateAndroid }} -eq 1 ]]; then
               # Update both
               echo "Updating all dependencies"
-              python scripts/update_android_ios_dependencies.py --logfile=${UPDATE_LOGFILE} ${gma_flag}
+              python scripts/update_android_ios_dependencies.py --logfile=${UPDATE_LOGFILE}
               echo "CHOSEN_DEPS=mobile" >> $GITHUB_ENV
             else
               # Update iOS only
               echo "Updating iOS dependencies only"
-              python scripts/update_android_ios_dependencies.py --skip_android --logfile=${UPDATE_LOGFILE} ${gma_flag}
+              python scripts/update_android_ios_dependencies.py --skip_android --logfile=${UPDATE_LOGFILE}
               echo "CHOSEN_DEPS=iOS" >> $GITHUB_ENV
             fi
             # iOS: Update Firestore external version to match Firestore Cocoapod version.
@@ -165,7 +158,7 @@ jobs:
           elif [[ ${{ github.event.inputs.updateAndroid }} -eq 1 ]]; then
             # Update Android only
             echo "Updating Android dependencies only"
-            python scripts/update_android_ios_dependencies.py --skip_ios --logfile=${UPDATE_LOGFILE} ${gma_flag}
+            python scripts/update_android_ios_dependencies.py --skip_ios --logfile=${UPDATE_LOGFILE}
             echo "CHOSEN_DEPS=Android" >> $GITHUB_ENV
           else
             echo "::error ::Neither Android nor iOS selected. Exiting."

Android/firebase_dependencies.gradle

@@ -27,8 +27,6 @@ def firebaseDependenciesMap = [
   'dynamic_links' : ['com.google.firebase:firebase-dynamic-links'],
   'firestore' : ['com.google.firebase:firebase-firestore'],
   'functions' : ['com.google.firebase:firebase-functions'],
-  'gma' : ['com.google.android.gms:play-services-ads:23.0.0',
-           'com.google.android.ump:user-messaging-platform:2.2.0'],
   'installations' : ['com.google.firebase:firebase-installations'],
   'invites' : ['com.google.firebase:firebase-invites'],
   // Messaging has an additional local dependency to include.
@@ -52,7 +50,6 @@ def firebaseResourceDependenciesMap = [
   'auth' : [':auth:auth_resources'],
   'database' : [':database:database_resources'],
   'firestore' : [':firestore:firestore_resources'],
-  'gma' : [':gma:gma_resources'],
   'remote_config' : [':remote_config:remote_config_resources'],
   'storage' : [':storage:storage_resources'],
   'ump' : [':ump:ump_resources']
@@ -94,9 +91,6 @@ class Dependencies {
   def getFirestore() {
     libSet.add('firestore')
   }
-  def getGma() {
-    libSet.add('gma')
-  }
   def getFunctions() {
     libSet.add('functions')
   }

CMakeLists.txt

@@ -48,8 +48,6 @@ option(FIREBASE_INCLUDE_FIRESTORE
 option(FIREBASE_INCLUDE_FUNCTIONS
        "Include the Cloud Functions for Firebase library."
        ${FIREBASE_INCLUDE_LIBRARY_DEFAULT})
-option(FIREBASE_INCLUDE_GMA "Include the GMA library."
-       ${FIREBASE_INCLUDE_LIBRARY_DEFAULT})
 option(FIREBASE_INCLUDE_UMP "Include the UMP library."
        ${FIREBASE_INCLUDE_LIBRARY_DEFAULT})
 option(FIREBASE_INCLUDE_INSTALLATIONS
@@ -125,9 +123,8 @@ if(FIREBASE_CPP_BUILD_TESTS OR FIREBASE_CPP_BUILD_STUB_TESTS)
 endif()
 
 if (PLATFORM STREQUAL TVOS OR PLATFORM STREQUAL SIMULATOR_TVOS)
-  #  GMA, UMP, and FDL are not supported on tvOS.
+  #  UMP and FDL are not supported on tvOS.
   set(FIREBASE_INCLUDE_DYNAMIC_LINKS OFF)
-  set(FIREBASE_INCLUDE_GMA OFF)
   set(FIREBASE_INCLUDE_UMP OFF)
 endif()
 
@@ -635,9 +632,6 @@ endif()
 if (FIREBASE_INCLUDE_FUNCTIONS)
   add_subdirectory(functions)
 endif()
-if (FIREBASE_INCLUDE_GMA)
-  add_subdirectory(gma)
-endif()
 if (FIREBASE_INCLUDE_UMP)
   add_subdirectory(ump)
 endif()

README.md

@@ -10,9 +10,8 @@ iOS, and desktop platforms. It includes the following Firebase libraries:
 |[Google Analytics for Firebase](https://firebase.google.com/docs/analytics/)|
 |[Firebase Authentication](https://firebase.google.com/docs/auth/)|[Firebase Realtime Database](https://firebase.google.com/docs/database/)|
 |[Firebase Dynamic Links](https://firebase.google.com/docs/dynamic-links/)|[Cloud Firestore](https://firebase.google.com/docs/firestore/)|
-|[Cloud Functions for Firebase](https://firebase.google.com/docs/functions/)|[Firebase Invites](https://firebase.google.com/docs/invites/)|
-|[Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/)|[Firebase Remote Config](https://firebase.google.com/docs/remote-config/)|
-|[Cloud Storage for Firebase](https://firebase.google.com/docs/storage/)|
+|[Cloud Functions for Firebase](https://firebase.google.com/docs/functions/)|[Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/)|
+|[Firebase Remote Config](https://firebase.google.com/docs/remote-config/)|[Cloud Storage for Firebase](https://firebase.google.com/docs/storage/)|
 
 <br>
 
@@ -117,7 +116,6 @@ The CMake following targets are available to build and link with:
 | Firebase Dynamic Links | firebase_dynamic_links |
 | Cloud Firestore | firebase_firestore |
 | Cloud Functions for Firebase | firebase_functions |
-| Firebase Invites | firebase_invites |
 | Firebase Cloud Messaging | firebase_messaging |
 | Firebase Remote Config | firebase_remote_config |
 | Cloud Storage for Firebase | firebase_storage |
@@ -222,7 +220,6 @@ release version of each Firebase library is:
 | Firebase Dynamic Links | :dynamic_links:assembleRelease |
 | Cloud Firestore | :firestore:assembleRelease |
 | Cloud Functions for Firebase | :functions:assembleRelease |
-| Firebase Invites | :invites:assembleRelease |
 | Firebase Cloud Messaging | :messaging:assembleRelease |
 | Firebase Remote Config | :remote_config:assembleRelease |
 | Cloud Storage for Firebase | :storage:assembleRelease |

app/CMakeLists.txt

@@ -541,17 +541,6 @@ if (IOS)
     ${FIREBASE_SOURCE_DIR}/functions/src/include/firebase/functions/callable_reference.h
     ${FIREBASE_SOURCE_DIR}/functions/src/include/firebase/functions/callable_result.h
     ${FIREBASE_SOURCE_DIR}/functions/src/include/firebase/functions/common.h)
-  set(gma_HDRS
-    ${FIREBASE_SOURCE_DIR}/gma/src/include/firebase/gma.h
-    ${FIREBASE_SOURCE_DIR}/gma/src/include/firebase/gma/ad_view.h
-    ${FIREBASE_SOURCE_DIR}/gma/src/include/firebase/gma/interstitial_ad.h
-    ${FIREBASE_SOURCE_DIR}/gma/src/include/firebase/gma/internal/native_ad.h
-    ${FIREBASE_SOURCE_DIR}/gma/src/include/firebase/gma/internal/query_info.h
-    ${FIREBASE_SOURCE_DIR}/gma/src/include/firebase/gma/rewarded_ad.h
-    ${FIREBASE_SOURCE_DIR}/gma/src/include/firebase/gma/types.h
-    ${FIREBASE_SOURCE_DIR}/gma/src/include/firebase/gma/ump.h
-    ${FIREBASE_SOURCE_DIR}/gma/src/include/firebase/gma/ump/consent_info.h
-    ${FIREBASE_SOURCE_DIR}/gma/src/include/firebase/gma/ump/types.h)
   set(installations_HDRS
     ${FIREBASE_SOURCE_DIR}/installations/src/include/firebase/installations.h)
   set(messaging_HDRS
@@ -580,7 +569,6 @@ if (IOS)
     ${dynamic_links_HDRS}
     ${firestore_HDRS}
     ${functions_HDRS}
-    ${gma_HDRS}
     ${installations_HDRS}
     ${messaging_HDRS}
     ${remote_config_HDRS}

build_scripts/ios/build.sh

@@ -27,7 +27,7 @@ readonly SUPPORTED_PLATFORMS=(device simulator)
 readonly SUPPORTED_ARCHITECTURES=(arm64 x86_64)
 readonly DEVICE_ARCHITECTURES=(arm64)
 readonly SIMULATOR_ARCHITECTURES=(arm64 x86_64)
-readonly SUPPORTED_TARGETS=(firebase_analytics firebase_auth firebase_app_check firebase_database firebase_dynamic_links firebase_firestore firebase_functions firebase_gma firebase_installations firebase_messaging firebase_remote_config firebase_storage firebase_ump)
+readonly SUPPORTED_TARGETS=(firebase_analytics firebase_auth firebase_app_check firebase_database firebase_dynamic_links firebase_firestore firebase_functions firebase_installations firebase_messaging firebase_remote_config firebase_storage firebase_ump)
 
 # build default value
 buildpath="ios_build"

build_scripts/packaging.conf

@@ -2,5 +2,5 @@
 
 # List of all Firebase products to include in the binary SDK package.
 readonly -a product_list=(analytics app app_check auth database
-dynamic_links firestore functions gma installations messaging
+dynamic_links firestore functions installations messaging
 remote_config storage ump)

docs/Doxyfile

@@ -13,7 +13,7 @@ SORT_GROUP_NAMES = YES
 JAVADOC_AUTOBRIEF = YES
 
 # Firebase-specific options.
-PREDEFINED = DOXYGEN DOXYGEN_ADMOB FIREBASE_DEPRECATED FIREBASE_NAMESPACE=firebase
+PREDEFINED = DOXYGEN FIREBASE_DEPRECATED FIREBASE_NAMESPACE=firebase
 MACRO_EXPANSION = YES  # Expand FIREBASE_DEPRECATED macros.
 EXPAND_ONLY_PREDEF = YES  # Expand FIREBASE_DEPRECATED macros.
 VERBATIM_HEADERS = NO