Feature/admob 2021 Set|Get RequestConfiguration

Android/firebase_dependencies.gradle

@@ -17,8 +17,8 @@ import org.gradle.util.ConfigureUtil;
 // A map of library to the dependencies that need to be added for it.
 def firebaseDependenciesMap = [
   'app' : ['com.google.firebase:firebase-analytics:19.0.0'],
-  'admob' : ['com.google.firebase:firebase-ads:19.8.0',
-             'com.google.firebase:firebase-analytics:19.0.0',
+  'admob' : ['com.google.firebase:firebase-ads:20.1.0',
+             'com.google.android.gms:play-services-measurement-sdk-api:19.0.0',
              'com.google.android.gms:play-services-base:17.6.0'],
   'analytics' : ['com.google.firebase:firebase-analytics:19.0.0',
                  'com.google.android.gms:play-services-base:17.6.0'],

admob/CMakeLists.txt

@@ -20,11 +20,7 @@ set(common_SRCS
     src/common/banner_view.cc
     src/common/banner_view_internal.cc
     src/common/interstitial_ad.cc
-    src/common/interstitial_ad_internal.cc
-    src/common/native_express_ad_view.cc
-    src/common/native_express_ad_view_internal.cc
-    src/common/rewarded_video.cc
-    src/common/rewarded_video_internal.cc)
+    src/common/interstitial_ad_internal.cc)
 
 # Define the resource build needed for Android
 firebase_cpp_gradle(":admob:admob_resources:generateDexJarRelease"
@@ -40,22 +36,16 @@ set(android_SRCS
     src/android/ad_request_converter.cc
     src/android/admob_android.cc
     src/android/banner_view_internal_android.cc
-    src/android/interstitial_ad_internal_android.cc
-    src/android/native_express_ad_view_internal_android.cc
-    src/android/rewarded_video_internal_android.cc)
+    src/android/interstitial_ad_internal_android.cc)
 
 # Source files used by the iOS implementation.
 set(ios_SRCS
     src/ios/FADBannerView.mm
     src/ios/FADInterstitialDelegate.mm
-    src/ios/FADNativeExpressAdView.mm
     src/ios/FADRequest.mm
-    src/ios/FADRewardBasedVideoAdDelegate.mm
     src/ios/admob_ios.mm
     src/ios/banner_view_internal_ios.mm
-    src/ios/interstitial_ad_internal_ios.mm
-    src/ios/native_express_ad_view_internal_ios.mm
-    src/ios/rewarded_video_internal_ios.mm)
+    src/ios/interstitial_ad_internal_ios.mm)
 
 # Source files used by the stub implementation.
 set(stub_SRCS

admob/admob_resources/build.gradle

@@ -46,7 +46,7 @@ android {
 
 dependencies {
   implementation 'com.google.firebase:firebase-analytics:19.0.0'
-  implementation 'com.google.firebase:firebase-ads:19.8.0'
+  implementation 'com.google.firebase:firebase-ads:20.1.0'
 }
 
 afterEvaluate {

admob/integration_test/src/integration_test.cc

@@ -19,6 +19,7 @@
 #include <cstdlib>
 #include <cstring>
 #include <ctime>
+#include <vector>
 
 #include "app_framework.h"  // NOLINT
 #include "firebase/admob.h"
@@ -62,13 +63,15 @@ const char* kAdMobAppID = "ca-app-pub-3940256099942544~1458002511";
 #if defined(__ANDROID__)
 const char* kBannerAdUnit = "ca-app-pub-3940256099942544/6300978111";
 const char* kInterstitialAdUnit = "ca-app-pub-3940256099942544/1033173712";
-const char* kRewardedVideoAdUnit = "ca-app-pub-3940256099942544/5224354917";
 #else
 const char* kBannerAdUnit = "ca-app-pub-3940256099942544/2934735716";
 const char* kInterstitialAdUnit = "ca-app-pub-3940256099942544/4411468910";
-const char* kRewardedVideoAdUnit = "ca-app-pub-3940256099942544/1712485313";
 #endif
 
+// Sample test device IDs to use in making the request.
+const std::vector<std::string> kTestDeviceIDs = {
+    "2077ef9a63d2b398840261c8221a0c9b", "098fe087d987c9a878965454a65654d7"};
+
 using app_framework::LogDebug;
 using app_framework::ProcessEvents;
 
@@ -108,11 +111,11 @@ void FirebaseAdMobTest::SetUpTestSuite() {
   LogDebug("Initializing AdMob.");
 
   ::firebase::ModuleInitializer initializer;
-  initializer.Initialize(
-      shared_app_, nullptr, [](::firebase::App* app, void* /* userdata */) {
-        LogDebug("Try to initialize AdMob");
-        return ::firebase::admob::Initialize(*app, kAdMobAppID);
-      });
+  initializer.Initialize(shared_app_, nullptr,
+                         [](::firebase::App* app, void* /* userdata */) {
+                           LogDebug("Try to initialize AdMob");
+                           return ::firebase::admob::Initialize(*app);
+                         });
 
   WaitForCompletion(initializer.InitializeLastResult(), "Initialize");
 
@@ -139,39 +142,29 @@ FirebaseAdMobTest::FirebaseAdMobTest() {}
 
 FirebaseAdMobTest::~FirebaseAdMobTest() {}
 
-void FirebaseAdMobTest::SetUp() { FirebaseTest::SetUp(); }
+void FirebaseAdMobTest::SetUp() {
+  FirebaseTest::SetUp();
+
+  // This example uses ad units that are specially configured to return test ads
+  // for every request. When using your own ad unit IDs, however, it's important
+  // to register the device IDs associated with any devices that will be used to
+  // test the app. This ensures that regardless of the ad unit ID, those
+  // devices will always receive test ads in compliance with AdMob policy.
+  //
+  // Device IDs can be obtained by checking the logcat or the Xcode log while
+  // debugging. They appear as a long string of hex characters.
+  firebase::admob::RequestConfiguration request_configuration;
+  request_configuration.test_device_ids = kTestDeviceIDs;
+  firebase::admob::SetRequestConfiguration(request_configuration);
+}
 
 void FirebaseAdMobTest::TearDown() { FirebaseTest::TearDown(); }
 
 firebase::admob::AdRequest FirebaseAdMobTest::GetAdRequest() {
   // Sample keywords to use in making the request.
   static const char* kKeywords[] = {"AdMob", "C++", "Fun"};
 
-  // Sample birthday value to use in making the request.
-  static const int kBirthdayDay = 10;
-  static const int kBirthdayMonth = 11;
-  static const int kBirthdayYear = 1976;
-
-  // Sample test device IDs to use in making the request.
-  static const char* kTestDeviceIDs[] = {"2077ef9a63d2b398840261c8221a0c9b",
-                                         "098fe087d987c9a878965454a65654d7"};
-
   firebase::admob::AdRequest request;
-  // If the app is aware of the user's gender, it can be added to the targeting
-  // information. Otherwise, "unknown" should be used.
-  request.gender = firebase::admob::kGenderUnknown;
-
-  // This value allows publishers to specify whether they would like the request
-  // to be treated as child-directed for purposes of the Children’s Online
-  // Privacy Protection Act (COPPA).
-  // See http://business.ftc.gov/privacy-and-security/childrens-privacy.
-  request.tagged_for_child_directed_treatment =
-      firebase::admob::kChildDirectedTreatmentStateTagged;
-
-  // The user's birthday, if known. Note that months are indexed from one.
-  request.birthday_day = kBirthdayDay;
-  request.birthday_month = kBirthdayMonth;
-  request.birthday_year = kBirthdayYear;
 
   // Additional keywords to be used in targeting.
   request.keyword_count = sizeof(kKeywords) / sizeof(kKeywords[0]);
@@ -184,17 +177,6 @@ firebase::admob::AdRequest FirebaseAdMobTest::GetAdRequest() {
   request.extras_count = sizeof(kRequestExtras) / sizeof(kRequestExtras[0]);
   request.extras = kRequestExtras;
 
-  // This example uses ad units that are specially configured to return test ads
-  // for every request. When using your own ad unit IDs, however, it's important
-  // to register the device IDs associated with any devices that will be used to
-  // test the app. This ensures that regardless of the ad unit ID, those
-  // devices will always receive test ads in compliance with AdMob policy.
-  //
-  // Device IDs can be obtained by checking the logcat or the Xcode log while
-  // debugging. They appear as a long string of hex characters.
-  request.test_device_id_count =
-      sizeof(kTestDeviceIDs) / sizeof(kTestDeviceIDs[0]);
-  request.test_device_ids = kTestDeviceIDs;
   return request;
 }
 
@@ -219,6 +201,69 @@ class TestBannerViewListener : public firebase::admob::BannerView::Listener {
   std::vector<firebase::admob::BoundingBox> bounding_box_changes_;
 };
 
+TEST_F(FirebaseAdMobTest, TestQueryOfUnsetRequestConfiguration) {
+  firebase::admob::RequestConfiguration set_configuration;
+  firebase::admob::SetRequestConfiguration(set_configuration);
+  firebase::admob::RequestConfiguration retrieved_configuration =
+      firebase::admob::GetRequestConfiguration();
+
+  EXPECT_EQ(
+      retrieved_configuration.max_ad_content_rating,
+      firebase::admob::RequestConfiguration::kMaxAdContentRatingUnspecified);
+  EXPECT_EQ(retrieved_configuration.tag_for_child_directed_treatment,
+            firebase::admob::RequestConfiguration::
+                kChildDirectedTreatmentUnspecified);
+  EXPECT_EQ(
+      retrieved_configuration.tag_for_under_age_of_consent,
+      firebase::admob::RequestConfiguration::kUnderAgeOfConsentUnspecified);
+  EXPECT_EQ(retrieved_configuration.test_device_ids.size(), 0);
+}
+
+TEST_F(FirebaseAdMobTest, TestRequestConfigurationSetGet) {
+  SKIP_TEST_ON_DESKTOP;
+
+  firebase::admob::RequestConfiguration set_configuration;
+  set_configuration.max_ad_content_rating =
+      firebase::admob::RequestConfiguration::kMaxAdContentRatingPG;
+  set_configuration.tag_for_child_directed_treatment =
+      firebase::admob::RequestConfiguration::kChildDirectedTreatmentTrue;
+  set_configuration.tag_for_under_age_of_consent =
+      firebase::admob::RequestConfiguration::kUnderAgeOfConsentFalse;
+  set_configuration.test_device_ids.push_back("1");
+  set_configuration.test_device_ids.push_back("2");
+  set_configuration.test_device_ids.push_back("3");
+  firebase::admob::SetRequestConfiguration(set_configuration);
+
+  firebase::admob::RequestConfiguration retrieved_configuration =
+      firebase::admob::GetRequestConfiguration();
+
+  EXPECT_EQ(retrieved_configuration.max_ad_content_rating,
+            firebase::admob::RequestConfiguration::kMaxAdContentRatingPG);
+
+#if defined(__ANDROID__)
+  EXPECT_EQ(retrieved_configuration.tag_for_child_directed_treatment,
+            firebase::admob::RequestConfiguration::kChildDirectedTreatmentTrue);
+  EXPECT_EQ(retrieved_configuration.tag_for_under_age_of_consent,
+            firebase::admob::RequestConfiguration::kUnderAgeOfConsentFalse);
+#else  // iOS
+  // iOS doesn't allow for the querying of these values.
+  EXPECT_EQ(retrieved_configuration.tag_for_child_directed_treatment,
+            firebase::admob::RequestConfiguration::
+                kChildDirectedTreatmentUnspecified);
+  EXPECT_EQ(
+      retrieved_configuration.tag_for_under_age_of_consent,
+      firebase::admob::RequestConfiguration::kUnderAgeOfConsentUnspecified);
+#endif
+
+  EXPECT_EQ(retrieved_configuration.test_device_ids.size(), 3);
+  EXPECT_TRUE(std::count(retrieved_configuration.test_device_ids.begin(),
+                         retrieved_configuration.test_device_ids.end(), "1"));
+  EXPECT_TRUE(std::count(retrieved_configuration.test_device_ids.begin(),
+                         retrieved_configuration.test_device_ids.end(), "2"));
+  EXPECT_TRUE(std::count(retrieved_configuration.test_device_ids.begin(),
+                         retrieved_configuration.test_device_ids.end(), "3"));
+}
+
 TEST_F(FirebaseAdMobTest, TestBannerView) {
   // AdMob cannot be tested on Firebase Test Lab, so disable tests on FTL.
   TEST_REQUIRES_USER_INTERACTION;
@@ -332,8 +377,8 @@ TEST_F(FirebaseAdMobTest, TestBannerView) {
   WaitForCompletion(banner->Hide(), "Hide 2");
   expected_presentation_states.push_back(
       firebase::admob::BannerView::kPresentationStateHidden);
-
   delete banner;
+
   expected_presentation_states.push_back(
       firebase::admob::BannerView::kPresentationStateHidden);
   expected_num_bounding_box_changes++;
@@ -394,18 +439,20 @@ TEST_F(FirebaseAdMobTest, TestInterstitialAd) {
 
   firebase::admob::InterstitialAd* interstitial =
       new firebase::admob::InterstitialAd();
+
   WaitForCompletion(interstitial->Initialize(app_framework::GetWindowContext(),
                                              kInterstitialAdUnit),
                     "Initialize");
+
   TestInterstitialAdListener interstitial_listener;
   interstitial->SetListener(&interstitial_listener);
 
   firebase::admob::AdRequest request = GetAdRequest();
   // When the InterstitialAd is initialized, load an ad.
   WaitForCompletion(interstitial->LoadAd(request), "LoadAd");
+
   std::vector<firebase::admob::InterstitialAd::PresentationState>
       expected_presentation_states;
-
   WaitForCompletion(interstitial->Show(), "Show");
   expected_presentation_states.push_back(
       firebase::admob::InterstitialAd::PresentationState::
@@ -416,6 +463,7 @@ TEST_F(FirebaseAdMobTest, TestInterstitialAd) {
              kPresentationStateHidden) {
     app_framework::ProcessEvents(1000);
   }
+
   expected_presentation_states.push_back(
       firebase::admob::InterstitialAd::PresentationState::
           kPresentationStateHidden);
@@ -426,78 +474,6 @@ TEST_F(FirebaseAdMobTest, TestInterstitialAd) {
   delete interstitial;
 }
 
-// A simple listener to help test changes to rewarded video state.
-class TestRewardedVideoListener
-    : public firebase::admob::rewarded_video::Listener {
- public:
-  TestRewardedVideoListener() { got_reward_ = false; }
-  void OnRewarded(firebase::admob::rewarded_video::RewardItem reward) override {
-    got_reward_ = true;
-    reward_type_ = reward.reward_type;
-    reward_amount_ = reward.amount;
-  }
-  void OnPresentationStateChanged(
-      firebase::admob::rewarded_video::PresentationState state) override {
-    presentation_states_.push_back(state);
-  }
-  bool got_reward_;
-  std::string reward_type_;
-  float reward_amount_;
-  std::vector<firebase::admob::rewarded_video::PresentationState>
-      presentation_states_;
-};
-
-TEST_F(FirebaseAdMobTest, TestRewardedVideoAd) {
-  TEST_REQUIRES_USER_INTERACTION;
-
-  namespace rewarded_video = firebase::admob::rewarded_video;
-  WaitForCompletion(rewarded_video::Initialize(), "Initialize");
-
-  TestRewardedVideoListener rewarded_listener;
-  rewarded_video::SetListener(&rewarded_listener);
-
-  firebase::admob::AdRequest request = GetAdRequest();
-  WaitForCompletion(rewarded_video::LoadAd(kRewardedVideoAdUnit, request),
-                    "LoadAd");
-
-  std::vector<rewarded_video::PresentationState> expected_presentation_states;
-
-  WaitForCompletion(rewarded_video::Show(app_framework::GetWindowContext()),
-                    "Show");
-
-  expected_presentation_states.push_back(
-      rewarded_video::PresentationState::kPresentationStateCoveringUI);
-  expected_presentation_states.push_back(
-      rewarded_video::PresentationState::kPresentationStateVideoHasStarted);
-
-  // Wait a moment, then pause, then resume.
-  ProcessEvents(1000);
-  WaitForCompletion(rewarded_video::Pause(), "Pause");
-  ProcessEvents(1000);
-  WaitForCompletion(rewarded_video::Resume(), "Resume");
-
-#if defined(__ANDROID__) || TARGET_OS_IPHONE
-  // Wait for video to complete.
-  while (
-      rewarded_listener.presentation_states_.back() !=
-      rewarded_video::PresentationState::kPresentationStateVideoHasCompleted) {
-    ProcessEvents(1000);
-  }
-  expected_presentation_states.push_back(
-      rewarded_video::PresentationState::kPresentationStateVideoHasCompleted);
-
-  EXPECT_TRUE(rewarded_listener.got_reward_);
-  EXPECT_NE(rewarded_listener.reward_type_, "");
-  EXPECT_NE(rewarded_listener.reward_amount_, 0);
-  LogDebug("Got reward: %.02f %s", rewarded_listener.reward_amount_,
-           rewarded_listener.reward_type_.c_str());
-
-  EXPECT_EQ(rewarded_listener.presentation_states_,
-            expected_presentation_states);
-#endif
-  rewarded_video::Destroy();
-}
-
 #if defined(ANDROID) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
 // Test runs & compiles for phones only.