[CF-106] Fetch AdServices Token

Gemfile.lock

@@ -17,20 +17,20 @@ GEM
     artifactory (3.0.15)
     atomos (0.1.3)
     aws-eventstream (1.2.0)
-    aws-partitions (1.573.0)
-    aws-sdk-core (3.130.0)
+    aws-partitions (1.579.0)
+    aws-sdk-core (3.130.2)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.525.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-kms (1.55.0)
+    aws-sdk-kms (1.56.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-s3 (1.113.0)
+    aws-sdk-s3 (1.113.1)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.4)
-    aws-sigv4 (1.4.0)
+    aws-sigv4 (1.5.0)
       aws-eventstream (~> 1, >= 1.0.2)
     babosa (1.0.4)
     claide (1.1.0)
@@ -116,7 +116,7 @@ GEM
     faraday_middleware (1.2.0)
       faraday (~> 1.0)
     fastimage (2.2.6)
-    fastlane (2.205.1)
+    fastlane (2.205.2)
       CFPropertyList (>= 2.3, < 4.0.0)
       addressable (>= 2.8, < 3.0.0)
       artifactory (~> 3.0)
@@ -160,7 +160,7 @@ GEM
     fourflusher (2.3.1)
     fuzzy_match (2.0.4)
     gh_inspector (1.1.3)
-    google-apis-androidpublisher_v3 (0.18.0)
+    google-apis-androidpublisher_v3 (0.19.0)
       google-apis-core (>= 0.4, < 2.a)
     google-apis-core (0.4.2)
       addressable (~> 2.5, >= 2.5.1)
@@ -175,23 +175,23 @@ GEM
       google-apis-core (>= 0.4, < 2.a)
     google-apis-playcustomapp_v1 (0.7.0)
       google-apis-core (>= 0.4, < 2.a)
-    google-apis-storage_v1 (0.12.0)
+    google-apis-storage_v1 (0.13.0)
       google-apis-core (>= 0.4, < 2.a)
     google-cloud-core (1.6.0)
       google-cloud-env (~> 1.0)
       google-cloud-errors (~> 1.0)
     google-cloud-env (1.6.0)
       faraday (>= 0.17.3, < 3.0)
     google-cloud-errors (1.2.0)
-    google-cloud-storage (1.36.1)
+    google-cloud-storage (1.36.2)
       addressable (~> 2.8)
       digest-crc (~> 0.4)
       google-apis-iamcredentials_v1 (~> 0.1)
       google-apis-storage_v1 (~> 0.1)
       google-cloud-core (~> 1.6)
       googleauth (>= 0.16.2, < 2.a)
       mini_mime (~> 1.0)
-    googleauth (1.1.2)
+    googleauth (1.1.3)
       faraday (>= 0.17.3, < 3.a)
       jwt (>= 1.4, < 3.0)
       memoist (~> 0.16)
@@ -234,7 +234,7 @@ GEM
     optparse (0.1.1)
     os (1.1.4)
     plist (3.6.0)
-    public_suffix (4.0.6)
+    public_suffix (4.0.7)
     rake (13.0.6)
     redcarpet (3.5.1)
     representable (3.1.1)

Sources/Attribution/AttributionFetcher.swift

@@ -19,10 +19,16 @@ import UIKit
 import WatchKit
 #endif
 
+#if canImport(AdServices)
+import AdServices
+#endif
+
 enum AttributionFetcherError: Error {
 
     case identifierForAdvertiserUnavailableForPlatform
     case identifierForAdvertiserFrameworksUnavailable
+    case adServicesNotAvailable
+    case adServicesTokenFetchError
 
 }
 
@@ -67,35 +73,23 @@ class AttributionFetcher {
         return nil
     }
 
-    func afficheClientAttributionDetails(completion: @escaping ([String: NSObject]?, Error?) -> Void) {
-        // Should match available platforms in
-        // https://developer.apple.com/documentation/iad/adclient?language=swift
-#if os(iOS)
-        guard let afficheClientProxy = attributionFactory.afficheClientProxy() else {
-            Logger.warn(Strings.attribution.search_ads_attribution_cancelled_missing_ad_framework)
-            completion(nil, AttributionFetcherError.identifierForAdvertiserFrameworksUnavailable)
-            return
+    // should match OS availability in https://developer.apple.com/documentation/ad_services
+    @available(iOS 14.3, macOS 11.1, macCatalyst 14.3, *)
+    var adServicesToken: String? {
+#if canImport(AdServices)
+        do {
+            return try AAAttribution.attributionToken()
+        } catch {
+            let message = Strings.attribution.adservices_token_fetch_failed(error: error)
+            Logger.appleWarning(message)
+            return nil
         }
-        afficheClientProxy.requestAttributionDetails(completion)
 #else
-        completion(nil, AttributionFetcherError.identifierForAdvertiserUnavailableForPlatform)
+        Logger.warn(Strings.attribution.adservices_not_supported)
+        return nil
 #endif
     }
 
-    var isAuthorizedToPostSearchAds: Bool {
-        // Should match platforms that require permissions detailed in
-        // https://developer.apple.com/app-store/user-privacy-and-data-use/
-        if !appTrackingTransparencyRequired {
-            return true
-        }
-
-        if #available(iOS 14.0.0, tvOS 14.0.0, *) {
-            return isAuthorizedToPostSearchAdsInATTRequiredOS
-        }
-
-        return true
-    }
-
     var authorizationStatus: FakeTrackingManagerAuthorizationStatus {
         // should match OS availability here: https://rev.cat/app-tracking-transparency
         guard #available(iOS 14.0.0, tvOS 14.0.0, macOS 11.0.0, *) else {

Sources/Attribution/AttributionNetwork.swift

@@ -22,37 +22,43 @@ import Foundation
     /**
      Apple's search ads
      */
-    case appleSearchAds
+    @available(*, deprecated, message: "use adServices")
+    case appleSearchAds = 0
 
     /**
      Adjust https://www.adjust.com/
      */
-    case adjust
+    case adjust = 1
 
     /**
      AppsFlyer https://www.appsflyer.com/
      */
-    case appsFlyer
+    case appsFlyer = 2
 
     /**
      Branch https://www.branch.io/
      */
-    case branch
+    case branch = 3
 
     /**
      Tenjin https://www.tenjin.io/
      */
-    case tenjin
+    case tenjin = 4
 
     /**
      Facebook https://developers.facebook.com/
      */
-    case facebook
+    case facebook = 5
 
     /**
     mParticle https://www.mparticle.com/
     */
-    case mParticle
+    case mParticle = 6
+
+    /**
+     AdServices token
+     */
+    case adServices = 7
 
 }
 

Sources/Attribution/AttributionPoster.swift

@@ -35,7 +35,6 @@ class AttributionPoster {
         self.subscriberAttributesManager = subscriberAttributesManager
     }
 
-    // swiftlint:disable:next function_body_length
     func post(attributionData data: [String: Any],
               fromNetwork network: AttributionNetwork,
               networkUserId: String?) {
@@ -88,46 +87,27 @@ class AttributionPoster {
         }
 
         if !newData.isEmpty {
-            if network == .appleSearchAds {
-                postSearchAds(newData: newData,
-                              network: network,
-                              appUserID: currentAppUserID,
-                              newDictToCache: newDictToCache)
-            } else {
-                postSubscriberAttributes(newData: newData,
-                                         network: network,
-                                         appUserID: currentAppUserID,
-                                         newDictToCache: newDictToCache)
-            }
+            postSubscriberAttributes(newData: newData,
+                                     network: network,
+                                     appUserID: currentAppUserID,
+                                     newDictToCache: newDictToCache)
         }
     }
 
-    func postAppleSearchAdsAttributionIfNeeded() {
-        guard attributionFetcher.isAuthorizedToPostSearchAds else {
+    // should match OS availability in https://developer.apple.com/documentation/ad_services
+    @available(iOS 14.3, macOS 11.1, macCatalyst 14.3, *)
+    func postAdServicesTokenIfNeeded() {
+        let latestTokenSent = latestNetworkIdAndAdvertisingIdentifierSent(network: .adServices)
+        guard latestTokenSent == nil else {
             return
         }
 
-        let latestIdsSent = latestNetworkIdAndAdvertisingIdentifierSent(network: .appleSearchAds)
-        guard latestIdsSent == nil else {
+        guard let attributionToken = attributionFetcher.adServicesToken else {
             return
         }
 
-        attributionFetcher.afficheClientAttributionDetails { attributionDetails, error in
-            guard let attributionDetails = attributionDetails,
-                  error == nil else {
-                return
-            }
-
-            let attributionDetailsValues = Array(attributionDetails.values)
-            let firstAttributionDict = attributionDetailsValues.first as? [String: NSObject]
-
-            guard let hasIad = firstAttributionDict?["iad-attribution"] as? NSNumber,
-                  hasIad.boolValue == true else {
-                return
-            }
-
-            self.post(attributionData: attributionDetails, fromNetwork: .appleSearchAds, networkUserId: nil)
-        }
+        Logger.debug("Logging attribution token for now to avoid lint warning: \(attributionToken)")
+        // post
     }
 
     func postPostponedAttributionDataIfNeeded() {
@@ -162,19 +142,6 @@ class AttributionPoster {
         return cachedDict[networkID]
     }
 
-    private func postSearchAds(newData: [String: Any],
-                               network: AttributionNetwork,
-                               appUserID: String,
-                               newDictToCache: [String: String]) {
-        backend.post(attributionData: newData, network: network, appUserID: appUserID) { error in
-            guard error == nil else {
-                return
-            }
-
-            self.deviceCache.set(latestNetworkAndAdvertisingIdsSent: newDictToCache, appUserID: appUserID)
-        }
-    }
-
     private func postSubscriberAttributes(newData: [String: Any],
                                           network: AttributionNetwork,
                                           appUserID: String,

Sources/Attribution/AttributionTypeFactory.swift

@@ -16,10 +16,6 @@ import Foundation
 
 class AttributionTypeFactory {
 
-    func afficheClientProxy() -> AfficheClientProxy? {
-        return AfficheClientProxy.afficheClientClass == nil ? nil : AfficheClientProxy()
-    }
-
     func atFollowingProxy() -> TrackingManagerProxy? {
         return TrackingManagerProxy.trackingClass == nil ? nil : TrackingManagerProxy()
     }

Sources/DocCDocumentation/DocCDocumentation.docc/Purchases.md

@@ -110,7 +110,7 @@ Most features require configuring the SDK before using it.
 - ``Purchases/finishTransactions``
 - ``Purchases/invalidateCustomerInfoCache()``
 - ``Purchases/forceUniversalAppStore``
-- ``Purchases/automaticAppleSearchAdsAttributionCollection``
+- ``Purchases/automaticAdServicesAttributionTokenCollection``
 - ``Purchases/proxyURL``
 - ``Purchases/verboseLogs``
 - ``Purchases/verboseLogHandler``

Sources/Identity/CustomerInfo.swift

@@ -43,12 +43,6 @@ import Foundation
         return mostRecentDate
     }
 
-    /// Returns all product IDs of the non-subscription purchases a user has made.
-    @available(*, deprecated, message: "use nonSubscriptionTransactions")
-    @objc public var nonConsumablePurchases: Set<String> {
-        Set(self.nonSubscriptionTransactions.map { $0.productIdentifier })
-    }
-
     /**
      * Returns all the non-subscription purchases a user has made.
      * The purchases are ordered by purchase date in ascending order.