feat: Support Google Consent (#26)

* feat: Support Google Consent
mparticle-integrations · Apr 2, 2024 · 78d898b · 78d898b
1 parent 47d37d1
commit 78d898b
Show file tree

Hide file tree

Showing 2 changed files with 97 additions and 2 deletions.
diff --git a/mParticle-Google-Analytics-Firebase-GA4.podspec b/mParticle-Google-Analytics-Firebase-GA4.podspec
@@ -19,13 +19,13 @@ Pod::Spec.new do |s|
     s.ios.dependency 'mParticle-Apple-SDK/mParticle', '~> 8.0'
     s.ios.frameworks = 'CoreTelephony', 'SystemConfiguration'
     s.libraries = 'z'
-    s.ios.dependency 'Firebase/Core', '~> 10.6'
+    s.ios.dependency 'Firebase/Core', '~> 10.23'
 
     s.tvos.deployment_target = "12.0"
     s.tvos.source_files      = 'mParticle-Google-Analytics-Firebase-GA4/*.{h,m,mm}'
     s.tvos.dependency 'mParticle-Apple-SDK/mParticle', '~> 8.0'
     s.tvos.frameworks = 'SystemConfiguration'
     s.libraries = 'z'
-    s.tvos.dependency 'Firebase/Core', '~> 10.6'
+    s.tvos.dependency 'Firebase/Core', '~> 10.23'
 
 end
diff --git a/mParticle-Google-Analytics-Firebase-GA4/MPKitFirebaseGA4Analytics.m b/mParticle-Google-Analytics-Firebase-GA4/MPKitFirebaseGA4Analytics.m
@@ -5,9 +5,11 @@
     #if __has_include(<FirebaseCore/FirebaseCore.h>)
         #import <FirebaseCore/FirebaseCore.h>
         #import <FirebaseAnalytics/FIRAnalytics.h>
+        #import <FirebaseAnalytics/FIRAnalytics+Consent.h>
     #else
         #import "FirebaseCore/FirebaseCore.h"
         #import "FirebaseAnalytics/FIRAnalytics.h"
+        #import "FirebaseAnalytics/FIRAnalytics+Consent.h"
     #endif
 #endif
 
@@ -42,6 +44,15 @@ @implementation MPKitFirebaseGA4Analytics
 static NSString *const instanceIdIntegrationKey = @"app_instance_id";
 static NSString *const invalidFirebaseKey = @"invalid_ga4_key";
 
+static NSString *const kMPFIRGA4AdStorageKey = @"ad_storage";
+static NSString *const kMPFIRGA4AdUserDataKey = @"ad_user_data";
+static NSString *const kMPFIRGA4AdPersonalizationKey = @"ad_personalization";
+static NSString *const kMPFIRGA4AnalyticsStorageKey = @"analytics_storage";
+static NSString *const kMPFIRGA4DefaultAdStorageKey = @"defaultAdStorageConsentSDK";
+static NSString *const kMPFIRGA4DefaultAdUserDataKey = @"defaultAdUserDataConsentSDK";
+static NSString *const kMPFIRGA4DefaultAdPersonalizationKey = @"defaultAdPersonalizationConsentSDK";
+static NSString *const kMPFIRGA4DefaultAnalyticsStorageKey = @"defaultAnalyticsStorageConsentSDK";
+
 // Following limits are based off Google Analytics 360 limits, docs here "https://support.google.com/analytics/answer/11202874?sjid=14644072134282618832-NA#limits"
 const NSInteger FIR_MAX_CHARACTERS_EVENT_NAME = 40;
 const NSInteger FIR_MAX_CHARACTERS_IDENTITY_NAME = 24;
@@ -87,6 +98,8 @@ - (MPKitExecStatus *)didFinishLaunchingWithConfiguration:(NSDictionary *)configu
 
         [self updateInstanceIDIntegration];
 
+        [self updateConsent];
+
         _started = YES;
 
         dispatch_async(dispatch_get_main_queue(), ^{
@@ -358,6 +371,88 @@ - (void)logUserAttributes:(NSDictionary<NSString *, id> *)userAttributes {
     }
 }
 
+- (MPKitExecStatus *)setConsentState:(nullable MPConsentState *)state {
+    [self updateConsent];
+
+    return [self execStatus:MPKitReturnCodeSuccess];
+}
+
+- (void)updateConsent {
+    FIRConsentStatus adStorageStatus;
+    FIRConsentStatus adUserDataStatus;
+    FIRConsentStatus analyticsStorageStatus;
+    FIRConsentStatus adPersonalizationStatus;
+
+    // Default Consent States
+    if (self.configuration[kMPFIRGA4DefaultAdStorageKey]) {
+        if ([self.configuration[kMPFIRGA4DefaultAdStorageKey] isEqual: @"Granted"]) {
+            adStorageStatus = FIRConsentStatusGranted;
+        } else if ([self.configuration[kMPFIRGA4DefaultAdStorageKey] isEqual: @"Denied"]) {
+            adStorageStatus = FIRConsentStatusDenied;
+        }
+    }
+    if (self.configuration[kMPFIRGA4DefaultAdUserDataKey]) {
+        if ([self.configuration[kMPFIRGA4DefaultAdUserDataKey] isEqual: @"Granted"]) {
+            adUserDataStatus = FIRConsentStatusGranted;
+        } else if ([self.configuration[kMPFIRGA4DefaultAdUserDataKey] isEqual: @"Denied"]) {
+            adUserDataStatus = FIRConsentStatusDenied;
+        }
+    }
+    if (self.configuration[kMPFIRGA4DefaultAnalyticsStorageKey]) {
+        if ([self.configuration[kMPFIRGA4DefaultAnalyticsStorageKey] isEqual: @"Granted"]) {
+            analyticsStorageStatus = FIRConsentStatusGranted;
+        } else if ([self.configuration[kMPFIRGA4DefaultAnalyticsStorageKey] isEqual: @"Denied"]) {
+            analyticsStorageStatus = FIRConsentStatusDenied;
+        }
+    }
+    if (self.configuration[kMPFIRGA4DefaultAdPersonalizationKey]) {
+        if ([self.configuration[kMPFIRGA4DefaultAdPersonalizationKey] isEqual: @"Granted"]) {
+            adPersonalizationStatus = FIRConsentStatusGranted;
+        } else if ([self.configuration[kMPFIRGA4DefaultAdPersonalizationKey] isEqual: @"Denied"]) {
+            adPersonalizationStatus = FIRConsentStatusDenied;
+        }
+    }
+
+    MParticleUser *currentUser = [[[MParticle sharedInstance] identity] currentUser];
+    NSDictionary<NSString *, MPGDPRConsent *> *userConsentMap = currentUser.consentState.gdprConsentState;
+
+    // Update from mParticle consent
+    if (self.configuration[kMPFIRGA4AdStorageKey] && userConsentMap[self.configuration[kMPFIRGA4AdStorageKey]]) {
+        MPGDPRConsent *consent = userConsentMap[self.configuration[kMPFIRGA4AdStorageKey]];
+        adStorageStatus = consent.consented ? FIRConsentStatusGranted : FIRConsentStatusDenied;
+    }
+    if (self.configuration[kMPFIRGA4AdUserDataKey] && userConsentMap[self.configuration[kMPFIRGA4AdUserDataKey]]) {
+        MPGDPRConsent *consent = userConsentMap[self.configuration[kMPFIRGA4AdUserDataKey]];
+        adUserDataStatus = consent.consented ? FIRConsentStatusGranted : FIRConsentStatusDenied;
+    }
+    if (self.configuration[kMPFIRGA4AnalyticsStorageKey] && userConsentMap[self.configuration[kMPFIRGA4AnalyticsStorageKey]]) {
+        MPGDPRConsent *consent = userConsentMap[self.configuration[kMPFIRGA4AnalyticsStorageKey]];
+        analyticsStorageStatus = consent.consented ? FIRConsentStatusGranted : FIRConsentStatusDenied;
+    }
+    if (self.configuration[kMPFIRGA4AdPersonalizationKey] && userConsentMap[self.configuration[kMPFIRGA4AdPersonalizationKey]]) {
+        MPGDPRConsent *consent = userConsentMap[self.configuration[kMPFIRGA4AdPersonalizationKey]];
+        adPersonalizationStatus = consent.consented ? FIRConsentStatusGranted : FIRConsentStatusDenied;
+    }
+
+    // Construct a dictionary of consents
+    NSMutableDictionary *uploadDict = [[NSMutableDictionary alloc] init];
+    if (adStorageStatus) {
+        uploadDict[FIRConsentTypeAdStorage] = adStorageStatus;
+    }
+    if (adUserDataStatus) {
+        uploadDict[FIRConsentTypeAdUserData] = adUserDataStatus;
+    }
+    if (analyticsStorageStatus) {
+        uploadDict[FIRConsentTypeAnalyticsStorage] = analyticsStorageStatus;
+    }
+    if (adPersonalizationStatus) {
+        uploadDict[FIRConsentTypeAdPersonalization] = adPersonalizationStatus;
+    }
+
+    // Update consent state with FIRAnalytics
+    [FIRAnalytics setConsent:uploadDict];
+}
+
 - (NSString *)getEventNameForCommerceEvent:(MPCommerceEvent *)commerceEvent parameters:(NSDictionary<NSString *, id> *)parameters {
     switch (commerceEvent.action) {
         case MPCommerceEventActionAddToCart: