Skip to content

Commit d170cb6

Browse files
authored
Modify deprecation notice. (#1616)
* Update deprecation link in headers. * Update the text.
1 parent 5a814f8 commit d170cb6

File tree

4 files changed

+33
-8
lines changed

4 files changed

+33
-8
lines changed

gma/src/include/firebase/gma.h

+27-5
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,32 @@ template <typename ResultType>
5555
class Future {
5656
// Empty class (used for documentation only).
5757
};
58+
59+
/// @brief Firebase App class. For more information, see the <a
60+
/// href="https://firebase.google.com/docs/reference/cpp/class/firebase/app">Firebase
61+
/// C++ SDK documentation</a>.
62+
class App {
63+
// Empty class (used for documentation only).
64+
};
65+
5866
#endif // defined(DOXYGEN_ADMOB)
5967

6068
/// @brief API for Google Mobile Ads with Firebase.
6169
///
6270
/// The GMA API allows you to load and display mobile ads using the Google
6371
/// Mobile Ads SDK. Each ad format has its own header file.
6472
///
65-
/// @deprecated The Google Mobile Ads C++ SDK is now deprecated. Please see
66-
/// https://developers.google.com/admob/cpp/sdk for more information.
73+
/// @deprecated **The Google Mobile Ads (GMA) C++ SDK is _deprecated_ as of June
74+
/// 17, 2024 and should not be adopted in projects that don't already use it. It
75+
/// will enter _End-of-Maintenance (EoM)_ on June 17, 2025. Note that versions
76+
/// of the SDK released before the EoM date will continue to function, but no
77+
/// further bug fixes or changes will be released after the EoM date.**
78+
///
79+
/// Instead of the Google Mobile Ads C++ SDK, consider using the
80+
/// [iOS](/docs/admob/ios/quick-start) and
81+
/// [Android](/docs/admob/android/quick-start) SDKs from AdMob. For support,
82+
/// reach out to the [Google Mobile Ads SDK Technical
83+
/// Forum](https://groups.google.com/g/google-admob-ads-sdk).
6784
namespace gma {
6885

6986
/// Initializes Google Mobile Ads (GMA) via Firebase.
@@ -83,7 +100,10 @@ namespace gma {
83100
/// Otherwise, the returned Future will have kFutureStatusInvalid.
84101
///
85102
/// @deprecated The Google Mobile Ads C++ SDK is now deprecated. Please see
86-
/// https://developers.google.com/admob/cpp/sdk for more information.
103+
/// the [SDK reference
104+
/// documentation](
105+
/// /admob/cpp/reference/namespace/firebase/gma)
106+
/// for more information.
87107
FIREBASE_DEPRECATED Future<AdapterInitializationStatus> Initialize(
88108
const ::firebase::App& app, InitResult* init_result_out = nullptr);
89109

@@ -115,7 +135,8 @@ FIREBASE_DEPRECATED Future<AdapterInitializationStatus> Initialize(
115135
/// Otherwise, the returned Future will have kFutureStatusInvalid.
116136
///
117137
/// @deprecated The Google Mobile Ads C++ SDK is now deprecated. Please see
118-
/// https://developers.google.com/admob/cpp/sdk for more information.
138+
/// https://developers.google.com/admob/cpp/reference/namespace/firebase/gma
139+
/// for more information.
119140
FIREBASE_DEPRECATED Future<AdapterInitializationStatus> Initialize(
120141
JNIEnv* jni_env, jobject activity, InitResult* init_result_out = nullptr);
121142

@@ -137,7 +158,8 @@ FIREBASE_DEPRECATED Future<AdapterInitializationStatus> Initialize(
137158
/// <code>kFutureStatusInvalid</code>.
138159
///
139160
/// @deprecated The Google Mobile Ads C++ SDK is now deprecated. Please see
140-
/// https://developers.google.com/admob/cpp/sdk for more information.
161+
/// https://developers.google.com/admob/cpp/reference/namespace/firebase/gma
162+
/// for more information.
141163
FIREBASE_DEPRECATED Future<AdapterInitializationStatus> Initialize(
142164
InitResult* init_result_out = nullptr);
143165
#endif // !defined(__ANDROID__) || defined(DOXYGEN)

gma/src/include/firebase/gma/ad_view.h

+2-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,8 @@ struct BoundingBox;
6565
/// @endcode
6666
///
6767
/// @deprecated The Google Mobile Ads C++ SDK is now deprecated. Please see
68-
/// https://developers.google.com/admob/cpp/sdk for more information.
68+
/// https://developers.google.com/admob/cpp/reference/namespace/firebase/gma
69+
/// for more information.
6970
class AdView {
7071
public:
7172
/// The possible screen positions for a @ref AdView, configured via

gma/src/include/firebase/gma/interstitial_ad.h

+2-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,8 @@ class InterstitialAdInternal;
7171
/// @endcode
7272
///
7373
/// @deprecated The Google Mobile Ads C++ SDK is now deprecated. Please see
74-
/// https://developers.google.com/admob/cpp/sdk for more information.
74+
/// https://developers.google.com/admob/cpp/reference/namespace/firebase/gma
75+
/// for more information.
7576
class InterstitialAd {
7677
public:
7778
/// Creates an uninitialized @ref InterstitialAd object.

gma/src/include/firebase/gma/rewarded_ad.h

+2-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,8 @@ class RewardedAdInternal;
7373
/// @endcode
7474
///
7575
/// @deprecated The Google Mobile Ads C++ SDK is now deprecated. Please see
76-
/// https://developers.google.com/admob/cpp/sdk for more information.
76+
/// https://developers.google.com/admob/cpp/reference/namespace/firebase/gma
77+
/// for more information.
7778
class RewardedAd {
7879
public:
7980
/// Options for RewardedAd server-side verification callbacks. Set options on

0 commit comments

Comments
 (0)