From 28cb3cf5106eedccaa71e2fb874d3e8cd1adaaec Mon Sep 17 00:00:00 2001 From: "drsanta@google.com" Date: Tue, 10 May 2022 15:19:41 -0400 Subject: [PATCH 1/6] draft 1 --- admob/src/include/firebase/admob.h | 98 ++++- .../src/include/firebase/admob/banner_view.h | 363 ++++++++++++++---- .../include/firebase/admob/interstitial_ad.h | 162 ++++++-- .../firebase/admob/native_express_ad_view.h | 337 +++++++++++----- .../include/firebase/admob/rewarded_video.h | 292 +++++++++++--- admob/src/include/firebase/admob/types.h | 78 +++- 6 files changed, 1076 insertions(+), 254 deletions(-) diff --git a/admob/src/include/firebase/admob.h b/admob/src/include/firebase/admob.h index 739402af5d..b73668089d 100644 --- a/admob/src/include/firebase/admob.h +++ b/admob/src/include/firebase/admob.h @@ -36,13 +36,29 @@ FIREBASE_APP_REGISTER_CALLBACKS_REFERENCE(admob) namespace firebase { +/// @deprecated /// @brief API for AdMob with Firebase. /// /// 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. +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. namespace admob { -/// Initializes AdMob via Firebase. +/// @deprecated +/// @brief Initializes AdMob via Firebase. +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. /// /// @param app The Firebase app for which to initialize mobile ads. /// @@ -50,9 +66,11 @@ namespace admob { /// 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. +/// /// 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 @@ -62,6 +80,13 @@ InitResult Initialize(const ::firebase::App& app); /// option under the settings dropdown (located in the upper right-hand corner). /// App IDs have the form ca-app-pub-XXXXXXXXXXXXXXXX~NNNNNNNNNN. /// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. +/// /// @param[in] app The Firebase app for which to initialize mobile ads. /// @param[in] admob_app_id The publisher's AdMob app ID. /// @@ -69,10 +94,12 @@ 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 arguments to @ref Initialize are platform-specific so the caller must do /// something like this: @@ -84,6 +111,13 @@ InitResult Initialize(const ::firebase::App& app, const char* admob_app_id); /// #endif /// @endcode /// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. +/// /// @param[in] jni_env JNIEnv pointer. /// @param[in] activity Activity used to start the application. /// @@ -91,9 +125,11 @@ 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. +/// /// 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 @@ -113,6 +149,13 @@ InitResult Initialize(JNIEnv* jni_env, jobject activity); /// #endif /// @endcode /// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. +/// /// @param[in] jni_env JNIEnv pointer. /// @param[in] activity Activity used to start the application. /// @param[in] admob_app_id The publisher's AdMob app ID. @@ -121,15 +164,25 @@ 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. +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. +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. +/// /// 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 @@ -139,17 +192,32 @@ InitResult Initialize(); /// option under the settings dropdown (located in the upper right-hand corner). /// App IDs have the form ca-app-pub-XXXXXXXXXXXXXXXX~NNNNNNNNNN. /// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. +/// /// @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. /// /// Frees resources associated with AdMob that were allocated during /// @ref firebase::admob::Initialize(). -void Terminate(); +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. +FIREBASE_DEPRECATED void Terminate(); } // namespace admob } // namespace firebase diff --git a/admob/src/include/firebase/admob/banner_view.h b/admob/src/include/firebase/admob/banner_view.h index 3bfc7080f6..c75999bd4d 100644 --- a/admob/src/include/firebase/admob/banner_view.h +++ b/admob/src/include/firebase/admob/banner_view.h @@ -29,6 +29,7 @@ namespace internal { class BannerViewInternal; } // namespace internal +/// @deprecated /// @brief Loads and displays AdMob banner ads. /// /// Each BannerView object corresponds to a single AdMob banner placement. There @@ -68,12 +69,27 @@ class BannerViewInternal; /// banner_view->LoadAd(your_ad_request); /// } /// @endcode +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. class BannerView { public: #ifdef INTERNAL_EXPERIMENTAL // LINT.IfChange #endif // INTERNAL_EXPERIMENTAL - /// The presentation state of a @ref BannerView. + /// @deprecated + /// @brief The presentation state of a @ref BannerView. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. enum PresentationState { /// BannerView is currently hidden. kPresentationStateHidden = 0, @@ -95,7 +111,15 @@ class BannerView { #ifdef INTERNAL_EXPERIMENTAL // LINT.IfChange #endif // INTERNAL_EXPERIMENTAL - /// The possible screen positions for a @ref BannerView. + /// @deprecated + /// @brief The possible screen positions for a @ref BannerView. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. enum Position { /// Top of the screen, horizontally centered. kPositionTop = 0, @@ -114,19 +138,43 @@ class BannerView { // LINT.ThenChange(//depot_firebase_cpp/admob/client/cpp/src_java/com/google/firebase/admob/internal/cpp/ConstantsHelper.java) #endif // INTERNAL_EXPERIMENTAL - /// A listener class that developers can extend and pass to a @ref BannerView - /// object's @ref SetListener method to be notified of changes to the - /// presentation state and bounding box. + /// @deprecated + /// @brief A listener class that developers can extend and pass to a @ref + /// BannerView object's @ref SetListener method to be notified of changes to + /// the presentation state and bounding box. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. class Listener { public: - /// This method is called when the @ref BannerView object's presentation - /// state changes. + /// @deprecated + /// @brief This method is called when the @ref BannerView object's + /// presentation state changes. + /// + /// Deprecated. The functionality in the + /// firebase::admob namespace has been replaced by the Google + /// Mobile Ads SDK in the firebase::gma namespace. Learn how + /// to transition to the new SDK in our migration + /// guide. /// @param[in] banner_view The banner view whose presentation state changed. /// @param[in] state The new presentation state. virtual void OnPresentationStateChanged(BannerView* banner_view, PresentationState state) = 0; - /// This method is called when the @ref BannerView object's bounding box - /// changes. + /// @deprecated + /// @brief This method is called when the @ref BannerView object's bounding + /// box changes. + /// + /// Deprecated. The functionality in the + /// firebase::admob namespace has been replaced by the Google + /// Mobile Ads SDK in the firebase::gma namespace. Learn how + /// to transition to the new SDK in our migration + /// guide. /// @param[in] banner_view The banner view whose bounding box changed. /// @param[in] box The new bounding box. virtual void OnBoundingBoxChanged(BannerView* banner_view, @@ -134,101 +182,266 @@ class BannerView { virtual ~Listener(); }; - /// Creates an uninitialized @ref BannerView object. + /// @deprecated + /// @brief Creates an uninitialized @ref BannerView object. + /// /// @ref Initialize must be called before the object is used. - BannerView(); + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED BannerView(); ~BannerView(); - /// Initializes the @ref BannerView object. + /// @deprecated + /// @brief Initializes the @ref BannerView object. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. /// @param[in] parent The platform-specific UI element that will host the ad. /// @param[in] ad_unit_id The ad unit ID to use when requesting ads. /// @param[in] size The desired ad size for the banner. - Future Initialize(AdParent parent, const char* ad_unit_id, AdSize size); + FIREBASE_DEPRECATED Future Initialize(AdParent parent, + const char* ad_unit_id, + AdSize size); - /// Returns a @ref Future that has the status of the last call to + /// @deprecated + /// @brief Returns a @ref Future that has the status of the last call to /// @ref Initialize. - Future InitializeLastResult() const; - - /// Begins an asynchronous request for an ad. If successful, the ad will - /// automatically be displayed in the BannerView. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED Future InitializeLastResult() const; + + /// @deprecated + /// @brief Begins an asynchronous request for an ad. If successful, the ad + /// will automatically be displayed in the BannerView. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. /// @param[in] request An AdRequest struct with information about the request /// to be made (such as targeting info). - Future LoadAd(const AdRequest& request); + FIREBASE_DEPRECATED Future LoadAd(const AdRequest& request); - /// Returns a @ref Future containing the status of the last call to + /// @deprecated + /// @brief Returns a @ref Future containing the status of the last call to /// @ref LoadAd. - Future LoadAdLastResult() const; - - /// Hides the BannerView. - Future Hide(); - - /// Returns a @ref Future containing the status of the last call to + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED Future LoadAdLastResult() const; + + /// @deprecated + /// @brief Hides the BannerView. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED Future Hide(); + + /// @deprecated + /// @brief Returns a @ref Future containing the status of the last call to /// @ref Hide. - Future HideLastResult() const; - - /// Shows the @ref BannerView. - Future Show(); - - /// Returns a @ref Future containing the status of the last call to + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED Future HideLastResult() const; + + /// @deprecated + /// @brief Shows the @ref BannerView. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED Future Show(); + + /// @deprecated + /// @brief Returns a @ref Future containing the status of the last call to /// @ref Show. - Future ShowLastResult() const; - - /// Pauses the @ref BannerView. Should be called whenever the C++ engine - /// pauses or the application loses focus. - Future Pause(); - - /// Returns a @ref Future containing the status of the last call to + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED Future ShowLastResult() const; + + /// @deprecated + /// @brief Pauses the @ref BannerView. Should be called whenever the C++ + /// engine pauses or the application loses focus. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED Future Pause(); + + /// @deprecated + /// @brief Returns a @ref Future containing the status of the last call to /// @ref Pause. - Future PauseLastResult() const; - - /// Resumes the @ref BannerView after pausing. - Future Resume(); - - /// Returns a @ref Future containing the status of the last call to + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED Future PauseLastResult() const; + + /// @deprecated + /// @brief Resumes the @ref BannerView after pausing. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED Future Resume(); + + /// @deprecated + /// @brief Returns a @ref Future containing the status of the last call to /// @ref Resume. - Future ResumeLastResult() const; - - /// Cleans up and deallocates any resources used by the @ref BannerView. - Future Destroy(); - - /// Returns a @ref Future containing the status of the last call to + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED Future ResumeLastResult() const; + + /// @deprecated + /// @brief Cleans up and deallocates any resources used by the @ref + /// BannerView. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED Future Destroy(); + + /// @deprecated + /// @brief Returns a @ref Future containing the status of the last call to /// @ref Destroy. - Future DestroyLastResult() const; - - /// Moves the @ref BannerView so that its top-left corner is located at + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED Future DestroyLastResult() const; + + /// @deprecated + /// @brief Moves the @ref BannerView so that its top-left corner is located at /// (x, y). Coordinates are in pixels from the top-left corner of the screen. /// - /// When built for Android, the library will not display an ad on top of or - /// beneath an Activity's status bar. If a call to MoveTo would result in an - /// overlap, the @ref BannerView is placed just below the status bar, so no - /// overlap occurs. + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. /// @param[in] x The desired horizontal coordinate. /// @param[in] y The desired vertical coordinate. - Future MoveTo(int x, int y); + FIREBASE_DEPRECATED Future MoveTo(int x, int y); - /// Moves the @ref BannerView so that it's located at the given pre-defined - /// position. + /// @deprecated + /// @brief Moves the @ref BannerView so that it's located at the given + /// pre-defined position. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. /// @param[in] position The pre-defined position to which to move the /// @ref BannerView. - Future MoveTo(Position position); + FIREBASE_DEPRECATED Future MoveTo(Position position); - /// Returns a @ref Future containing the status of the last call to either - /// version of @ref MoveTo. - Future MoveToLastResult() const; - - /// Returns the current presentation state of the @ref BannerView. + /// @deprecated + /// @brief Returns a @ref Future containing the status of the last call to + /// either version of @ref MoveTo. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED Future MoveToLastResult() const; + + /// @deprecated + /// @brief Returns the current presentation state of the @ref BannerView.z + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. /// @return The current presentation state. - PresentationState presentation_state() const; - - /// Retrieves the @ref BannerView's current onscreen size and location. - /// @return The current size and location. Values are in pixels, and location - /// coordinates originate from the top-left corner of the screen. - BoundingBox bounding_box() const; + FIREBASE_DEPRECATED PresentationState presentation_state() const; - /// Sets the @ref Listener for this object. + /// @deprecated + /// @brief Retrieves the @ref BannerView's current onscreen size and location. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED BoundingBox bounding_box() const; + + /// @deprecated + /// @brief Sets the @ref Listener for this object. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. /// @param[in] listener A valid BannerView::Listener to receive callbacks. - void SetListener(Listener* listener); + FIREBASE_DEPRECATED void SetListener(Listener* listener); private: // An internal, platform-specific implementation object that this class uses diff --git a/admob/src/include/firebase/admob/interstitial_ad.h b/admob/src/include/firebase/admob/interstitial_ad.h index 6e280eec88..1f9111da1b 100644 --- a/admob/src/include/firebase/admob/interstitial_ad.h +++ b/admob/src/include/firebase/admob/interstitial_ad.h @@ -29,6 +29,7 @@ namespace internal { class InterstitialAdInternal; } // namespace internal +/// @deprecated /// @brief Loads and displays AdMob interstitial ads. /// /// @ref InterstitialAd is a single-use object that can load and show a @@ -74,12 +75,27 @@ class InterstitialAdInternal; /// interstitial->Show(); /// } /// @endcode +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. class InterstitialAd { public: #ifdef INTERNAL_EXPERIMENTAL // LINT.IfChange #endif // INTERNAL_EXPERIMENTAL - /// The presentation states of an @ref InterstitialAd. + /// @deprecated + /// @brief The presentation states of an @ref InterstitialAd. + /// + /// Deprecated. The functionality in the + /// firebase::admob namespace has been replaced by the Google + /// Mobile Ads SDK in the firebase::gma namespace. Learn how + /// to transition to the new SDK in our migration + /// guide. enum PresentationState { /// InterstitialAd is not currently being shown. kPresentationStateHidden = 0, @@ -92,14 +108,32 @@ class InterstitialAd { // LINT.ThenChange(//depot_firebase_cpp/admob/client/cpp/src_java/com/google/firebase/admob/internal/cpp/InterstitialAdHelper.java) #endif // INTERNAL_EXPERIMENTAL - /// A listener class that developers can extend and pass to an + /// @deprecated + /// @brief A listener class that developers can extend and pass to an /// @ref InterstitialAd object's @ref SetListener method to be notified of - /// presentation state changes. This is useful for changes caused by user - /// interaction, such as when the user closes an interstitial. + /// presentation state changes. + /// + /// This is useful for changes caused by user interaction, such as when the + /// user closes an interstitial. + /// + /// Deprecated. The functionality in the + /// firebase::admob namespace has been replaced by the Google + /// Mobile Ads SDK in the firebase::gma namespace. Learn how + /// to transition to the new SDK in our migration + /// guide. class Listener { public: - /// This method is called when the @ref InterstitialAd object's presentation - /// state changes. + /// @deprecated + /// @brief This method is called when the @ref InterstitialAd object's + /// presentation state changes. + /// + /// Deprecated. The functionality in the + /// firebase::admob namespace has been replaced by the Google + /// Mobile Ads SDK in the firebase::gma namespace. Learn how + /// to transition to the new SDK in our migration + /// guide. /// @param[in] interstitial_ad The interstitial ad whose presentation state /// changed. /// @param[in] state The new presentation state. @@ -108,48 +142,122 @@ class InterstitialAd { virtual ~Listener(); }; - /// Creates an uninitialized @ref InterstitialAd object. + /// @deprecated + /// @brief Creates an uninitialized @ref InterstitialAd object. /// @ref Initialize must be called before the object is used. - InterstitialAd(); + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED InterstitialAd(); ~InterstitialAd(); - /// Initialize the @ref InterstitialAd object. + /// @deprecated + /// @brief Initialize the @ref InterstitialAd object. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. /// @param[in] parent The platform-specific UI element that will host the ad. /// @param[in] ad_unit_id The ad unit ID to use in loading the ad. - Future Initialize(AdParent parent, const char* ad_unit_id); + FIREBASE_DEPRECATED Future Initialize(AdParent parent, + const char* ad_unit_id); - /// Returns a @ref Future containing the status of the last call to + /// @deprecated + /// @brief Returns a @ref Future containing the status of the last call to /// @ref Initialize. - Future InitializeLastResult() const; + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED Future InitializeLastResult() const; - /// Begins an asynchronous request for an ad. The - /// @ref InterstitialAd::presentation_state method can be used to track the - /// progress of the request. + /// @deprecated + /// @brief Begins an asynchronous request for an ad. + /// + /// The @ref InterstitialAd::presentation_state method can be used to track + /// the progress of the request. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. /// @param[in] request An AdRequest struct with information about the request /// to be made (such as targeting info). - Future LoadAd(const AdRequest& request); + FIREBASE_DEPRECATED Future LoadAd(const AdRequest& request); - /// Returns a @ref Future containing the status of the last call to + /// @deprecated + /// @brief Returns a @ref Future containing the status of the last call to /// @ref LoadAd. - Future LoadAdLastResult() const; + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED Future LoadAdLastResult() const; - /// Shows the @ref InterstitialAd. This should not be called unless an ad has - /// already been loaded. - Future Show(); + /// @deprecated + /// @brief Shows the @ref InterstitialAd. This should not be called unless an + /// ad has already been loaded. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED Future Show(); - /// Returns a @ref Future containing the status of the last call to @ref Show. - Future ShowLastResult() const; + /// @deprecated + /// @brief Returns a @ref Future containing the status of the last call to + /// @ref Show. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED Future ShowLastResult() const; - /// Returns the current presentation state of the @ref InterstitialAd. + /// @deprecated + /// @brief Returns the current presentation state of the @ref InterstitialAd. /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. /// @return The current presentation state. - PresentationState presentation_state() const; + FIREBASE_DEPRECATED PresentationState presentation_state() const; - /// Sets the @ref Listener for this @ref InterstitialAd. + /// @deprecated + /// @brief Sets the @ref Listener for this @ref InterstitialAd. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. /// @param[in] listener A valid InterstititalAd::Listener to receive /// callbacks. - void SetListener(Listener* listener); + FIREBASE_DEPRECATED void SetListener(Listener* listener); private: // An internal, platform-specific implementation object that this class uses diff --git a/admob/src/include/firebase/admob/native_express_ad_view.h b/admob/src/include/firebase/admob/native_express_ad_view.h index 416aebf276..7d8c4c9772 100644 --- a/admob/src/include/firebase/admob/native_express_ad_view.h +++ b/admob/src/include/firebase/admob/native_express_ad_view.h @@ -29,6 +29,7 @@ namespace internal { class NativeExpressAdViewInternal; } // namespace internal +/// @deprecated /// @brief Loads and displays ads from AdMob Native Ads Express. /// /// Each NativeExpressAdView object corresponds to a single AdMob Native Express @@ -69,14 +70,26 @@ class NativeExpressAdViewInternal; /// } /// @endcode /// -/// @deprecated This class will be removed in a future version. -/// Native Express Ads has been discontinued, and are no longer served. +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. class NativeExpressAdView { public: #ifdef INTERNAL_EXPERIMENTAL // LINT.IfChange #endif // INTERNAL_EXPERIMENTAL - /// The presentation state of a @ref NativeExpressAdView. + /// @deprecated + /// @brief The presentation state of a @ref NativeExpressAdView. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. enum PresentationState { /// NativeExpressAdView is currently hidden. kPresentationStateHidden = 0, @@ -99,7 +112,15 @@ class NativeExpressAdView { #ifdef INTERNAL_EXPERIMENTAL // LINT.IfChange #endif // INTERNAL_EXPERIMENTAL - /// The possible screen positions for a @ref NativeExpressAdView. + /// @deprecated + /// @brief The possible screen positions for a @ref NativeExpressAdView. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. enum Position { /// Top of the screen, horizontally centered. kPositionTop = 0, @@ -118,190 +139,326 @@ class NativeExpressAdView { // LINT.ThenChange(//depot_firebase_cpp/admob/client/cpp/src_java/com/google/firebase/admob/internal/cpp/ConstantsHelper.java) #endif // INTERNAL_EXPERIMENTAL - /// A listener class that developers can extend and pass to a + /// @deprecated + /// @brief A listener class that developers can extend and pass to a /// @ref NativeExpressAdView object's @ref SetListener method to be notified /// of changes to the presentation state and bounding box. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. class Listener { public: - /// This method is called when the @ref NativeExpressAdView object's + /// @deprecated + /// @brief This method is called when the @ref NativeExpressAdView object's /// presentation state changes. + /// + /// Deprecated. The functionality in the + /// firebase::admob namespace has been replaced by the Google + /// Mobile Ads SDK in the firebase::gma namespace. Learn how + /// to transition to the new SDK in our migration + /// guide. /// @param[in] ad_view The native express ad view whose presentation state /// changed. /// @param[in] state The new presentation state. - virtual void OnPresentationStateChanged(NativeExpressAdView* ad_view, - PresentationState state) = 0; - /// This method is called when the @ref NativeExpressAdView object's + FIREBASE_DEPRECATED virtual void OnPresentationStateChanged( + NativeExpressAdView* ad_view, PresentationState state) = 0; + + /// @deprecated + /// @brief This method is called when the @ref NativeExpressAdView object's /// bounding box changes. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. /// @param[in] ad_view The native express ad view whose bounding box /// changed. /// @param[in] box The new bounding box. - virtual void OnBoundingBoxChanged(NativeExpressAdView* ad_view, - BoundingBox box) = 0; + FIREBASE_DEPRECATED virtual void OnBoundingBoxChanged( + NativeExpressAdView* ad_view, BoundingBox box) = 0; + virtual ~Listener(); }; - /// Creates an uninitialized @ref NativeExpressAdView object. + /// @deprecated + /// @brief Creates an uninitialized @ref NativeExpressAdView object. + /// /// @ref Initialize must be called before the object is used. /// - /// @deprecated This class will be removed in a future version. - /// Native Express Ads has been discontinued, and are no longer served. + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. FIREBASE_DEPRECATED NativeExpressAdView(); - /// @deprecated This class will be removed in a future version. - /// Native Express Ads has been discontinued, and are no longer served. - FIREBASE_DEPRECATED ~NativeExpressAdView(); + ~NativeExpressAdView(); - /// Initializes the @ref NativeExpressAdView object. + /// @deprecated + /// @brief Initializes the @ref NativeExpressAdView object. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. /// @param[in] parent The platform-specific UI element that will host the ad. /// @param[in] ad_unit_id The ad unit ID to use when requesting ads. /// @param[in] size The desired ad size for the native express ad. - /// - /// @deprecated This class will be removed in a future version. - /// Native Express Ads has been discontinued, and are no longer served. FIREBASE_DEPRECATED Future Initialize(AdParent parent, const char* ad_unit_id, AdSize size); - /// Returns a @ref Future that has the status of the last call to + /// @deprecated + /// @brief Returns a @ref Future that has the status of the last call to /// @ref Initialize. - Future InitializeLastResult() const; - - /// Begins an asynchronous request for an ad. If successful, the ad will - /// automatically be displayed in the NativeExpressAdView. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED Future InitializeLastResult() const; + + /// @deprecated + /// @brief Begins an asynchronous request for an ad. If successful, the ad + /// will automatically be displayed in the NativeExpressAdView. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. /// @param[in] request An AdRequest struct with information about the request /// to be made (such as targeting info). - /// - /// @deprecated This class will be removed in a future version. - /// Native Express Ads has been discontinued, and are no longer served. FIREBASE_DEPRECATED Future LoadAd(const AdRequest& request); - /// Returns a @ref Future containing the status of the last call to + /// @deprecated + /// @brief Returns a @ref Future containing the status of the last call to /// @ref LoadAd. /// - /// @deprecated This class will be removed in a future version. - /// Native Express Ads has been discontinued, and are no longer served. + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. FIREBASE_DEPRECATED Future LoadAdLastResult() const; - /// Hides the NativeExpressAdView. + /// @deprecated + /// @brief Hides the NativeExpressAdView. /// - /// @deprecated This class will be removed in a future version. - /// Native Express Ads has been discontinued, and are no longer served. + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. FIREBASE_DEPRECATED Future Hide(); - /// Returns a @ref Future containing the status of the last call to + /// @deprecated + /// @brief Returns a @ref Future containing the status of the last call to /// @ref Hide. /// - /// @deprecated This class will be removed in a future version. - /// Native Express Ads has been discontinued, and are no longer served. + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. FIREBASE_DEPRECATED Future HideLastResult() const; - /// Shows the @ref NativeExpressAdView. + /// @deprecated + /// @brief Shows the @ref NativeExpressAdView. /// - /// @deprecated This class will be removed in a future version. - /// Native Express Ads has been discontinued, and are no longer served. + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. FIREBASE_DEPRECATED Future Show(); - /// Returns a @ref Future containing the status of the last call to + /// @deprecated + /// @brief Returns a @ref Future containing the status of the last call to /// @ref Show. /// - /// @deprecated This class will be removed in a future version. - /// Native Express Ads has been discontinued, and are no longer served. + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. FIREBASE_DEPRECATED Future ShowLastResult() const; - /// Pauses the @ref NativeExpressAdView. Should be called whenever the C++ - /// engine pauses or the application loses focus. + /// @deprecated + /// @brief Pauses the @ref NativeExpressAdView. /// - /// @deprecated This class will be removed in a future version. - /// Native Express Ads has been discontinued, and are no longer served. + /// Should be called whenever the C++ engine pauses or the application loses + /// focus. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. FIREBASE_DEPRECATED Future Pause(); - /// Returns a @ref Future containing the status of the last call to + /// @deprecated + /// @brief Returns a @ref Future containing the status of the last call to /// @ref Pause. /// - /// @deprecated This class will be removed in a future version. - /// Native Express Ads has been discontinued, and are no longer served. + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. FIREBASE_DEPRECATED Future PauseLastResult() const; - /// Resumes the @ref NativeExpressAdView after pausing. + /// @deprecated + /// @brief Resumes the @ref NativeExpressAdView after pausing. /// - /// @deprecated This class will be removed in a future version. - /// Native Express Ads has been discontinued, and are no longer served. + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. FIREBASE_DEPRECATED Future Resume(); - /// Returns a @ref Future containing the status of the last call to + /// @deprecated + /// @brief Returns a @ref Future containing the status of the last call to /// @ref Resume. /// - /// @deprecated This class will be removed in a future version. - /// Native Express Ads has been discontinued, and are no longer served. + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. FIREBASE_DEPRECATED Future ResumeLastResult() const; - /// Cleans up and deallocates any resources used by the + /// @deprecated + /// @brief Cleans up and deallocates any resources used by the /// @ref NativeExpressAdView. /// - /// @deprecated This class will be removed in a future version. - /// Native Express Ads has been discontinued, and are no longer served. + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. FIREBASE_DEPRECATED Future Destroy(); - /// Returns a @ref Future containing the status of the last call to + /// @deprecated + /// @brief Returns a @ref Future containing the status of the last call to /// @ref Destroy. /// - /// @deprecated This class will be removed in a future version. - /// Native Express Ads has been discontinued, and are no longer served. + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. FIREBASE_DEPRECATED Future DestroyLastResult() const; - /// Moves the @ref NativeExpressAdView so that its top-left corner is located - /// at (x, y). Coordinates are in pixels from the top-left corner of the - /// screen. + /// @deprecated + /// @brief Moves the @ref NativeExpressAdView so that its top-left corner is + /// located at (x, y). Coordinates are in pixels from the top-left corner of + /// the screen. /// /// When built for Android, the library will not display an ad on top of or /// beneath an Activity's status bar. If a call to MoveTo would result in an /// overlap, the @ref NativeExpressAdView is placed just below the status bar, /// so no overlap occurs. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. /// @param[in] x The desired horizontal coordinate. /// @param[in] y The desired vertical coordinate. - /// - /// @deprecated This class will be removed in a future version. - /// Native Express Ads has been discontinued, and are no longer served. FIREBASE_DEPRECATED Future MoveTo(int x, int y); - /// Moves the @ref NativeExpressAdView so that it's located at the given - /// pre-defined position. + /// @deprecated + /// @brief Moves the @ref NativeExpressAdView so that it's located at the + /// given pre-defined position. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. /// @param[in] position The pre-defined position to which to move the /// @ref NativeExpressAdView. - /// - /// @deprecated This class will be removed in a future version. - /// Native Express Ads has been discontinued, and are no longer served. FIREBASE_DEPRECATED Future MoveTo(Position position); - /// Returns a @ref Future containing the status of the last call to either - /// version of @ref MoveTo. + /// @deprecated + /// @brief Returns a @ref Future containing the status of the last call to + /// either version of @ref MoveTo. /// - /// @deprecated This class will be removed in a future version. - /// Native Express Ads has been discontinued, and are no longer served. + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. FIREBASE_DEPRECATED Future MoveToLastResult() const; - /// Returns the current presentation state of the @ref NativeExpressAdView. - /// @return The current presentation state. + /// @deprecated + /// @brief Returns the current presentation state of the + /// @ref NativeExpressAdView. /// - /// @deprecated This class will be removed in a future version. - /// Native Express Ads has been discontinued, and are no longer served. + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + /// @return The current presentation state. FIREBASE_DEPRECATED PresentationState GetPresentationState() const; - /// Retrieves the @ref NativeExpressAdView's current onscreen size and + /// @deprecated + /// @brief Retrieves the @ref NativeExpressAdView's current onscreen size and /// location. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. /// @return The current size and location. Values are in pixels, and location /// coordinates originate from the top-left corner of the screen. - /// - /// @deprecated This class will be removed in a future version. - /// Native Express Ads has been discontinued, and are no longer served. FIREBASE_DEPRECATED BoundingBox GetBoundingBox() const; - /// Sets the @ref Listener for this object. + /// @deprecated + /// @brief Sets the @ref Listener for this object. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. /// @param[in] listener A valid NativeExpressAdView::Listener to receive /// callbacks. - /// - /// @deprecated This class will be removed in a future version. - /// Native Express Ads has been discontinued, and are no longer served. FIREBASE_DEPRECATED void SetListener(Listener* listener); private: diff --git a/admob/src/include/firebase/admob/rewarded_video.h b/admob/src/include/firebase/admob/rewarded_video.h index ac77c19dc1..7b6b321a0f 100644 --- a/admob/src/include/firebase/admob/rewarded_video.h +++ b/admob/src/include/firebase/admob/rewarded_video.h @@ -30,6 +30,7 @@ class Mutex; namespace admob { +/// @deprecated /// @brief Loads and displays rewarded video ads via AdMob mediation. /// /// The rewarded_video namespace contains methods to load and display rewarded @@ -90,12 +91,25 @@ namespace admob { /// firebase::admob::rewarded_video::Show(my_ad_parent); /// } /// @endcode -namespace rewarded_video { - +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide.namespace rewarded_video { #ifdef INTERNAL_EXPERIMENTAL // LINT.IfChange #endif // INTERNAL_EXPERIMENTAL -/// The possible presentation states for rewarded video. +/// @deprecated +/// @brief The possible presentation states for rewarded video. +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. enum PresentationState { /// No ad is currently being shown. kPresentationStateHidden = 0, @@ -114,8 +128,16 @@ enum PresentationState { // LINT.ThenChange(//depot_firebase_cpp/admob/client/cpp/src_java/com/google/firebase/admob/internal/cpp/RewardedVideoHelper.java) #endif // INTERNAL_EXPERIMENTAL +/// @deprecated /// @brief A reward to be given to the user in exchange for watching a rewarded /// video ad. +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. struct RewardItem { /// The reward amount. float amount; @@ -123,40 +145,112 @@ struct RewardItem { std::string reward_type; }; -/// A listener class that developers can extend and pass to @ref SetListener -/// to be notified of rewards and changes to the presentation state. +/// @deprecated +/// @brief A listener class that developers can extend and pass to @ref +/// SetListener to be notified of rewards and changes to the presentation state. +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. class Listener { public: - /// Invoked when the user should be given a reward for watching an ad. + /// @deprecated + /// @brief Invoked when the user should be given a reward for watching an ad. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. /// @param[in] reward The user's reward. - virtual void OnRewarded(RewardItem reward) = 0; + FIREBASE_DEPRECATED virtual void OnRewarded(RewardItem reward) = 0; - /// Invoked when the presentation state of the ad changes. + /// @deprecated + /// @brief Invoked when the presentation state of the ad changes. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. /// @param[in] state The new presentation state. - virtual void OnPresentationStateChanged(PresentationState state) = 0; + FIREBASE_DEPRECATED virtual void OnPresentationStateChanged( + PresentationState state) = 0; virtual ~Listener(); }; -/// A polling-based listener that developers can instantiate and pass to +/// @deprecated +/// @brief A polling-based listener that developers can instantiate and pass to /// @ref SetListener in order to queue rewards for later retrieval. /// /// The @ref PollReward method should be used to retrieve awards granted by the /// Mobile Ads SDK and queued by this class. /// @ref rewarded_video::presentation_state can be used to poll the current /// presentation state, so no additional method has been added for it. +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. class PollableRewardListener : public Listener { public: - PollableRewardListener(); + /// @deprecated + /// @brief Default constructor. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED PollableRewardListener(); ~PollableRewardListener(); - void OnRewarded(RewardItem reward); - void OnPresentationStateChanged(PresentationState state); - /// Pop the oldest queued reward, and copy its data into the provided - /// RewardItem. If no reward is available, the struct is unchanged. + /// @deprecated + /// @brief Invoked when the user should be given a reward for watching an ad. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED void OnRewarded(RewardItem reward); + + /// @deprecated + /// @brief nvoked when the presentation state of the ad changes. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. + FIREBASE_DEPRECATED void OnPresentationStateChanged(PresentationState state); + + /// @deprecated + /// @brief Pop the oldest queued reward, and copy its data into the provided + /// RewardItem. + /// + /// If no reward is available, the struct is unchanged. + /// + /// Deprecated. The functionality in the firebase::admob + /// namespace has been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the new + /// SDK in our migration + /// guide. /// @param reward Pointer to a struct that reward data can be copied into. /// @returns true if a reward was popped and data was copied, false otherwise. - bool PollReward(RewardItem* reward); + FIREBASE_DEPRECATED bool PollReward(RewardItem* reward); private: Mutex* mutex_; @@ -165,63 +259,171 @@ class PollableRewardListener : public Listener { std::queue rewards_; }; -/// Initializes rewarded video. This must be the first method invoked in +/// @deprecated +/// @brief Initializes rewarded video. This must be the first method invoked in /// this namespace. -Future Initialize(); +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. +FIREBASE_DEPRECATED Future Initialize(); -/// Returns a @ref Future that has the status of the last call to +/// @deprecated +/// @brief Returns a @ref Future that has the status of the last call to /// @ref Initialize. -Future InitializeLastResult(); +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. +FIREBASE_DEPRECATED Future InitializeLastResult(); -/// Begins an asynchronous request for an ad. +/// @deprecated +/// @brief Begins an asynchronous request for an ad. +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. /// @param[in] ad_unit_id The ad unit ID to use in the request. /// @param[in] request An AdRequest struct with information about the request /// to be made (such as targeting info). -Future LoadAd(const char* ad_unit_id, const AdRequest& request); +FIREBASE_DEPRECATED Future LoadAd(const char* ad_unit_id, + const AdRequest& request); -/// Returns a @ref Future containing the status of the last call to +/// @deprecated +/// @brief Returns a @ref Future containing the status of the last call to /// @ref LoadAd. -Future LoadAdLastResult(); +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. +FIREBASE_DEPRECATED Future LoadAdLastResult(); -/// Shows an ad, assuming one has loaded. @ref LoadAd must be called before this -/// method. +/// @deprecated +/// @brief Shows an ad, assuming one has loaded. +/// +/// @ref LoadAd must be called before this method. +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. /// @param[in] parent An @ref AdParent that is a reference to an iOS /// UIView or an Android Activity. -Future Show(AdParent parent); +FIREBASE_DEPRECATED Future Show(AdParent parent); -/// Returns a @ref Future containing the status of the last call to +/// @deprecated +/// @brief Returns a @ref Future containing the status of the last call to /// @ref Show. -Future ShowLastResult(); +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. +FIREBASE_DEPRECATED Future ShowLastResult(); -/// Pauses any background processing associated with rewarded video. Should -/// be called whenever the C++ engine pauses or the application loses focus. -Future Pause(); +/// @deprecated +/// @brief Pauses any background processing associated with rewarded video. +/// +/// Should be called whenever the C++ engine pauses or the application loses +/// focus. +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. +FIREBASE_DEPRECATED Future Pause(); -/// Returns a @ref Future containing the status of the last call to +/// @deprecated +/// @brief Returns a @ref Future containing the status of the last call to /// @ref Pause. -Future PauseLastResult(); +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. +FIREBASE_DEPRECATED Future PauseLastResult(); -/// Resumes the rewarded video system after pausing. -Future Resume(); +/// @deprecated +/// @brief Resumes the rewarded video system after pausing. +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. +FIREBASE_DEPRECATED Future Resume(); -/// Returns a @ref Future containing the status of the last call to +/// @deprecated +/// @brief Returns a @ref Future containing the status of the last call to /// @ref Resume. -Future ResumeLastResult(); +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. +FIREBASE_DEPRECATED Future ResumeLastResult(); -/// Cleans up and deallocates any resources used by rewarded video. +/// @deprecated +/// @brief Cleans up and deallocates any resources used by rewarded video. +/// /// No other methods in rewarded_video should be called once this method has /// been invoked. The system is closed for business at that point. -void Destroy(); +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. +FIREBASE_DEPRECATED void Destroy(); -/// Returns the current presentation state, indicating if an ad is visible or -/// if a video has started playing. +/// @deprecated +/// @brief Returns the current presentation state, indicating if an ad is +/// visible or if a video has started playing. /// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. /// @return The current presentation state. -PresentationState presentation_state(); +FIREBASE_DEPRECATED PresentationState presentation_state(); -/// Sets the @ref Listener that should receive callbacks. +/// @deprecated +/// @brief Sets the @ref Listener that should receive callbacks. +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. /// @param[in] listener A valid Listener. -void SetListener(Listener* listener); +FIREBASE_DEPRECATED void SetListener(Listener* listener); } // namespace rewarded_video } // namespace admob diff --git a/admob/src/include/firebase/admob/types.h b/admob/src/include/firebase/admob/types.h index c6cd485edd..c477b7df4c 100644 --- a/admob/src/include/firebase/admob/types.h +++ b/admob/src/include/firebase/admob/types.h @@ -31,13 +31,23 @@ extern "C" { namespace firebase { namespace admob { -/// This is a platform specific datatype that is required to create an AdMob ad. +/// @deprecated +/// @brief This is a platform specific datatype that is required to create an +/// AdMob ad. /// /// The following defines the datatype on each platform: ///
    ///
  • Android: A `jobject` which references an Android Activity.
    • ///
  • iOS: An `id` which references an iOS UIView.
    • ///
+/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. +/// #if FIREBASE_PLATFORM_ANDROID /// An Android Activity from Java. typedef jobject AdParent; @@ -53,7 +63,15 @@ typedef void *AdParent; #ifdef INTERNAL_EXPERIMENTAL // LINT.IfChange #endif // INTERNAL_EXPERIMENTAL -/// Error codes returned by Future::error(). +/// @deprecated +/// @brief Error codes returned by Future::error(). +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. enum AdMobError { /// Call completed successfully. kAdMobErrorNone, @@ -81,10 +99,26 @@ enum AdMobError { // LINT.ThenChange(//depot_firebase_cpp/admob/client/cpp/src_java/com/google/firebase/admob/internal/cpp/ConstantsHelper.java) #endif // INTERNAL_EXPERIMENTAL +/// @deprecated /// @brief Types of ad sizes. +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. enum AdSizeType { kAdSizeStandard = 0 }; +/// @deprecated /// @brief An ad size value to be used in requesting ads. +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. struct AdSize { /// The type of ad size. AdSizeType ad_size_type; @@ -94,8 +128,16 @@ struct AdSize { int width; }; +/// @deprecated /// @brief Gender information used as part of the /// @ref firebase::admob::AdRequest struct. +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. enum Gender { /// The gender of the current user is unknown or unspecified by the publisher. kGenderUnknown = 0, @@ -105,8 +147,16 @@ enum Gender { kGenderFemale }; +/// @deprecated /// @brief Indicates whether an ad request is considered tagged for /// child-directed treatment. +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. enum ChildDirectedTreatmentState { /// The child-directed status for the request is not indicated. kChildDirectedTreatmentStateUnknown = 0, @@ -116,8 +166,16 @@ enum ChildDirectedTreatmentState { kChildDirectedTreatmentStateNotTagged }; +/// @deprecated /// @brief Generic Key-Value container used for the "extras" values in an /// @ref firebase::admob::AdRequest. +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. struct KeyValuePair { /// The name for an "extra." const char *key; @@ -125,7 +183,15 @@ struct KeyValuePair { const char *value; }; +/// @deprecated /// @brief The information needed to request an ad. +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. struct AdRequest { /// An array of test device IDs specifying devices that test ads will be /// returned for. @@ -159,8 +225,16 @@ struct AdRequest { ChildDirectedTreatmentState tagged_for_child_directed_treatment; }; +/// @deprecated /// @brief The screen location and dimensions of an ad view once it has been /// initialized. +/// +/// Deprecated. The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. struct BoundingBox { /// Default constructor which initializes all member variables to 0. BoundingBox() : height(0), width(0), x(0), y(0) {} From 1fde3b05af87a958c8b332250107300066ca8213 Mon Sep 17 00:00:00 2001 From: "drsanta@google.com" Date: Tue, 10 May 2022 17:33:02 -0400 Subject: [PATCH 2/6] fixed rewarded video namespace --- admob/src/include/firebase/admob/rewarded_video.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/admob/src/include/firebase/admob/rewarded_video.h b/admob/src/include/firebase/admob/rewarded_video.h index 7b6b321a0f..ae6e9e31df 100644 --- a/admob/src/include/firebase/admob/rewarded_video.h +++ b/admob/src/include/firebase/admob/rewarded_video.h @@ -97,7 +97,8 @@ namespace admob { /// firebase::gma namespace. Learn how to transition to the new /// SDK in our migration -/// guide.namespace rewarded_video { +/// guide. +namespace rewarded_video { #ifdef INTERNAL_EXPERIMENTAL // LINT.IfChange #endif // INTERNAL_EXPERIMENTAL From 4ee9933a685fd88ad62717a182b149d6c5ac2adf Mon Sep 17 00:00:00 2001 From: "drsanta@google.com" Date: Tue, 10 May 2022 19:42:37 -0400 Subject: [PATCH 3/6] .z banner view typo --- admob/src/include/firebase/admob/banner_view.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/admob/src/include/firebase/admob/banner_view.h b/admob/src/include/firebase/admob/banner_view.h index c75999bd4d..16dadc3588 100644 --- a/admob/src/include/firebase/admob/banner_view.h +++ b/admob/src/include/firebase/admob/banner_view.h @@ -409,7 +409,7 @@ class BannerView { FIREBASE_DEPRECATED Future MoveToLastResult() const; /// @deprecated - /// @brief Returns the current presentation state of the @ref BannerView.z + /// @brief Returns the current presentation state of the @ref BannerView. /// /// Deprecated. The functionality in the firebase::admob /// namespace has been replaced by the Google Mobile Ads SDK in the From 185691c2c539618d9b492c135686f625335748f6 Mon Sep 17 00:00:00 2001 From: "drsanta@google.com" Date: Wed, 11 May 2022 10:23:39 -0400 Subject: [PATCH 4/6] moved deprecated comments to the top of the detailed descriptions --- admob/src/include/firebase/admob.h | 100 ++++---- .../src/include/firebase/admob/banner_view.h | 225 ++++++++--------- .../include/firebase/admob/interstitial_ad.h | 114 ++++----- .../firebase/admob/native_express_ad_view.h | 238 +++++++++--------- .../include/firebase/admob/rewarded_video.h | 208 +++++++-------- admob/src/include/firebase/admob/types.h | 78 +++--- 6 files changed, 483 insertions(+), 480 deletions(-) diff --git a/admob/src/include/firebase/admob.h b/admob/src/include/firebase/admob.h index b73668089d..8c395df9c1 100644 --- a/admob/src/include/firebase/admob.h +++ b/admob/src/include/firebase/admob.h @@ -39,24 +39,24 @@ namespace firebase { /// @deprecated /// @brief API for AdMob with Firebase. /// -/// 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. -/// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. +/// +/// 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 { /// @deprecated /// @brief Initializes AdMob via Firebase. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. /// @@ -71,6 +71,13 @@ FIREBASE_DEPRECATED InitResult Initialize(const ::firebase::App& app); /// @deprecated /// @brief Initializes AdMob via Firebase with the publisher's AdMob app ID. /// +/// The functionality in the firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration +/// guide. +/// /// 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 @@ -80,13 +87,6 @@ FIREBASE_DEPRECATED InitResult Initialize(const ::firebase::App& app); /// option under the settings dropdown (located in the upper right-hand corner). /// App IDs have the form ca-app-pub-XXXXXXXXXXXXXXXX~NNNNNNNNNN. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our migration -/// guide. -/// /// @param[in] app The Firebase app for which to initialize mobile ads. /// @param[in] admob_app_id The publisher's AdMob app ID. /// @@ -101,6 +101,13 @@ FIREBASE_DEPRECATED InitResult Initialize(const ::firebase::App& app, /// @deprecated /// @brief Initializes AdMob without Firebase for Android. /// +/// The functionality in the firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration +/// guide. +/// /// The arguments to @ref Initialize are platform-specific so the caller must do /// something like this: /// @code @@ -111,13 +118,6 @@ FIREBASE_DEPRECATED InitResult Initialize(const ::firebase::App& app, /// #endif /// @endcode /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our migration -/// guide. -/// /// @param[in] jni_env JNIEnv pointer. /// @param[in] activity Activity used to start the application. /// @@ -130,6 +130,13 @@ FIREBASE_DEPRECATED InitResult Initialize(JNIEnv* jni_env, jobject activity); /// @deprecated /// @brief Initializes AdMob via Firebase with the publisher's AdMob app ID. /// +/// The functionality in the firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration +/// guide. +/// /// 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 @@ -149,13 +156,6 @@ FIREBASE_DEPRECATED InitResult Initialize(JNIEnv* jni_env, jobject activity); /// #endif /// @endcode /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our migration -/// guide. -/// /// @param[in] jni_env JNIEnv pointer. /// @param[in] activity Activity used to start the application. /// @param[in] admob_app_id The publisher's AdMob app ID. @@ -171,10 +171,10 @@ FIREBASE_DEPRECATED InitResult Initialize(JNIEnv* jni_env, jobject activity, /// @deprecated /// @brief Initializes AdMob without Firebase for iOS. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. FIREBASE_DEPRECATED InitResult Initialize(); @@ -183,6 +183,13 @@ FIREBASE_DEPRECATED InitResult Initialize(); /// @brief Initializes AdMob with the publisher's AdMob app ID and without /// Firebase for iOS. /// +/// The functionality in the firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration +/// guide. +/// /// 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 @@ -192,13 +199,6 @@ FIREBASE_DEPRECATED InitResult Initialize(); /// option under the settings dropdown (located in the upper right-hand corner). /// App IDs have the form ca-app-pub-XXXXXXXXXXXXXXXX~NNNNNNNNNN. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our migration -/// guide. -/// /// @param[in] admob_app_id The publisher's AdMob app ID. /// /// @return kInitResultSuccess if initialization succeeded @@ -208,15 +208,15 @@ FIREBASE_DEPRECATED InitResult Initialize(const char* admob_app_id); /// @deprecated /// @brief Terminate AdMob. /// -/// Frees resources associated with AdMob that were allocated during -/// @ref firebase::admob::Initialize(). -/// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. +/// +/// Frees resources associated with AdMob that were allocated during +/// @ref firebase::admob::Initialize(). FIREBASE_DEPRECATED void Terminate(); } // namespace admob diff --git a/admob/src/include/firebase/admob/banner_view.h b/admob/src/include/firebase/admob/banner_view.h index 16dadc3588..94fde84c55 100644 --- a/admob/src/include/firebase/admob/banner_view.h +++ b/admob/src/include/firebase/admob/banner_view.h @@ -32,6 +32,13 @@ class BannerViewInternal; /// @deprecated /// @brief Loads and displays AdMob banner ads. /// +/// The functionality in the firebase::admob +/// namespace has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration +/// guide. +/// /// Each BannerView object corresponds to a single AdMob banner placement. There /// are methods to load an ad, move it, show it and hide it, and retrieve the /// bounds of the ad onscreen. @@ -70,12 +77,6 @@ class BannerViewInternal; /// } /// @endcode /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our migration -/// guide. class BannerView { public: #ifdef INTERNAL_EXPERIMENTAL @@ -84,10 +85,10 @@ class BannerView { /// @deprecated /// @brief The presentation state of a @ref BannerView. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. enum PresentationState { @@ -114,10 +115,10 @@ class BannerView { /// @deprecated /// @brief The possible screen positions for a @ref BannerView. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. enum Position { @@ -143,10 +144,10 @@ class BannerView { /// BannerView object's @ref SetListener method to be notified of changes to /// the presentation state and bounding box. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. class Listener { @@ -155,10 +156,10 @@ class BannerView { /// @brief This method is called when the @ref BannerView object's /// presentation state changes. /// - /// Deprecated. The functionality in the - /// firebase::admob namespace has been replaced by the Google - /// Mobile Ads SDK in the firebase::gma namespace. Learn how - /// to transition to the new SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @param[in] banner_view The banner view whose presentation state changed. @@ -169,10 +170,10 @@ class BannerView { /// @brief This method is called when the @ref BannerView object's bounding /// box changes. /// - /// Deprecated. The functionality in the - /// firebase::admob namespace has been replaced by the Google - /// Mobile Ads SDK in the firebase::gma namespace. Learn how - /// to transition to the new SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @param[in] banner_view The banner view whose bounding box changed. @@ -185,14 +186,14 @@ class BannerView { /// @deprecated /// @brief Creates an uninitialized @ref BannerView object. /// - /// @ref Initialize must be called before the object is used. - /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. + /// + /// @ref Initialize must be called before the object is used. FIREBASE_DEPRECATED BannerView(); ~BannerView(); @@ -200,10 +201,10 @@ class BannerView { /// @deprecated /// @brief Initializes the @ref BannerView object. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @param[in] parent The platform-specific UI element that will host the ad. @@ -217,10 +218,10 @@ class BannerView { /// @brief Returns a @ref Future that has the status of the last call to /// @ref Initialize. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future InitializeLastResult() const; @@ -229,10 +230,10 @@ class BannerView { /// @brief Begins an asynchronous request for an ad. If successful, the ad /// will automatically be displayed in the BannerView. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @param[in] request An AdRequest struct with information about the request @@ -243,10 +244,10 @@ class BannerView { /// @brief Returns a @ref Future containing the status of the last call to /// @ref LoadAd. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future LoadAdLastResult() const; @@ -254,10 +255,10 @@ class BannerView { /// @deprecated /// @brief Hides the BannerView. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Hide(); @@ -266,10 +267,10 @@ class BannerView { /// @brief Returns a @ref Future containing the status of the last call to /// @ref Hide. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future HideLastResult() const; @@ -277,10 +278,10 @@ class BannerView { /// @deprecated /// @brief Shows the @ref BannerView. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Show(); @@ -289,10 +290,10 @@ class BannerView { /// @brief Returns a @ref Future containing the status of the last call to /// @ref Show. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future ShowLastResult() const; @@ -301,10 +302,10 @@ class BannerView { /// @brief Pauses the @ref BannerView. Should be called whenever the C++ /// engine pauses or the application loses focus. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Pause(); @@ -313,10 +314,10 @@ class BannerView { /// @brief Returns a @ref Future containing the status of the last call to /// @ref Pause. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future PauseLastResult() const; @@ -324,10 +325,10 @@ class BannerView { /// @deprecated /// @brief Resumes the @ref BannerView after pausing. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Resume(); @@ -336,10 +337,10 @@ class BannerView { /// @brief Returns a @ref Future containing the status of the last call to /// @ref Resume. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future ResumeLastResult() const; @@ -348,10 +349,10 @@ class BannerView { /// @brief Cleans up and deallocates any resources used by the @ref /// BannerView. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Destroy(); @@ -360,10 +361,10 @@ class BannerView { /// @brief Returns a @ref Future containing the status of the last call to /// @ref Destroy. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future DestroyLastResult() const; @@ -372,10 +373,10 @@ class BannerView { /// @brief Moves the @ref BannerView so that its top-left corner is located at /// (x, y). Coordinates are in pixels from the top-left corner of the screen. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @param[in] x The desired horizontal coordinate. @@ -386,10 +387,10 @@ class BannerView { /// @brief Moves the @ref BannerView so that it's located at the given /// pre-defined position. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @param[in] position The pre-defined position to which to move the @@ -400,10 +401,10 @@ class BannerView { /// @brief Returns a @ref Future containing the status of the last call to /// either version of @ref MoveTo. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future MoveToLastResult() const; @@ -411,10 +412,10 @@ class BannerView { /// @deprecated /// @brief Returns the current presentation state of the @ref BannerView. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @return The current presentation state. @@ -423,10 +424,10 @@ class BannerView { /// @deprecated /// @brief Retrieves the @ref BannerView's current onscreen size and location. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED BoundingBox bounding_box() const; @@ -434,10 +435,10 @@ class BannerView { /// @deprecated /// @brief Sets the @ref Listener for this object. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @param[in] listener A valid BannerView::Listener to receive callbacks. diff --git a/admob/src/include/firebase/admob/interstitial_ad.h b/admob/src/include/firebase/admob/interstitial_ad.h index 1f9111da1b..39399b711e 100644 --- a/admob/src/include/firebase/admob/interstitial_ad.h +++ b/admob/src/include/firebase/admob/interstitial_ad.h @@ -32,6 +32,13 @@ class InterstitialAdInternal; /// @deprecated /// @brief Loads and displays AdMob interstitial ads. /// +/// The functionality in the firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration +/// guide. +/// /// @ref InterstitialAd is a single-use object that can load and show a /// single AdMob interstitial ad. /// @@ -76,12 +83,6 @@ class InterstitialAdInternal; /// } /// @endcode /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our migration -/// guide. class InterstitialAd { public: #ifdef INTERNAL_EXPERIMENTAL @@ -90,10 +91,10 @@ class InterstitialAd { /// @deprecated /// @brief The presentation states of an @ref InterstitialAd. /// - /// Deprecated. The functionality in the - /// firebase::admob namespace has been replaced by the Google - /// Mobile Ads SDK in the firebase::gma namespace. Learn how - /// to transition to the new SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. enum PresentationState { @@ -113,25 +114,26 @@ class InterstitialAd { /// @ref InterstitialAd object's @ref SetListener method to be notified of /// presentation state changes. /// + /// The functionality in the firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration + /// guide. + /// /// This is useful for changes caused by user interaction, such as when the /// user closes an interstitial. /// - /// Deprecated. The functionality in the - /// firebase::admob namespace has been replaced by the Google - /// Mobile Ads SDK in the firebase::gma namespace. Learn how - /// to transition to the new SDK in our migration - /// guide. class Listener { public: /// @deprecated /// @brief This method is called when the @ref InterstitialAd object's /// presentation state changes. /// - /// Deprecated. The functionality in the - /// firebase::admob namespace has been replaced by the Google - /// Mobile Ads SDK in the firebase::gma namespace. Learn how - /// to transition to the new SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @param[in] interstitial_ad The interstitial ad whose presentation state @@ -146,10 +148,10 @@ class InterstitialAd { /// @brief Creates an uninitialized @ref InterstitialAd object. /// @ref Initialize must be called before the object is used. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED InterstitialAd(); @@ -159,10 +161,10 @@ class InterstitialAd { /// @deprecated /// @brief Initialize the @ref InterstitialAd object. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @param[in] parent The platform-specific UI element that will host the ad. @@ -174,10 +176,10 @@ class InterstitialAd { /// @brief Returns a @ref Future containing the status of the last call to /// @ref Initialize. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future InitializeLastResult() const; @@ -188,10 +190,10 @@ class InterstitialAd { /// The @ref InterstitialAd::presentation_state method can be used to track /// the progress of the request. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @param[in] request An AdRequest struct with information about the request @@ -202,10 +204,10 @@ class InterstitialAd { /// @brief Returns a @ref Future containing the status of the last call to /// @ref LoadAd. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future LoadAdLastResult() const; @@ -214,10 +216,10 @@ class InterstitialAd { /// @brief Shows the @ref InterstitialAd. This should not be called unless an /// ad has already been loaded. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Show(); @@ -226,10 +228,10 @@ class InterstitialAd { /// @brief Returns a @ref Future containing the status of the last call to /// @ref Show. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future ShowLastResult() const; @@ -237,10 +239,10 @@ class InterstitialAd { /// @deprecated /// @brief Returns the current presentation state of the @ref InterstitialAd. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @return The current presentation state. @@ -249,10 +251,10 @@ class InterstitialAd { /// @deprecated /// @brief Sets the @ref Listener for this @ref InterstitialAd. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @param[in] listener A valid InterstititalAd::Listener to receive diff --git a/admob/src/include/firebase/admob/native_express_ad_view.h b/admob/src/include/firebase/admob/native_express_ad_view.h index 7d8c4c9772..01f934cfbb 100644 --- a/admob/src/include/firebase/admob/native_express_ad_view.h +++ b/admob/src/include/firebase/admob/native_express_ad_view.h @@ -32,6 +32,13 @@ class NativeExpressAdViewInternal; /// @deprecated /// @brief Loads and displays ads from AdMob Native Ads Express. /// +/// The functionality in the firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration +/// guide. +/// /// Each NativeExpressAdView object corresponds to a single AdMob Native Express /// ad placement. There are methods to load an ad, move it, show it and hide it, /// and retrieve the bounds of the ad onscreen. @@ -69,13 +76,6 @@ class NativeExpressAdViewInternal; /// ad_view->LoadAd(your_ad_request); /// } /// @endcode -/// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our migration -/// guide. class NativeExpressAdView { public: #ifdef INTERNAL_EXPERIMENTAL @@ -84,10 +84,10 @@ class NativeExpressAdView { /// @deprecated /// @brief The presentation state of a @ref NativeExpressAdView. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. enum PresentationState { @@ -115,10 +115,10 @@ class NativeExpressAdView { /// @deprecated /// @brief The possible screen positions for a @ref NativeExpressAdView. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. enum Position { @@ -144,10 +144,10 @@ class NativeExpressAdView { /// @ref NativeExpressAdView object's @ref SetListener method to be notified /// of changes to the presentation state and bounding box. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. class Listener { @@ -156,10 +156,10 @@ class NativeExpressAdView { /// @brief This method is called when the @ref NativeExpressAdView object's /// presentation state changes. /// - /// Deprecated. The functionality in the - /// firebase::admob namespace has been replaced by the Google - /// Mobile Ads SDK in the firebase::gma namespace. Learn how - /// to transition to the new SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @param[in] ad_view The native express ad view whose presentation state @@ -172,10 +172,10 @@ class NativeExpressAdView { /// @brief This method is called when the @ref NativeExpressAdView object's /// bounding box changes. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @param[in] ad_view The native express ad view whose bounding box @@ -190,14 +190,14 @@ class NativeExpressAdView { /// @deprecated /// @brief Creates an uninitialized @ref NativeExpressAdView object. /// - /// @ref Initialize must be called before the object is used. - /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. + /// + /// @ref Initialize must be called before the object is used. FIREBASE_DEPRECATED NativeExpressAdView(); ~NativeExpressAdView(); @@ -205,10 +205,10 @@ class NativeExpressAdView { /// @deprecated /// @brief Initializes the @ref NativeExpressAdView object. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @param[in] parent The platform-specific UI element that will host the ad. @@ -222,10 +222,10 @@ class NativeExpressAdView { /// @brief Returns a @ref Future that has the status of the last call to /// @ref Initialize. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future InitializeLastResult() const; @@ -234,10 +234,10 @@ class NativeExpressAdView { /// @brief Begins an asynchronous request for an ad. If successful, the ad /// will automatically be displayed in the NativeExpressAdView. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @param[in] request An AdRequest struct with information about the request @@ -248,10 +248,10 @@ class NativeExpressAdView { /// @brief Returns a @ref Future containing the status of the last call to /// @ref LoadAd. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future LoadAdLastResult() const; @@ -259,10 +259,10 @@ class NativeExpressAdView { /// @deprecated /// @brief Hides the NativeExpressAdView. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Hide(); @@ -271,10 +271,10 @@ class NativeExpressAdView { /// @brief Returns a @ref Future containing the status of the last call to /// @ref Hide. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future HideLastResult() const; @@ -282,10 +282,10 @@ class NativeExpressAdView { /// @deprecated /// @brief Shows the @ref NativeExpressAdView. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Show(); @@ -294,10 +294,10 @@ class NativeExpressAdView { /// @brief Returns a @ref Future containing the status of the last call to /// @ref Show. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future ShowLastResult() const; @@ -305,25 +305,25 @@ class NativeExpressAdView { /// @deprecated /// @brief Pauses the @ref NativeExpressAdView. /// - /// Should be called whenever the C++ engine pauses or the application loses - /// focus. - /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. + /// + /// Should be called whenever the C++ engine pauses or the application loses + /// focus. FIREBASE_DEPRECATED Future Pause(); /// @deprecated /// @brief Returns a @ref Future containing the status of the last call to /// @ref Pause. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future PauseLastResult() const; @@ -331,10 +331,10 @@ class NativeExpressAdView { /// @deprecated /// @brief Resumes the @ref NativeExpressAdView after pausing. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Resume(); @@ -343,10 +343,10 @@ class NativeExpressAdView { /// @brief Returns a @ref Future containing the status of the last call to /// @ref Resume. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future ResumeLastResult() const; @@ -355,10 +355,10 @@ class NativeExpressAdView { /// @brief Cleans up and deallocates any resources used by the /// @ref NativeExpressAdView. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Destroy(); @@ -367,10 +367,10 @@ class NativeExpressAdView { /// @brief Returns a @ref Future containing the status of the last call to /// @ref Destroy. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future DestroyLastResult() const; @@ -380,17 +380,17 @@ class NativeExpressAdView { /// located at (x, y). Coordinates are in pixels from the top-left corner of /// the screen. /// + /// The functionality in the firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration + /// guide. + /// /// When built for Android, the library will not display an ad on top of or /// beneath an Activity's status bar. If a call to MoveTo would result in an /// overlap, the @ref NativeExpressAdView is placed just below the status bar, /// so no overlap occurs. - /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our migration - /// guide. /// @param[in] x The desired horizontal coordinate. /// @param[in] y The desired vertical coordinate. FIREBASE_DEPRECATED Future MoveTo(int x, int y); @@ -399,10 +399,10 @@ class NativeExpressAdView { /// @brief Moves the @ref NativeExpressAdView so that it's located at the /// given pre-defined position. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @param[in] position The pre-defined position to which to move the @@ -413,10 +413,10 @@ class NativeExpressAdView { /// @brief Returns a @ref Future containing the status of the last call to /// either version of @ref MoveTo. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future MoveToLastResult() const; @@ -425,10 +425,10 @@ class NativeExpressAdView { /// @brief Returns the current presentation state of the /// @ref NativeExpressAdView. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @return The current presentation state. @@ -438,10 +438,10 @@ class NativeExpressAdView { /// @brief Retrieves the @ref NativeExpressAdView's current onscreen size and /// location. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @return The current size and location. Values are in pixels, and location @@ -451,10 +451,10 @@ class NativeExpressAdView { /// @deprecated /// @brief Sets the @ref Listener for this object. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @param[in] listener A valid NativeExpressAdView::Listener to receive diff --git a/admob/src/include/firebase/admob/rewarded_video.h b/admob/src/include/firebase/admob/rewarded_video.h index ae6e9e31df..7c1ba4a3dd 100644 --- a/admob/src/include/firebase/admob/rewarded_video.h +++ b/admob/src/include/firebase/admob/rewarded_video.h @@ -33,6 +33,13 @@ namespace admob { /// @deprecated /// @brief Loads and displays rewarded video ads via AdMob mediation. /// +/// The functionality in the firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration +/// guide. +/// /// The rewarded_video namespace contains methods to load and display rewarded /// video ads via the Google Mobile Ads SDK. The underlying SDK objects for /// rewarded video on Android and iOS are singletons, so there are no objects @@ -91,13 +98,6 @@ namespace admob { /// firebase::admob::rewarded_video::Show(my_ad_parent); /// } /// @endcode -/// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our migration -/// guide. namespace rewarded_video { #ifdef INTERNAL_EXPERIMENTAL // LINT.IfChange @@ -105,10 +105,10 @@ namespace rewarded_video { /// @deprecated /// @brief The possible presentation states for rewarded video. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. enum PresentationState { @@ -133,10 +133,10 @@ enum PresentationState { /// @brief A reward to be given to the user in exchange for watching a rewarded /// video ad. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. struct RewardItem { @@ -150,10 +150,10 @@ struct RewardItem { /// @brief A listener class that developers can extend and pass to @ref /// SetListener to be notified of rewards and changes to the presentation state. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. class Listener { @@ -161,10 +161,10 @@ class Listener { /// @deprecated /// @brief Invoked when the user should be given a reward for watching an ad. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @param[in] reward The user's reward. @@ -173,10 +173,10 @@ class Listener { /// @deprecated /// @brief Invoked when the presentation state of the ad changes. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. /// @param[in] state The new presentation state. @@ -190,26 +190,26 @@ class Listener { /// @brief A polling-based listener that developers can instantiate and pass to /// @ref SetListener in order to queue rewards for later retrieval. /// +/// The functionality in the firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration +/// guide. +/// /// The @ref PollReward method should be used to retrieve awards granted by the /// Mobile Ads SDK and queued by this class. /// @ref rewarded_video::presentation_state can be used to poll the current /// presentation state, so no additional method has been added for it. -/// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our migration -/// guide. class PollableRewardListener : public Listener { public: /// @deprecated /// @brief Default constructor. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED PollableRewardListener(); @@ -229,10 +229,10 @@ class PollableRewardListener : public Listener { /// @deprecated /// @brief nvoked when the presentation state of the ad changes. /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED void OnPresentationStateChanged(PresentationState state); @@ -241,14 +241,14 @@ class PollableRewardListener : public Listener { /// @brief Pop the oldest queued reward, and copy its data into the provided /// RewardItem. /// - /// If no reward is available, the struct is unchanged. - /// - /// Deprecated. The functionality in the firebase::admob - /// namespace has been replaced by the Google Mobile Ads SDK in the - /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our firebase::admob namespace has + /// been replaced by the Google Mobile Ads SDK in the + /// firebase::gma namespace. Learn how to transition to the + /// new SDK in our migration /// guide. + /// + /// If no reward is available, the struct is unchanged. /// @param reward Pointer to a struct that reward data can be copied into. /// @returns true if a reward was popped and data was copied, false otherwise. FIREBASE_DEPRECATED bool PollReward(RewardItem* reward); @@ -264,10 +264,10 @@ class PollableRewardListener : public Listener { /// @brief Initializes rewarded video. This must be the first method invoked in /// this namespace. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Initialize(); @@ -276,10 +276,10 @@ FIREBASE_DEPRECATED Future Initialize(); /// @brief Returns a @ref Future that has the status of the last call to /// @ref Initialize. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future InitializeLastResult(); @@ -287,10 +287,10 @@ FIREBASE_DEPRECATED Future InitializeLastResult(); /// @deprecated /// @brief Begins an asynchronous request for an ad. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. /// @param[in] ad_unit_id The ad unit ID to use in the request. @@ -303,10 +303,10 @@ FIREBASE_DEPRECATED Future LoadAd(const char* ad_unit_id, /// @brief Returns a @ref Future containing the status of the last call to /// @ref LoadAd. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future LoadAdLastResult(); @@ -314,14 +314,14 @@ FIREBASE_DEPRECATED Future LoadAdLastResult(); /// @deprecated /// @brief Shows an ad, assuming one has loaded. /// -/// @ref LoadAd must be called before this method. -/// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. +/// +/// @ref LoadAd must be called before this method. /// @param[in] parent An @ref AdParent that is a reference to an iOS /// UIView or an Android Activity. FIREBASE_DEPRECATED Future Show(AdParent parent); @@ -341,25 +341,25 @@ FIREBASE_DEPRECATED Future ShowLastResult(); /// @deprecated /// @brief Pauses any background processing associated with rewarded video. /// -/// Should be called whenever the C++ engine pauses or the application loses -/// focus. -/// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. +/// +/// Should be called whenever the C++ engine pauses or the application loses +/// focus. FIREBASE_DEPRECATED Future Pause(); /// @deprecated /// @brief Returns a @ref Future containing the status of the last call to /// @ref Pause. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future PauseLastResult(); @@ -367,10 +367,10 @@ FIREBASE_DEPRECATED Future PauseLastResult(); /// @deprecated /// @brief Resumes the rewarded video system after pausing. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Resume(); @@ -379,10 +379,10 @@ FIREBASE_DEPRECATED Future Resume(); /// @brief Returns a @ref Future containing the status of the last call to /// @ref Resume. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future ResumeLastResult(); @@ -390,25 +390,25 @@ FIREBASE_DEPRECATED Future ResumeLastResult(); /// @deprecated /// @brief Cleans up and deallocates any resources used by rewarded video. /// -/// No other methods in rewarded_video should be called once this method has -/// been invoked. The system is closed for business at that point. -/// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. +/// +/// No other methods in rewarded_video should be called once this method has +/// been invoked. The system is closed for business at that point. FIREBASE_DEPRECATED void Destroy(); /// @deprecated /// @brief Returns the current presentation state, indicating if an ad is /// visible or if a video has started playing. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. /// @return The current presentation state. @@ -417,10 +417,10 @@ FIREBASE_DEPRECATED PresentationState presentation_state(); /// @deprecated /// @brief Sets the @ref Listener that should receive callbacks. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. /// @param[in] listener A valid Listener. diff --git a/admob/src/include/firebase/admob/types.h b/admob/src/include/firebase/admob/types.h index c477b7df4c..f5769d8760 100644 --- a/admob/src/include/firebase/admob/types.h +++ b/admob/src/include/firebase/admob/types.h @@ -35,19 +35,19 @@ namespace admob { /// @brief This is a platform specific datatype that is required to create an /// AdMob ad. /// +/// The functionality in the firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration +/// guide. +/// /// The following defines the datatype on each platform: ///
    ///
  • Android: A `jobject` which references an Android Activity.
    • ///
  • iOS: An `id` which references an iOS UIView.
    • ///
/// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our migration -/// guide. -/// #if FIREBASE_PLATFORM_ANDROID /// An Android Activity from Java. typedef jobject AdParent; @@ -66,10 +66,10 @@ typedef void *AdParent; /// @deprecated /// @brief Error codes returned by Future::error(). /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. enum AdMobError { @@ -102,10 +102,10 @@ enum AdMobError { /// @deprecated /// @brief Types of ad sizes. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. enum AdSizeType { kAdSizeStandard = 0 }; @@ -113,10 +113,10 @@ enum AdSizeType { kAdSizeStandard = 0 }; /// @deprecated /// @brief An ad size value to be used in requesting ads. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. struct AdSize { @@ -132,10 +132,10 @@ struct AdSize { /// @brief Gender information used as part of the /// @ref firebase::admob::AdRequest struct. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. enum Gender { @@ -151,10 +151,10 @@ enum Gender { /// @brief Indicates whether an ad request is considered tagged for /// child-directed treatment. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. enum ChildDirectedTreatmentState { @@ -170,10 +170,10 @@ enum ChildDirectedTreatmentState { /// @brief Generic Key-Value container used for the "extras" values in an /// @ref firebase::admob::AdRequest. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. struct KeyValuePair { @@ -186,10 +186,10 @@ struct KeyValuePair { /// @deprecated /// @brief The information needed to request an ad. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. struct AdRequest { @@ -229,10 +229,10 @@ struct AdRequest { /// @brief The screen location and dimensions of an ad view once it has been /// initialized. /// -/// Deprecated. The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the new -/// SDK in our firebase::admob namespace has +/// been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the +/// new SDK in our migration /// guide. struct BoundingBox { From 830c038575905017e3f5e9ab244c7a8983b321cc Mon Sep 17 00:00:00 2001 From: DellaBitta Date: Thu, 12 May 2022 11:40:34 -0400 Subject: [PATCH 5/6] Updated readme.md --- release_build_files/readme.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/release_build_files/readme.md b/release_build_files/readme.md index 11f4121073..b43cd41b5c 100644 --- a/release_build_files/readme.md +++ b/release_build_files/readme.md @@ -572,6 +572,12 @@ workflow use only during the development of your app, not for publicly shipping code. ## Release Notes +### Upcoming Release +- Changes + - AdMob: The AdMob SDK has been deprecated. Please update your app to + use the new Google Mobile Ads SDK which facilitates similar + functionality. + ### 9.0.0 - Changes - General (iOS): Firebase C++ on iOS is now built using Xcode 13.3.1. From bb94153c42e8b01bd093a5fc4301d83308d6bb17 Mon Sep 17 00:00:00 2001 From: "drsanta@google.com" Date: Mon, 16 May 2022 11:16:56 -0400 Subject: [PATCH 6/6] update relative path to migration guide. pushed up dep notice on classes --- admob/src/include/firebase/admob.h | 34 +++---- .../src/include/firebase/admob/banner_view.h | 91 +++++++------------ .../include/firebase/admob/interstitial_ad.h | 48 ++++------ .../firebase/admob/native_express_ad_view.h | 91 +++++++------------ .../include/firebase/admob/rewarded_video.h | 82 ++++++----------- admob/src/include/firebase/admob/types.h | 40 +++----- 6 files changed, 135 insertions(+), 251 deletions(-) diff --git a/admob/src/include/firebase/admob.h b/admob/src/include/firebase/admob.h index 8c395df9c1..957c86b7e1 100644 --- a/admob/src/include/firebase/admob.h +++ b/admob/src/include/firebase/admob.h @@ -36,15 +36,12 @@ FIREBASE_APP_REGISTER_CALLBACKS_REFERENCE(admob) namespace firebase { -/// @deprecated -/// @brief API for AdMob with Firebase. +/// @deprecated The functionality in the firebase::admob namespace +/// has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration guide. /// -/// The functionality in the firebase::admob namespace has -/// been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration -/// guide. +/// @brief API for AdMob with Firebase. /// /// 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. @@ -56,8 +53,7 @@ namespace admob { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. /// /// @param app The Firebase app for which to initialize mobile ads. @@ -74,8 +70,7 @@ FIREBASE_DEPRECATED InitResult Initialize(const ::firebase::App& app); /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. /// /// Initializing the Google Mobile Ads SDK with the AdMob app ID at app launch @@ -104,8 +99,7 @@ FIREBASE_DEPRECATED InitResult Initialize(const ::firebase::App& app, /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. /// /// The arguments to @ref Initialize are platform-specific so the caller must do @@ -133,8 +127,7 @@ FIREBASE_DEPRECATED InitResult Initialize(JNIEnv* jni_env, jobject activity); /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. /// /// Initializing the Google Mobile Ads SDK with the AdMob app ID at app launch @@ -174,8 +167,7 @@ FIREBASE_DEPRECATED InitResult Initialize(JNIEnv* jni_env, jobject activity, /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. FIREBASE_DEPRECATED InitResult Initialize(); @@ -186,8 +178,7 @@ FIREBASE_DEPRECATED InitResult Initialize(); /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. /// /// Initializing the Google Mobile Ads SDK with the AdMob app ID at app launch @@ -211,8 +202,7 @@ FIREBASE_DEPRECATED InitResult Initialize(const char* admob_app_id); /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. /// /// Frees resources associated with AdMob that were allocated during diff --git a/admob/src/include/firebase/admob/banner_view.h b/admob/src/include/firebase/admob/banner_view.h index 94fde84c55..2d691f2d3a 100644 --- a/admob/src/include/firebase/admob/banner_view.h +++ b/admob/src/include/firebase/admob/banner_view.h @@ -29,15 +29,12 @@ namespace internal { class BannerViewInternal; } // namespace internal -/// @deprecated -/// @brief Loads and displays AdMob banner ads. -/// -/// The functionality in the firebase::admob -/// namespace has been replaced by the Google Mobile Ads SDK in the +/// @deprecated The functionality in the firebase::admob namespace +/// has been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the new -/// SDK in our migration -/// guide. +/// SDK in our migration guide. +/// +/// @brief Loads and displays AdMob banner ads. /// /// Each BannerView object corresponds to a single AdMob banner placement. There /// are methods to load an ad, move it, show it and hide it, and retrieve the @@ -88,8 +85,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. enum PresentationState { /// BannerView is currently hidden. @@ -118,8 +114,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. enum Position { /// Top of the screen, horizontally centered. @@ -147,8 +142,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. class Listener { public: @@ -159,8 +153,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// @param[in] banner_view The banner view whose presentation state changed. /// @param[in] state The new presentation state. @@ -173,8 +166,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// @param[in] banner_view The banner view whose bounding box changed. /// @param[in] box The new bounding box. @@ -189,8 +181,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// /// @ref Initialize must be called before the object is used. @@ -204,8 +195,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// @param[in] parent The platform-specific UI element that will host the ad. /// @param[in] ad_unit_id The ad unit ID to use when requesting ads. @@ -221,8 +211,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future InitializeLastResult() const; @@ -233,8 +222,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// @param[in] request An AdRequest struct with information about the request /// to be made (such as targeting info). @@ -247,8 +235,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future LoadAdLastResult() const; @@ -258,8 +245,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Hide(); @@ -270,8 +256,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future HideLastResult() const; @@ -281,8 +266,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Show(); @@ -293,8 +277,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future ShowLastResult() const; @@ -305,8 +288,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Pause(); @@ -317,8 +299,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future PauseLastResult() const; @@ -328,8 +309,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Resume(); @@ -340,8 +320,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future ResumeLastResult() const; @@ -352,8 +331,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Destroy(); @@ -364,8 +342,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future DestroyLastResult() const; @@ -376,8 +353,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// @param[in] x The desired horizontal coordinate. /// @param[in] y The desired vertical coordinate. @@ -390,8 +366,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// @param[in] position The pre-defined position to which to move the /// @ref BannerView. @@ -404,8 +379,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future MoveToLastResult() const; @@ -415,8 +389,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// @return The current presentation state. FIREBASE_DEPRECATED PresentationState presentation_state() const; @@ -427,8 +400,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED BoundingBox bounding_box() const; @@ -438,8 +410,7 @@ class BannerView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// @param[in] listener A valid BannerView::Listener to receive callbacks. FIREBASE_DEPRECATED void SetListener(Listener* listener); diff --git a/admob/src/include/firebase/admob/interstitial_ad.h b/admob/src/include/firebase/admob/interstitial_ad.h index 39399b711e..b201ab7c34 100644 --- a/admob/src/include/firebase/admob/interstitial_ad.h +++ b/admob/src/include/firebase/admob/interstitial_ad.h @@ -29,15 +29,12 @@ namespace internal { class InterstitialAdInternal; } // namespace internal -/// @deprecated -/// @brief Loads and displays AdMob interstitial ads. +/// @deprecated The functionality in the firebase::admob namespace +/// has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration guide. /// -/// The functionality in the firebase::admob namespace has -/// been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration -/// guide. +/// @brief Loads and displays AdMob interstitial ads. /// /// @ref InterstitialAd is a single-use object that can load and show a /// single AdMob interstitial ad. @@ -94,8 +91,7 @@ class InterstitialAd { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. enum PresentationState { /// InterstitialAd is not currently being shown. @@ -117,8 +113,7 @@ class InterstitialAd { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration + /// new SDK in our migration /// guide. /// @param[in] interstitial_ad The interstitial ad whose presentation state /// changed. @@ -151,8 +145,7 @@ class InterstitialAd { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED InterstitialAd(); @@ -164,8 +157,7 @@ class InterstitialAd { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// @param[in] parent The platform-specific UI element that will host the ad. /// @param[in] ad_unit_id The ad unit ID to use in loading the ad. @@ -180,7 +172,7 @@ class InterstitialAd { /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the /// new SDK in our migration + /// href="/docs/admob/cpp/admob-migration">migration /// guide. FIREBASE_DEPRECATED Future InitializeLastResult() const; @@ -193,8 +185,7 @@ class InterstitialAd { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// @param[in] request An AdRequest struct with information about the request /// to be made (such as targeting info). @@ -207,8 +198,7 @@ class InterstitialAd { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future LoadAdLastResult() const; @@ -219,8 +209,7 @@ class InterstitialAd { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Show(); @@ -231,8 +220,7 @@ class InterstitialAd { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future ShowLastResult() const; @@ -242,8 +230,7 @@ class InterstitialAd { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// @return The current presentation state. FIREBASE_DEPRECATED PresentationState presentation_state() const; @@ -254,8 +241,7 @@ class InterstitialAd { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// @param[in] listener A valid InterstititalAd::Listener to receive /// callbacks. diff --git a/admob/src/include/firebase/admob/native_express_ad_view.h b/admob/src/include/firebase/admob/native_express_ad_view.h index 01f934cfbb..7e57196782 100644 --- a/admob/src/include/firebase/admob/native_express_ad_view.h +++ b/admob/src/include/firebase/admob/native_express_ad_view.h @@ -29,15 +29,13 @@ namespace internal { class NativeExpressAdViewInternal; } // namespace internal -/// @deprecated -/// @brief Loads and displays ads from AdMob Native Ads Express. +/// @deprecated The functionality in the firebase::admob namespace +/// has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration guide. +/// Native Express Ads has been discontinued, and are no longer served. /// -/// The functionality in the firebase::admob namespace has -/// been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration -/// guide. +/// @brief Loads and displays ads from AdMob Native Ads Express. /// /// Each NativeExpressAdView object corresponds to a single AdMob Native Express /// ad placement. There are methods to load an ad, move it, show it and hide it, @@ -87,8 +85,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. enum PresentationState { /// NativeExpressAdView is currently hidden. @@ -118,8 +115,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. enum Position { /// Top of the screen, horizontally centered. @@ -147,8 +143,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. class Listener { public: @@ -159,8 +154,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// @param[in] ad_view The native express ad view whose presentation state /// changed. @@ -175,8 +169,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration + /// new SDK in our migration /// guide. /// /// @ref Initialize must be called before the object is used. @@ -208,8 +200,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// @param[in] parent The platform-specific UI element that will host the ad. /// @param[in] ad_unit_id The ad unit ID to use when requesting ads. @@ -225,8 +216,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future InitializeLastResult() const; @@ -237,8 +227,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// @param[in] request An AdRequest struct with information about the request /// to be made (such as targeting info). @@ -251,8 +240,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future LoadAdLastResult() const; @@ -262,8 +250,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Hide(); @@ -274,8 +261,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future HideLastResult() const; @@ -285,8 +271,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Show(); @@ -297,8 +282,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future ShowLastResult() const; @@ -308,8 +292,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// /// Should be called whenever the C++ engine pauses or the application loses @@ -323,8 +306,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future PauseLastResult() const; @@ -334,8 +316,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Resume(); @@ -346,8 +327,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future ResumeLastResult() const; @@ -358,8 +338,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Destroy(); @@ -370,8 +349,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future DestroyLastResult() const; @@ -383,8 +361,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// /// When built for Android, the library will not display an ad on top of or @@ -403,7 +380,7 @@ class NativeExpressAdView { /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the /// new SDK in our migration + /// href="/docs/admob/cpp/admob-migration">migration /// guide. /// @param[in] position The pre-defined position to which to move the /// @ref NativeExpressAdView. @@ -416,8 +393,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future MoveToLastResult() const; @@ -428,8 +404,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// @return The current presentation state. FIREBASE_DEPRECATED PresentationState GetPresentationState() const; @@ -441,8 +416,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// @return The current size and location. Values are in pixels, and location /// coordinates originate from the top-left corner of the screen. @@ -454,8 +428,7 @@ class NativeExpressAdView { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// @param[in] listener A valid NativeExpressAdView::Listener to receive /// callbacks. diff --git a/admob/src/include/firebase/admob/rewarded_video.h b/admob/src/include/firebase/admob/rewarded_video.h index 7c1ba4a3dd..32bea80b55 100644 --- a/admob/src/include/firebase/admob/rewarded_video.h +++ b/admob/src/include/firebase/admob/rewarded_video.h @@ -30,15 +30,12 @@ class Mutex; namespace admob { -/// @deprecated -/// @brief Loads and displays rewarded video ads via AdMob mediation. +/// @deprecated The functionality in the firebase::admob namespace +/// has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration guide. /// -/// The functionality in the firebase::admob namespace has -/// been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration -/// guide. +/// @brief Loads and displays rewarded video ads via AdMob mediation. /// /// The rewarded_video namespace contains methods to load and display rewarded /// video ads via the Google Mobile Ads SDK. The underlying SDK objects for @@ -108,8 +105,7 @@ namespace rewarded_video { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. enum PresentationState { /// No ad is currently being shown. @@ -136,8 +132,7 @@ enum PresentationState { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. struct RewardItem { /// The reward amount. @@ -153,8 +148,7 @@ struct RewardItem { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. class Listener { public: @@ -164,8 +158,7 @@ class Listener { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// @param[in] reward The user's reward. FIREBASE_DEPRECATED virtual void OnRewarded(RewardItem reward) = 0; @@ -176,8 +169,7 @@ class Listener { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// @param[in] state The new presentation state. FIREBASE_DEPRECATED virtual void OnPresentationStateChanged( @@ -193,8 +185,7 @@ class Listener { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. /// /// The @ref PollReward method should be used to retrieve awards granted by the @@ -209,8 +200,7 @@ class PollableRewardListener : public Listener { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED PollableRewardListener(); ~PollableRewardListener(); @@ -221,8 +211,7 @@ class PollableRewardListener : public Listener { /// Deprecated. The functionality in the firebase::admob /// namespace has been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the new - /// SDK in our migration + /// SDK in our migration /// guide. FIREBASE_DEPRECATED void OnRewarded(RewardItem reward); @@ -232,8 +221,7 @@ class PollableRewardListener : public Listener { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. FIREBASE_DEPRECATED void OnPresentationStateChanged(PresentationState state); @@ -244,8 +232,7 @@ class PollableRewardListener : public Listener { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the - /// new SDK in our migration + /// new SDK in our migration /// guide. /// /// If no reward is available, the struct is unchanged. @@ -267,8 +254,7 @@ class PollableRewardListener : public Listener { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Initialize(); @@ -279,8 +265,7 @@ FIREBASE_DEPRECATED Future Initialize(); /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future InitializeLastResult(); @@ -290,8 +275,7 @@ FIREBASE_DEPRECATED Future InitializeLastResult(); /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. /// @param[in] ad_unit_id The ad unit ID to use in the request. /// @param[in] request An AdRequest struct with information about the request @@ -306,8 +290,7 @@ FIREBASE_DEPRECATED Future LoadAd(const char* ad_unit_id, /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future LoadAdLastResult(); @@ -317,8 +300,7 @@ FIREBASE_DEPRECATED Future LoadAdLastResult(); /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. /// /// @ref LoadAd must be called before this method. @@ -333,8 +315,7 @@ FIREBASE_DEPRECATED Future Show(AdParent parent); /// Deprecated. The functionality in the firebase::admob /// namespace has been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the new -/// SDK in our migration +/// SDK in our migration /// guide. FIREBASE_DEPRECATED Future ShowLastResult(); @@ -344,8 +325,7 @@ FIREBASE_DEPRECATED Future ShowLastResult(); /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. /// /// Should be called whenever the C++ engine pauses or the application loses @@ -359,8 +339,7 @@ FIREBASE_DEPRECATED Future Pause(); /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future PauseLastResult(); @@ -370,8 +349,7 @@ FIREBASE_DEPRECATED Future PauseLastResult(); /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future Resume(); @@ -382,8 +360,7 @@ FIREBASE_DEPRECATED Future Resume(); /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. FIREBASE_DEPRECATED Future ResumeLastResult(); @@ -393,8 +370,7 @@ FIREBASE_DEPRECATED Future ResumeLastResult(); /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. /// /// No other methods in rewarded_video should be called once this method has @@ -408,8 +384,7 @@ FIREBASE_DEPRECATED void Destroy(); /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. /// @return The current presentation state. FIREBASE_DEPRECATED PresentationState presentation_state(); @@ -420,8 +395,7 @@ FIREBASE_DEPRECATED PresentationState presentation_state(); /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. /// @param[in] listener A valid Listener. FIREBASE_DEPRECATED void SetListener(Listener* listener); diff --git a/admob/src/include/firebase/admob/types.h b/admob/src/include/firebase/admob/types.h index f5769d8760..21a8379f2d 100644 --- a/admob/src/include/firebase/admob/types.h +++ b/admob/src/include/firebase/admob/types.h @@ -31,17 +31,14 @@ extern "C" { namespace firebase { namespace admob { -/// @deprecated +/// @deprecated The functionality in the firebase::admob namespace +/// has been replaced by the Google Mobile Ads SDK in the +/// firebase::gma namespace. Learn how to transition to the new +/// SDK in our migration guide. +/// /// @brief This is a platform specific datatype that is required to create an /// AdMob ad. /// -/// The functionality in the firebase::admob namespace has -/// been replaced by the Google Mobile Ads SDK in the -/// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration -/// guide. -/// /// The following defines the datatype on each platform: ///
    ///
  • Android: A `jobject` which references an Android Activity.
    • @@ -69,8 +66,7 @@ typedef void *AdParent; /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. enum AdMobError { /// Call completed successfully. @@ -105,8 +101,7 @@ enum AdMobError { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. enum AdSizeType { kAdSizeStandard = 0 }; @@ -116,8 +111,7 @@ enum AdSizeType { kAdSizeStandard = 0 }; /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. struct AdSize { /// The type of ad size. @@ -135,11 +129,11 @@ struct AdSize { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. enum Gender { - /// The gender of the current user is unknown or unspecified by the publisher. + /// The gender of the current user is unknown or unspecified by the + /// publisher. kGenderUnknown = 0, /// The current user is known to be male. kGenderMale, @@ -154,8 +148,7 @@ enum Gender { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. enum ChildDirectedTreatmentState { /// The child-directed status for the request is not indicated. @@ -173,8 +166,7 @@ enum ChildDirectedTreatmentState { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. struct KeyValuePair { /// The name for an "extra." @@ -189,8 +181,7 @@ struct KeyValuePair { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. struct AdRequest { /// An array of test device IDs specifying devices that test ads will be @@ -232,8 +223,7 @@ struct AdRequest { /// The functionality in the firebase::admob namespace has /// been replaced by the Google Mobile Ads SDK in the /// firebase::gma namespace. Learn how to transition to the -/// new SDK in our migration +/// new SDK in our migration /// guide. struct BoundingBox { /// Default constructor which initializes all member variables to 0.