Merge pull request #1087 from segmentio/brie/ios14-integration-update

n2parko · web-flow · commit 087259442724 · 2020-09-03T16:45:32.000-07:00
Update docs for Adjust, AppsFlyer, and Braze for iOS14 support
diff --git a/src/connections/destinations/catalog/adjust/index.md b/src/connections/destinations/catalog/adjust/index.md
@@ -45,6 +45,40 @@ SEGAnalyticsConfiguration *config = [SEGAnalyticsConfiguration configurationWith
 
 In cases where the Adjust integration sometimes does not track the install attribution properly, you can configure a delay for the Adjust reporting to ensure all session parameters have been loaded properly. Segment allows you to configure this using our UI by enabling `setDelay` and providing a `delayTime` in seconds. Segment then calls the [Adjust iOS SDK's configuration](https://github.com/adjust/ios_sdk#delay-start) to set a delay. The maximum delay start time of the Adjust SDK is 10 seconds.
 
+#### Additional device-mode set up for iOS 14 support
+
+Segment’s Adjust SDK was updated to use Adjust version 4.23.0 to prepare for iOS 14. The updated Adjust SDK offers iOS14 support, AppTrackingTransparency (ATT) and SKAdNetwork dashboard features.
+
+See Adjust's [Steps to Support iOS 14 documentation](https://help.adjust.com/manage-data/data-privacy/ios-14-user-privacy-frameworks#Steps-to-support-iOS-14) for more information.
+
+To use the latest Adjust SDK to collect IDFAs you must do the following:
+
+1. Upgrade to use Xcode12.
+2. Update your Segment Adjust SDK to version 3.0.0 or later.
+   The latest SDK has integrated support for the SKAdNetwork, which is enabled by default. For access to the SKAdNetwork, make sure your ad networks are registered with Apple. Adjust automatically registers for SKAdNetwork attribution on SDK initialization, and can handle the conversion value update. You can choose to disable this by calling `[adjustConfig deactivateSKAdNetworkHandling];` on the config object in your `AppDelegate.m` file.
+3. Import and implement the AppTrackingTransparency (ATT) Framework.
+   Navigate to your project `Info.plist` and add a “Privacy - Tracking Usage Description”. This description appears in a popup when the application initializes in iOS 14. Users are prompted to indicate whether or not they want to allow tracking.
+4. Launch an opt-in popup using Adjust’s SDK wrapper, built on top of `requestTrackingAuthorizationWithCompletionHandler` for the ATT Framework. An iOS pop-up launches when the wrapper is called the first time. When it is called again, the wrapper retrieves the tracking authorization status, which is sent to the Adjust backend. Adjust relays the information directly to you. The example below shows how to use this wrapper.
+
+   ```swift
+   [Adjust requestTrackingAuthorizationWithCompletionHandler:^(NSUInteger status) {
+       switch (status) {
+           case 0:
+               // ATTrackingManagerAuthorizationStatusNotDetermined case
+               break;
+           case 1:
+               // ATTrackingManagerAuthorizationStatusRestricted case
+               break;
+           case 2:
+               // ATTrackingManagerAuthorizationStatusDenied case
+               break;
+           case 3:
+               // ATTrackingManagerAuthorizationStatusAuthorized case
+               break;
+     }];
+   ```
+
+5. Follow [Segment's guide for collecting IDFA](https://segment.com/docs/connections/sources/catalog/libraries/mobile/ios/#idfa-collection-in-40-beta-and-later)
 
 ### Android
 
diff --git a/src/connections/destinations/catalog/appsflyer/index.md b/src/connections/destinations/catalog/appsflyer/index.md
@@ -18,19 +18,47 @@ This document was last updated on April 27, 2018. If you notice any gaps, outdat
 
 **Important:** If you plan on using the server-side destination for an Android project, make sure to enter your **Android App ID**. If you are using only the mobile SDK, Android projects only require the **AppsFlyer Dev Key**. iOS projects always require both the **AppsFlyer Dev Key** and the **Apple App ID**. Also, note that if you do use the server-side destination, you will not be able to selectively disable calls sent to AppsFlyer using your Segment dashboard.
 
+#### Additional device-mode set up for iOS 14 support
+
+Segment’s AppsFlyer iOS SDK was updated to use AppsFlyer version 6.0 beta to prepare for iOS 14. The SDK beta is compatible with the beta version of iOS 14, and supports AppsFlyer's aggregate attribution, and Apple's AppTrackingTransperancy framework, and more. See [the AppsFlyer blog post](https://www.appsflyer.com/blog/privacy-centric-attribution-ios14/] about AppsFlyer's new privacy-centric attribution model.
+
+To use the latest AppsFlyer SDK to collect IDFAs you must do the following:
+
+1. Upgrade to use Xcode12.
+2. Update your Segment AppsFlyer SDK to version 6.0.2 or later.
+3. Import and implement the AppTrackingTransparency (ATT) Framework.
+   - Navigate to your project `Info.plist` and add a “Privacy - Tracking Usage Description”. This description appears in a popup when the application initializes in iOS 14. Users are prompted to indicate whether or not they want to allow tracking.
+4. Add and customize the following code in your `AppDelegate.m` file on `didFinishLaunchingWithOptions` to allow AppsFlyer collect IDFAs.
+
+   ```swift
+   // The following block is for applications wishing to collect IDFA.
+   // for iOS 14 and later - The user will be prompted for permission to collect IDFA.
+   // If permission granted, the IDFA will be collected by the SDK.
+   // for iOS 13 and earlier - The IDFA will be collected by the SDK. The user will NOT be prompted for permission.
+   if #available(iOS 14, *) {
+       // Set a timeout for the SDK to wait for the IDFA collection before handling app launch
+       AppsFlyerLib.shared().waitForAdvertisingIdentifier(withTimeoutInterval: 60)
+       // Show the user the Apple IDFA consent dialog (AppTrackingTransparency)
+       // Can be called in any place
+       ATTrackingManager.requestTrackingAuthorization { (status) in
+       }
+   }
+   ```
+5. Follow [Segment's guide for collecting IDFA](https://segment.com/docs/connections/sources/catalog/libraries/mobile/ios/#idfa-collection-in-40-beta-and-later)
+
 ### Server
 
-AppsFlyer offers an **augmentative** server-side [HTTP API](https://support.appsflyer.com/hc/en-us/articles/207034486-Server-to-Server-In-App-Events-API-HTTP-API-) intended for use along side their mobile SDK. Use the server-side destination alongside the mobile SDK to associate out-of-app events such as website or offline purchases with attributed users/devices. Read further for more information on this functionality.
+AppsFlyer offers an **augmentative** server-side [HTTP API](https://support.appsflyer.com/hc/en-us/articles/207034486-Server-to-Server-In-App-Events-API-HTTP-API-) intended for use along side the AppsFlyer mobile SDK. Use the cloud-mode destination _with_ the mobile SDK to link out-of-app events (such as website or offline purchases) with attributed users and devices.
 
-**Important**: Keep in mind that the server-side destination is not meant to *supplant* the client side SDK! In order for AppsFlyer to properly attribute, you must bundle their mobile SDK! The server-side destination should not be used alone. Also, keep in mind if you are passing in `appsFlyerId` for server-side calls, you will not be able to disable events from sending to AppsFlyer using your Segment dashboard.
+**Important**: The cloud-mode destination is not meant to replace the device-mode destination, and you should not use the cloud-mode destination by itself. AppsFlyer requires that you bundle the mobile SDK to correctly attribute user actions. Remember that if you pass in an `appsFlyerId` on cloud-mode calls, you cannot prevent events from sending to AppsFlyer from the Segment app.
 
-If you'd like to use AppsFlyer fully server-side, this can be done but it is a Enterprise Customer Feature and you need to contact your AppsFlyer representative to enable this feature.
+If you want to use AppsFlyer server-side only, contact your AppsFlyer representative, as this is an Enterprise Customer Feature.
 
 ## Identify
 
 If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](https://segment.com/docs/connections/spec/identify/) does. An example iOS call would look like:
 
-```ios
+```swift
 [[SEGAnalytics sharedAnalytics] identify:@"12091906-01011992"
                                 traits:@{ @"email": @"john.doe@example.com" }];
 ```
@@ -43,12 +71,12 @@ When you call `.identify()`, we will use AppsFlyer's `setCustomerUserID` to send
 
 If you're not familiar with the Segment Specs, take a look to understand what the [Track method](https://segment.com/docs/connections/spec/track/) does. An example iOS call would look like:
 
-```ios
+```swift
 [[SEGAnalytics sharedAnalytics] track:@"Article Completed"
                            properties:@{ @"title": @"How to Create a Tracking Plan", @"course": @"Intro to Analytics" }];
 ```
 
-When you call `track`, we translate it automatically and send the event to AppsFlyer.
+When you call `track`, Segment translates it automatically and sends the event to AppsFlyer.
 
 We include all the event properties as callback parameters on the AppsFlyer event, and automatically translate `properties.revenue` to the appropriate AppsFlyer purchase event properties based on our spec'd properties.
 
diff --git a/src/connections/destinations/catalog/apptimize/index.md b/src/connections/destinations/catalog/apptimize/index.md
@@ -68,7 +68,8 @@ It is important to note that if the app keys in the plist/code and the Segment d
 ## Screen
 
 If you're not familiar with the Segment Specs, take a look to understand what the [Screen method](https://segment.com/docs/connections/spec/screen/) does. An example iOS call would look like:
-```ios
+
+```swift
 [[SEGAnalytics sharedAnalytics] screen:@"Photo Feed"
                             properties:@{ @"Feed Type": @"public" }];
 ```
@@ -79,7 +80,7 @@ When you record a `screen`, Apptimize will track an event of the form `Viewed [S
 
 If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](https://segment.com/docs/connections/spec/identify/) does. An example iOS call would look like:
 
-```ios
+```swift
 [[SEGAnalytics sharedAnalytics] identify:@"12091906-01011992"
                                 traits:@{ @"email": @"john.doe@example.com" }];
 ```
@@ -90,7 +91,7 @@ When you `identify` a user, Segment will pass that user's information to Apptimi
 
 If you're not familiar with the Segment Specs, take a look to understand what the [Track method](https://segment.com/docs/connections/spec/track/) does. An example iOS call would look like:
 
-```ios
+```swift
 [[SEGAnalytics sharedAnalytics] track:@"Article Completed"
                            properties:@{ @"title": @"How to Create a Tracking Plan", @"course": @"Intro to Analytics" }];
 ```
@@ -99,7 +100,7 @@ When you `track` an event, the event will be marked in Apptimize as an occurence
 
 **Optional:** You can also specify a value for each event, by adding a `value` property to the event when tracking. This is useful, for instance, when you want to track the price of orders each time a user clicks "Buy" in your app's shopping cart. Including an example iOS call below:
 
-```ios
+```swift
 [[SEGAnalytics sharedAnalytics] track:@"Item Purchased"
                            properties:@{ @"item": @"Sample Item", @"value": @5.23 }];
 ```
diff --git a/src/connections/destinations/catalog/branch-metrics/index.md b/src/connections/destinations/catalog/branch-metrics/index.md
@@ -34,7 +34,7 @@ This document was last updated on November 13, 2019. If you notice any gaps, out
 ## Identify
 
 If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](https://segment.com/docs/connections/spec/identify/) does. An example iOS call would look like:
-```ios
+```swift
 [[SEGAnalytics sharedAnalytics] identify:@"12091906-01011992"
                                 traits:@{ @"email": @"john.doe@example.com" }];
 ```
@@ -43,7 +43,7 @@ If you're not familiar with the Segment Specs, take a look to understand what th
 
 If you're not familiar with the Segment Specs, take a look to understand what the [Track method](https://segment.com/docs/connections/spec/track/) does. An example iOS call would look like:
 
-```ios
+```swift
 [[SEGAnalytics sharedAnalytics] track:@"Article Completed"
                            properties:@{ @"title": @"How to Create a Tracking Plan", @"course": @"Intro to Analytics" }];
 ```
diff --git a/src/connections/destinations/catalog/braze/index.md b/src/connections/destinations/catalog/braze/index.md
@@ -45,7 +45,22 @@ If you notice any gaps or outdated information in this document, or simply want
 
 #### Sample App
 
-Braze has created a sample iOS application that integrates Braze using Segment. Check it out at the [Github repo](https://github.com/Appboy/appboy-segment-ios/tree/master/Example).
+Braze created a sample iOS application that integrates Braze using Segment. Check it out at the [Github repo](https://github.com/Appboy/appboy-segment-ios/tree/master/Example).
+
+#### Additional device-mode set up for iOS 14 support
+
+Segment’s Braze SDK was updated to use AppBoy's version 3.26.1 to prepare for iOS 14. Braze will continue to allow apps to provide a user’s IDFA value to the Braze SDK. The `ABK_ENABLE_IDFA_COLLECTION` macro, which would conditionally compile in optional automatic IDFA collection, will be removed in Braze's iOS 14 release.
+
+See the [Braze iOS 14 SDK Upgrade Guide](https://www.braze.com/docs/developer_guide/platform_integration_guides/ios/ios_14/) for more information.
+
+To use the latest Braze SDK to collect IDFAs you must do the following:
+
+1. Upgrade to use Xcode12.
+2. Update your Segment Appboy SDK to version 3.3.0 or greater.
+3. Import and implement the AppTrackingTransparency (ATT) Framework.
+   - Navigate to your project `Info.plist` and add a “Privacy - Tracking Usage Description”. This description appears in a popup when the application initializes in iOS 14. Users are prompted to indicate whether or not they want to allow tracking.
+4. Implement Braze's `ABKIDFADelegate`. For more information on how to implement this see [Braze’s IDFA Collection documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/ios/initial_sdk_setup/other_sdk_customizations/#implementing-idfa-collection).
+5. Follow [Segment's guide for collecting IDFA](https://segment.com/docs/connections/sources/catalog/libraries/mobile/ios/#idfa-collection-in-40-beta-and-later)
 
 ### Android
 
