From dd6849e8d7c6493cb7f956d3946f31f92c9adafb Mon Sep 17 00:00:00 2001 From: Jon Simantov Date: Tue, 25 Jun 2024 11:37:56 -0700 Subject: [PATCH 1/2] Update deprecation link in headers. --- gma/src/include/firebase/gma.h | 34 ++++++++++++++++--- gma/src/include/firebase/gma/ad_view.h | 3 +- .../include/firebase/gma/interstitial_ad.h | 3 +- gma/src/include/firebase/gma/rewarded_ad.h | 3 +- 4 files changed, 35 insertions(+), 8 deletions(-) diff --git a/gma/src/include/firebase/gma.h b/gma/src/include/firebase/gma.h index 002bbf8125..76573814f6 100644 --- a/gma/src/include/firebase/gma.h +++ b/gma/src/include/firebase/gma.h @@ -62,8 +62,29 @@ class Future { /// The GMA API allows you to load and display mobile ads using the Google /// Mobile Ads SDK. Each ad format has its own header file. /// -/// @deprecated The Google Mobile Ads C++ SDK is now deprecated. Please see -/// https://developers.google.com/admob/cpp/sdk for more information. +/// @deprecated The Google Mobile Ads (GMA) C++ SDK has been deprecated as of +/// June 17, 2024. +/// +/// Over the subequent 12 months, we’ll provide support for critical bugs only, +/// until the GMA C++ SDK reaches the End-of-Maintenance (EoM) phase on June 17, +/// 2025. +/// +/// To ensure continuity and seamless functionality, we suggest updating your +/// mobile applications to use the GMA's iOS and Android SDKs. +/// +/// Please follow the steps in [Get started with AdMob in your iOS +/// project](https://firebase.google.com/docs/admob/ios/quick-start) and [Get +/// started with AdMob in your Android +/// project](https://firebase.google.com/docs/admob/android/quick-start) to +/// incorporate the GMA's iOS and Android SDKs into your mobile +/// applications. This approach will help mitigate any disruptions caused by the +/// discontinuation of the C++ SDK. +/// +/// We know this change may take some planning, and we're here to support you +/// during this transition. If you have any questions or require assistance, +/// please contact [Google Mobile Ads SDK Technical +/// Forum](https://groups.google.com/g/google-admob-ads-sdk) or [Firebase +/// Support](https://firebase.google.com/support). namespace gma { /// Initializes Google Mobile Ads (GMA) via Firebase. @@ -83,7 +104,8 @@ namespace gma { /// Otherwise, the returned Future will have kFutureStatusInvalid. /// /// @deprecated The Google Mobile Ads C++ SDK is now deprecated. Please see -/// https://developers.google.com/admob/cpp/sdk for more information. +/// https://developers.google.com/admob/cpp/reference/namespace/firebase/gma +/// for more information. FIREBASE_DEPRECATED Future Initialize( const ::firebase::App& app, InitResult* init_result_out = nullptr); @@ -115,7 +137,8 @@ FIREBASE_DEPRECATED Future Initialize( /// Otherwise, the returned Future will have kFutureStatusInvalid. /// /// @deprecated The Google Mobile Ads C++ SDK is now deprecated. Please see -/// https://developers.google.com/admob/cpp/sdk for more information. +/// https://developers.google.com/admob/cpp/reference/namespace/firebase/gma +/// for more information. FIREBASE_DEPRECATED Future Initialize( JNIEnv* jni_env, jobject activity, InitResult* init_result_out = nullptr); @@ -137,7 +160,8 @@ FIREBASE_DEPRECATED Future Initialize( /// kFutureStatusInvalid. /// /// @deprecated The Google Mobile Ads C++ SDK is now deprecated. Please see -/// https://developers.google.com/admob/cpp/sdk for more information. +/// https://developers.google.com/admob/cpp/reference/namespace/firebase/gma +/// for more information. FIREBASE_DEPRECATED Future Initialize( InitResult* init_result_out = nullptr); #endif // !defined(__ANDROID__) || defined(DOXYGEN) diff --git a/gma/src/include/firebase/gma/ad_view.h b/gma/src/include/firebase/gma/ad_view.h index a935e38ba1..d2d73db67d 100644 --- a/gma/src/include/firebase/gma/ad_view.h +++ b/gma/src/include/firebase/gma/ad_view.h @@ -65,7 +65,8 @@ struct BoundingBox; /// @endcode /// /// @deprecated The Google Mobile Ads C++ SDK is now deprecated. Please see -/// https://developers.google.com/admob/cpp/sdk for more information. +/// https://developers.google.com/admob/cpp/reference/namespace/firebase/gma +/// for more information. class AdView { public: /// The possible screen positions for a @ref AdView, configured via diff --git a/gma/src/include/firebase/gma/interstitial_ad.h b/gma/src/include/firebase/gma/interstitial_ad.h index 8db7acfd28..4173209f42 100644 --- a/gma/src/include/firebase/gma/interstitial_ad.h +++ b/gma/src/include/firebase/gma/interstitial_ad.h @@ -71,7 +71,8 @@ class InterstitialAdInternal; /// @endcode /// /// @deprecated The Google Mobile Ads C++ SDK is now deprecated. Please see -/// https://developers.google.com/admob/cpp/sdk for more information. +/// https://developers.google.com/admob/cpp/reference/namespace/firebase/gma +/// for more information. class InterstitialAd { public: /// Creates an uninitialized @ref InterstitialAd object. diff --git a/gma/src/include/firebase/gma/rewarded_ad.h b/gma/src/include/firebase/gma/rewarded_ad.h index e2bf38a3e3..6aaafbb798 100644 --- a/gma/src/include/firebase/gma/rewarded_ad.h +++ b/gma/src/include/firebase/gma/rewarded_ad.h @@ -73,7 +73,8 @@ class RewardedAdInternal; /// @endcode /// /// @deprecated The Google Mobile Ads C++ SDK is now deprecated. Please see -/// https://developers.google.com/admob/cpp/sdk for more information. +/// https://developers.google.com/admob/cpp/reference/namespace/firebase/gma +/// for more information. class RewardedAd { public: /// Options for RewardedAd server-side verification callbacks. Set options on From be2b7a8f0b868df8caff7dd13e8c955d190c9041 Mon Sep 17 00:00:00 2001 From: Jon Simantov Date: Tue, 25 Jun 2024 12:54:13 -0700 Subject: [PATCH 2/2] Update the text. --- gma/src/include/firebase/gma.h | 46 ++++++++++++++++------------------ 1 file changed, 22 insertions(+), 24 deletions(-) diff --git a/gma/src/include/firebase/gma.h b/gma/src/include/firebase/gma.h index 76573814f6..0d95f536f5 100644 --- a/gma/src/include/firebase/gma.h +++ b/gma/src/include/firebase/gma.h @@ -55,6 +55,14 @@ template class Future { // Empty class (used for documentation only). }; + +/// @brief Firebase App class. For more information, see the Firebase +/// C++ SDK documentation. +class App { + // Empty class (used for documentation only). +}; + #endif // defined(DOXYGEN_ADMOB) /// @brief API for Google Mobile Ads with Firebase. @@ -62,29 +70,17 @@ class Future { /// The GMA API allows you to load and display mobile ads using the Google /// Mobile Ads SDK. Each ad format has its own header file. /// -/// @deprecated The Google Mobile Ads (GMA) C++ SDK has been deprecated as of -/// June 17, 2024. -/// -/// Over the subequent 12 months, we’ll provide support for critical bugs only, -/// until the GMA C++ SDK reaches the End-of-Maintenance (EoM) phase on June 17, -/// 2025. -/// -/// To ensure continuity and seamless functionality, we suggest updating your -/// mobile applications to use the GMA's iOS and Android SDKs. -/// -/// Please follow the steps in [Get started with AdMob in your iOS -/// project](https://firebase.google.com/docs/admob/ios/quick-start) and [Get -/// started with AdMob in your Android -/// project](https://firebase.google.com/docs/admob/android/quick-start) to -/// incorporate the GMA's iOS and Android SDKs into your mobile -/// applications. This approach will help mitigate any disruptions caused by the -/// discontinuation of the C++ SDK. -/// -/// We know this change may take some planning, and we're here to support you -/// during this transition. If you have any questions or require assistance, -/// please contact [Google Mobile Ads SDK Technical -/// Forum](https://groups.google.com/g/google-admob-ads-sdk) or [Firebase -/// Support](https://firebase.google.com/support). +/// @deprecated **The Google Mobile Ads (GMA) C++ SDK is _deprecated_ as of June +/// 17, 2024 and should not be adopted in projects that don't already use it. It +/// will enter _End-of-Maintenance (EoM)_ on June 17, 2025. Note that versions +/// of the SDK released before the EoM date will continue to function, but no +/// further bug fixes or changes will be released after the EoM date.** +/// +/// Instead of the Google Mobile Ads C++ SDK, consider using the +/// [iOS](/docs/admob/ios/quick-start) and +/// [Android](/docs/admob/android/quick-start) SDKs from AdMob. For support, +/// reach out to the [Google Mobile Ads SDK Technical +/// Forum](https://groups.google.com/g/google-admob-ads-sdk). namespace gma { /// Initializes Google Mobile Ads (GMA) via Firebase. @@ -104,7 +100,9 @@ namespace gma { /// Otherwise, the returned Future will have kFutureStatusInvalid. /// /// @deprecated The Google Mobile Ads C++ SDK is now deprecated. Please see -/// https://developers.google.com/admob/cpp/reference/namespace/firebase/gma +/// the [SDK reference +/// documentation]( +/// /admob/cpp/reference/namespace/firebase/gma) /// for more information. FIREBASE_DEPRECATED Future Initialize( const ::firebase::App& app, InitResult* init_result_out = nullptr);