Skip to content

Mark the AdMob SDK as deprecated #954

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jun 23, 2022
Merged

Mark the AdMob SDK as deprecated #954

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
28cb3cf
draft 1
DellaBitta May 10, 2022
1fde3b0
fixed rewarded video namespace
DellaBitta May 10, 2022
4ee9933
.z banner view typo
DellaBitta May 10, 2022
185691c
moved deprecated comments to the top of the detailed descriptions
DellaBitta May 11, 2022
830c038
Updated readme.md
DellaBitta May 12, 2022
bb94153
update relative path to migration guide. pushed up dep notice on classes
DellaBitta May 16, 2022
c702831
merge main
DellaBitta May 16, 2022
2bc2345
merge main from 9.1.0 release
DellaBitta Jun 13, 2022
ebe6f4c
Merge branch 'main' into feature/deprecate_admob
DellaBitta Jun 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 83 additions & 15 deletions admob/src/include/firebase/admob.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,23 +36,48 @@ FIREBASE_APP_REGISTER_CALLBACKS_REFERENCE(admob)

namespace firebase {

/// @deprecated
/// @brief API for AdMob with Firebase.
///
/// The functionality in the <code>firebase::admob</code> namespace has
/// been replaced by the Google Mobile Ads SDK in the
/// <code>firebase::gma</code> namespace. Learn how to transition to the
/// new SDK in our <a
/// href="https://firebase.google.com/docs/admob/cpp/migration-guide">migration
/// guide</a>.
///
/// The AdMob API allows you to load and display mobile ads using the Google
/// Mobile Ads SDK. Each ad format has its own header file.
namespace admob {

/// Initializes AdMob via Firebase.
/// @deprecated
/// @brief Initializes AdMob via Firebase.
///
/// The functionality in the <code>firebase::admob</code> namespace has
/// been replaced by the Google Mobile Ads SDK in the
/// <code>firebase::gma</code> namespace. Learn how to transition to the
/// new SDK in our <a
/// href="https://firebase.google.com/docs/admob/cpp/migration-guide">migration
/// guide</a>.
///
/// @param app The Firebase app for which to initialize mobile ads.
///
/// @return kInitResultSuccess if initialization succeeded, or
/// kInitResultFailedMissingDependency on Android if Google Play services is not
/// available on the current device and the Google Mobile Ads SDK requires
/// Google Play services (for example, when using 'play-services-ads-lite').
InitResult Initialize(const ::firebase::App& app);
FIREBASE_DEPRECATED InitResult Initialize(const ::firebase::App& app);

/// Initializes AdMob via Firebase with the publisher's AdMob app ID.
/// @deprecated
/// @brief Initializes AdMob via Firebase with the publisher's AdMob app ID.
///
/// The functionality in the <code>firebase::admob</code> namespace has
/// been replaced by the Google Mobile Ads SDK in the
/// <code>firebase::gma</code> namespace. Learn how to transition to the
/// new SDK in our <a
/// href="https://firebase.google.com/docs/admob/cpp/migration-guide">migration
/// guide</a>.
///
/// Initializing the Google Mobile Ads SDK with the AdMob app ID at app launch
/// allows the SDK to fetch app-level settings and perform configuration tasks
/// as early as possible. This can help reduce latency for the initial ad
Expand All @@ -69,10 +94,19 @@ InitResult Initialize(const ::firebase::App& app);
/// kInitResultFailedMissingDependency on Android if Google Play services is not
/// available on the current device and the Google Mobile Ads SDK requires
/// Google Play services (for example, when using 'play-services-ads-lite').
InitResult Initialize(const ::firebase::App& app, const char* admob_app_id);
FIREBASE_DEPRECATED InitResult Initialize(const ::firebase::App& app,
const char* admob_app_id);

#if FIREBASE_PLATFORM_ANDROID || defined(DOXYGEN)
/// Initializes AdMob without Firebase for Android.
/// @deprecated
/// @brief Initializes AdMob without Firebase for Android.
///
/// The functionality in the <code>firebase::admob</code> namespace has
/// been replaced by the Google Mobile Ads SDK in the
/// <code>firebase::gma</code> namespace. Learn how to transition to the
/// new SDK in our <a
/// href="https://firebase.google.com/docs/admob/cpp/migration-guide">migration
/// guide</a>.
///
/// The arguments to @ref Initialize are platform-specific so the caller must do
/// something like this:
Expand All @@ -91,9 +125,18 @@ InitResult Initialize(const ::firebase::App& app, const char* admob_app_id);
/// kInitResultFailedMissingDependency on Android if Google Play services is not
/// available on the current device and the AdMob SDK requires
/// Google Play services (for example when using 'play-services-ads-lite').
InitResult Initialize(JNIEnv* jni_env, jobject activity);
FIREBASE_DEPRECATED InitResult Initialize(JNIEnv* jni_env, jobject activity);

/// Initializes AdMob via Firebase with the publisher's AdMob app ID.
/// @deprecated
/// @brief Initializes AdMob via Firebase with the publisher's AdMob app ID.
///
/// The functionality in the <code>firebase::admob</code> namespace has
/// been replaced by the Google Mobile Ads SDK in the
/// <code>firebase::gma</code> namespace. Learn how to transition to the
/// new SDK in our <a
/// href="https://firebase.google.com/docs/admob/cpp/migration-guide">migration
/// guide</a>.
///
/// Initializing the Google Mobile Ads SDK with the AdMob app ID at app launch
/// allows the SDK to fetch app-level settings and perform configuration tasks
/// as early as possible. This can help reduce latency for the initial ad
Expand Down Expand Up @@ -121,15 +164,32 @@ InitResult Initialize(JNIEnv* jni_env, jobject activity);
/// kInitResultFailedMissingDependency on Android if Google Play services is not
/// available on the current device and the AdMob SDK requires
/// Google Play services (for example when using 'play-services-ads-lite').
InitResult Initialize(JNIEnv* jni_env, jobject activity,
const char* admob_app_id);
FIREBASE_DEPRECATED InitResult Initialize(JNIEnv* jni_env, jobject activity,
const char* admob_app_id);
#endif // defined(__ANDROID__) || defined(DOXYGEN)
#if !FIREBASE_PLATFORM_ANDROID || defined(DOXYGEN)
/// Initializes AdMob without Firebase for iOS.
InitResult Initialize();
/// @deprecated
/// @brief Initializes AdMob without Firebase for iOS.
///
/// The functionality in the <code>firebase::admob</code> namespace has
/// been replaced by the Google Mobile Ads SDK in the
/// <code>firebase::gma</code> namespace. Learn how to transition to the
/// new SDK in our <a
/// href="https://firebase.google.com/docs/admob/cpp/migration-guide">migration
/// guide</a>.
FIREBASE_DEPRECATED InitResult Initialize();

/// Initializes AdMob with the publisher's AdMob app ID and without Firebase for
/// iOS.
/// @deprecated
/// @brief Initializes AdMob with the publisher's AdMob app ID and without
/// Firebase for iOS.
///
/// The functionality in the <code>firebase::admob</code> namespace has
/// been replaced by the Google Mobile Ads SDK in the
/// <code>firebase::gma</code> namespace. Learn how to transition to the
/// new SDK in our <a
/// href="https://firebase.google.com/docs/admob/cpp/migration-guide">migration
/// guide</a>.
///
/// Initializing the Google Mobile Ads SDK with the AdMob app ID at app launch
/// allows the SDK to fetch app-level settings and perform configuration tasks
/// as early as possible. This can help reduce latency for the initial ad
Expand All @@ -142,14 +202,22 @@ InitResult Initialize();
/// @param[in] admob_app_id The publisher's AdMob app ID.
///
/// @return kInitResultSuccess if initialization succeeded
InitResult Initialize(const char* admob_app_id);
FIREBASE_DEPRECATED InitResult Initialize(const char* admob_app_id);
#endif // !defined(__ANDROID__) || defined(DOXYGEN)

/// @deprecated
/// @brief Terminate AdMob.
///
/// The functionality in the <code>firebase::admob</code> namespace has
/// been replaced by the Google Mobile Ads SDK in the
/// <code>firebase::gma</code> namespace. Learn how to transition to the
/// new SDK in our <a
/// href="https://firebase.google.com/docs/admob/cpp/migration-guide">migration
/// guide</a>.
///
/// Frees resources associated with AdMob that were allocated during
/// @ref firebase::admob::Initialize().
void Terminate();
FIREBASE_DEPRECATED void Terminate();

} // namespace admob
} // namespace firebase
Expand Down
Loading