Add new Analytics consent types (#1504)

* Add new Analytics consent types

* Formatting

* Fix typo

Author: a-maurice

analytics/integration_test/src/integration_test.cc

@@ -162,12 +162,20 @@ TEST_F(FirebaseAnalyticsTest, TestSetConsent) {
           {firebase::analytics::kConsentTypeAnalyticsStorage,
            firebase::analytics::kConsentStatusGranted},
           {firebase::analytics::kConsentTypeAdStorage,
+           firebase::analytics::kConsentStatusGranted},
+          {firebase::analytics::kConsentTypeAdUserData,
+           firebase::analytics::kConsentStatusGranted},
+          {firebase::analytics::kConsentTypeAdPersonalization,
            firebase::analytics::kConsentStatusGranted}};
   std::map<firebase::analytics::ConsentType, firebase::analytics::ConsentStatus>
       consent_settings_deny = {
           {firebase::analytics::kConsentTypeAnalyticsStorage,
            firebase::analytics::kConsentStatusDenied},
           {firebase::analytics::kConsentTypeAdStorage,
+           firebase::analytics::kConsentStatusDenied},
+          {firebase::analytics::kConsentTypeAdUserData,
+           firebase::analytics::kConsentStatusDenied},
+          {firebase::analytics::kConsentTypeAdPersonalization,
            firebase::analytics::kConsentStatusDenied}};
   std::map<firebase::analytics::ConsentType, firebase::analytics::ConsentStatus>
       consent_settings_empty;

analytics/src/analytics_android.cc

@@ -69,6 +69,12 @@ static const ::firebase::App* g_app = nullptr;
     "Lcom/google/firebase/analytics/FirebaseAnalytics$ConsentType;",          \
       util::kFieldTypeStatic),                                                \
   X(AdStorage, "AD_STORAGE",                                                  \
+    "Lcom/google/firebase/analytics/FirebaseAnalytics$ConsentType;",          \
+      util::kFieldTypeStatic),                                                \
+  X(AdUserData, "AD_USER_DATA",                                               \
+    "Lcom/google/firebase/analytics/FirebaseAnalytics$ConsentType;",          \
+      util::kFieldTypeStatic),                                                \
+  X(AdPersonalization, "AD_PERSONALIZATION",                                  \
     "Lcom/google/firebase/analytics/FirebaseAnalytics$ConsentType;",          \
       util::kFieldTypeStatic)
 
@@ -223,6 +229,30 @@ void SetConsent(const std::map<ConsentType, ConsentStatus>& consent_settings) {
           return;
         }
         break;
+      case kConsentTypeAdUserData:
+        consent_type =
+            env->GetStaticObjectField(analytics_consent_type::GetClass(),
+                                      analytics_consent_type::GetFieldId(
+                                          analytics_consent_type::kAdUserData));
+
+        if (util::LogException(env, kLogLevelError,
+                               "Failed to get ConsentTypeAdUserData")) {
+          env->DeleteLocalRef(consent_map);
+          return;
+        }
+        break;
+      case kConsentTypeAdPersonalization:
+        consent_type = env->GetStaticObjectField(
+            analytics_consent_type::GetClass(),
+            analytics_consent_type::GetFieldId(
+                analytics_consent_type::kAdPersonalization));
+
+        if (util::LogException(env, kLogLevelError,
+                               "Failed to get ConsentTypeAdPersonalization")) {
+          env->DeleteLocalRef(consent_map);
+          return;
+        }
+        break;
       default:
         LogError("Unknown ConsentType value: %d", it->first);
         env->DeleteLocalRef(consent_map);

analytics/src/analytics_ios.mm

@@ -164,6 +164,12 @@ void SetConsent(const std::map<ConsentType, ConsentStatus>& consent_settings) {
       case kConsentTypeAnalyticsStorage:
         consent_type = FIRConsentTypeAnalyticsStorage;
         break;
+      case kConsentTypeAdUserData:
+        consent_type = FIRConsentTypeAdUserData;
+        break;
+      case kConsentTypeAdPersonalization:
+        consent_type = FIRConsentTypeAdPersonalization;
+        break;
       default:
         LogError("Unknown ConsentType value: %d", it->first);
         return;

analytics/src/include/firebase/analytics.h

@@ -273,9 +273,14 @@ void SetAnalyticsCollectionEnabled(bool enabled);
 
 /// @brief The type of consent to set.
 ///
-/// Supported consent types are kConsentTypeAdStorage and
-/// kConsentTypeAnalyticsStorage. Omitting a type retains its previous status.
-enum ConsentType { kConsentTypeAdStorage = 0, kConsentTypeAnalyticsStorage };
+/// Supported consent types are mapped to coresponding constants in the Android
+/// and iOS SDKs. Omitting a type retains its previous status.
+enum ConsentType {
+  kConsentTypeAdStorage = 0,
+  kConsentTypeAnalyticsStorage,
+  kConsentTypeAdUserData,
+  kConsentTypeAdPersonalization
+};
 
 /// @brief The status value of the consent type.
 ///

release_build_files/readme.md

@@ -637,6 +637,7 @@ code.
       level 33 and Gradle 6.7.1.
     - General (Android): Update to Firebase Android BoM version 32.3.1.
     - General (iOS): Update to Firebase Cocoapods version 10.17.0.
+    - Analytics: Updated the consent management API to include new consent signals.
     - GMA (Android) Updated dependency to play-services-ads version 22.4.0.
 
 ### 11.6.0