Merge pull request #1104 from BranchMetrics/CORE-1768-ATT-opt-in-dialog-event

CORE-1768 att opt in dialog event

Author: echo-branch

Branch-SDK/Branch.h

@@ -683,6 +683,17 @@ typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
  */
 - (void)setAppClipAppGroup:(NSString *)appGroup;
 
+/**
+ Pass the AppTrackingTransparency authorization status to Branch to measure ATT prompt performance.
+ This method should be called from the callback of ATTrackingManager.requestTrackingAuthorization.
+ 
+ Note:
+ Before prompting the user, check that ATTrackingManager.trackingAuthorizationStatus is notDetermined.
+ Otherwise the prompt will not display and the completion will be called with current status.
+ This will inflate the number of OPT_IN and OPT_OUT events tracked by Branch.
+ */
+- (void)handleOptInStatus:(NSUInteger)status;
+
 /**
  Set time window for SKAdNetwork callouts.  By default, Branch limits calls to SKAdNetwork to within 24 hours after first install.
  

Branch-SDK/Branch.m

@@ -44,6 +44,7 @@
 #import "BNCSKAdNetwork.h"
 #import "BNCAppGroupsData.h"
 #import "BNCPartnerParameters.h"
+#import "BranchEvent.h"
 
 #if !TARGET_OS_TV
 #import "BNCUserAgentCollector.h"
@@ -969,6 +970,25 @@ - (void)setAppClipAppGroup:(NSString *)appGroup {
     [BNCAppGroupsData shared].appGroup = appGroup;
 }
 
+- (void)handleOptInStatus:(NSUInteger)status {
+    BranchEvent *event;
+    switch (status) {
+        case 2:
+            // denied
+            event = [BranchEvent standardEvent:BranchStandardEventOptOut];
+            break;
+        case 3:
+            // authorized
+            event = [BranchEvent standardEvent:BranchStandardEventOptIn];
+            break;
+        default:
+            break;
+    }
+    if (event) {
+        [event logEvent];
+    }
+}
+
 - (void)setSKAdNetworkCalloutMaxTimeSinceInstall:(NSTimeInterval)maxTimeInterval {
     [BNCSKAdNetwork sharedInstance].maxTimeSinceInstall = maxTimeInterval;
 }

Branch-SDK/BranchEvent.h

@@ -45,6 +45,8 @@ FOUNDATION_EXPORT BranchStandardEvent _Nonnull BranchStandardEventUnlockAchievem
 FOUNDATION_EXPORT BranchStandardEvent _Nonnull BranchStandardEventInvite;
 FOUNDATION_EXPORT BranchStandardEvent _Nonnull BranchStandardEventLogin;
 FOUNDATION_EXPORT BranchStandardEvent _Nonnull BranchStandardEventReserve;
+FOUNDATION_EXPORT BranchStandardEvent _Nonnull  BranchStandardEventOptIn;
+FOUNDATION_EXPORT BranchStandardEvent _Nonnull  BranchStandardEventOptOut;
 
 typedef NS_ENUM(NSInteger, BranchEventAdType) {
     BranchEventAdTypeNone,

Branch-SDK/BranchEvent.m

@@ -46,6 +46,8 @@
 BranchStandardEvent BranchStandardEventInvite                 = @"INVITE";
 BranchStandardEvent BranchStandardEventLogin                  = @"LOGIN";
 BranchStandardEvent BranchStandardEventReserve                = @"RESERVE";
+BranchStandardEvent BranchStandardEventOptIn                  = @"OPT_IN";
+BranchStandardEvent BranchStandardEventOptOut                 = @"OPT_OUT";
 
 @implementation BranchEventRequest
 
@@ -226,6 +228,8 @@ - (NSDictionary*) dictionary {
         BranchStandardEventStartTrial,
         BranchStandardEventClickAd,
         BranchStandardEventViewAd,
+        BranchStandardEventOptOut,
+        BranchStandardEventOptIn,
     ];
 }
 

Branch-TestBed/Branch-SDK-Tests/BranchEvent.Test.m

@@ -641,6 +641,50 @@ - (void)testCustomViewAdEvent {
     XCTAssert([request.serverURL.absoluteString containsString:@"branch.io/v2/event/standard"]);
 }
 
+- (void)testStandardOptInEvent {
+    BranchEvent *event = [BranchEvent standardEvent:BranchStandardEventOptIn];
+    
+    NSDictionary *eventDictionary = [event buildEventDictionary];
+    XCTAssertNotNil(eventDictionary);
+    XCTAssert([eventDictionary[@"name"] isEqualToString:@"OPT_IN"]);
+    
+    BranchEventRequest *request = [event buildRequestWithEventDictionary:eventDictionary];
+    XCTAssert([request.serverURL.absoluteString containsString:@"branch.io/v2/event/standard"]);
+}
+
+- (void)testCustomOptInEvent {
+    BranchEvent *event = [BranchEvent customEventWithName:@"OPT_IN"];
+    
+    NSDictionary *eventDictionary = [event buildEventDictionary];
+    XCTAssertNotNil(eventDictionary);
+    XCTAssert([eventDictionary[@"name"] isEqualToString:@"OPT_IN"]);
+    
+    BranchEventRequest *request = [event buildRequestWithEventDictionary:eventDictionary];
+    XCTAssert([request.serverURL.absoluteString containsString:@"branch.io/v2/event/standard"]);
+}
+
+- (void)testStandardOptOutEvent {
+    BranchEvent *event = [BranchEvent standardEvent:BranchStandardEventOptOut];
+    
+    NSDictionary *eventDictionary = [event buildEventDictionary];
+    XCTAssertNotNil(eventDictionary);
+    XCTAssert([eventDictionary[@"name"] isEqualToString:@"OPT_OUT"]);
+    
+    BranchEventRequest *request = [event buildRequestWithEventDictionary:eventDictionary];
+    XCTAssert([request.serverURL.absoluteString containsString:@"branch.io/v2/event/standard"]);
+}
+
+- (void)testCustomOptOutEvent {
+    BranchEvent *event = [BranchEvent customEventWithName:@"OPT_OUT"];
+    
+    NSDictionary *eventDictionary = [event buildEventDictionary];
+    XCTAssertNotNil(eventDictionary);
+    XCTAssert([eventDictionary[@"name"] isEqualToString:@"OPT_OUT"]);
+    
+    BranchEventRequest *request = [event buildRequestWithEventDictionary:eventDictionary];
+    XCTAssert([request.serverURL.absoluteString containsString:@"branch.io/v2/event/standard"]);
+}
+
 - (void)testJsonStringForAdTypeNone {
     BranchEvent *event = [BranchEvent standardEvent:BranchStandardEventViewAd];
     XCTAssertNil([event jsonStringForAdType:BranchEventAdTypeNone]);