Support for New Attribution Structure

Support for New Attribution Structure

Author: ren6

ApphudSDK.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'ApphudSDK'
-  s.version          = '3.5.9'
+  s.version          = '3.6.0'
   s.summary          = 'Build and Measure In-App Subscriptions on iOS.'
   s.description      = 'Apphud covers every aspect when it comes to In-App Subscriptions from integration to analytics on iOS and Android.'
   s.homepage         = 'https://github.com/apphud/ApphudSDK'

Examples/ApphudDemoSwift/Pods/Pods.xcodeproj/project.pbxproj

@@ -9,45 +9,68 @@
 import Foundation
 
 extension ApphudInternal {
-
+    
     // MARK: - Attribution
-    internal func addAttribution(rawData: [AnyHashable: Any]?, from provider: ApphudAttributionProvider, identifer: String? = nil, callback: ((Bool) -> Void)?) {
+    internal func setAttribution(data: ApphudAttributionData, from provider: ApphudAttributionProvider, identifer: String? = nil, callback: ((Bool) -> Void)?) {
         performWhenUserRegistered {
             Task {
-                
-                let data = rawData as? [String: any Sendable]
-                
-                var params: [String: Any] = ["device_id": self.currentDeviceID]
-
+                var dict: [String: any Sendable] = data.rawData as? [String: any Sendable] ?? [:]
+            
                 switch provider {
+                    // ---------- .custom ----------
                 case .custom:
-                    if let customAttribution = data {
-                        params.merge(customAttribution, uniquingKeysWith: { f, _ in f})
-                    }
+                    dict["identifier"] = identifer
+                    break
+                    
+                    // ---------- .voluum ----------
+                case .voluum:
+                    dict["identifier"] = identifer
+                    break
+                    
+                    // ---------- .singular ----------
+                case .singular:
+                    dict["identifier"] = identifer
+                    break
+                    
+                    // ---------- .tenjin ----------
+                case .tenjin:
+                    dict["identifier"] = identifer
+                    break
+
+                    // ---------- .tiktok ----------
+                case .tiktok:
+                    dict["identifier"] = identifer
+                    break
+
+                    // ---------- .branch ----------
                 case .branch:
-                    if let customAttribution = data {
-                        let wrappedAttribution = customAttribution["branch_data"] == nil ?
-                        ["branch_data": customAttribution] : customAttribution
-                        params.merge(wrappedAttribution, uniquingKeysWith: { f, _ in f})
-                    }
+                    dict["identifier"] = identifer
+                    break
+
+                    // ---------- .facebook ----------
                 case .facebook:
-                    guard identifer != nil, self.submittedFacebookAnonId != identifer else {
-                        apphudLog("Facebook Anon ID is nil or didn't change, exiting", forceDisplay: true)
+                    guard let fbIdent = identifer,
+                          self.submittedFacebookAnonId != fbIdent
+                    else {
+                        apphudLog("Facebook Anon ID (identifer field) is nil or didn't change, exiting", forceDisplay: true)
                         callback?(false)
                         return
                     }
-                    params["fb_anon_id"] = identifer
-                    if let customAttribution = data {
-                        params.merge(customAttribution, uniquingKeysWith: { f, _ in f})
-                    }
+                    dict["fb_anon_id"] = fbIdent
+
+                    // ---------- .firebase ----------
                 case .firebase:
-                    guard identifer != nil, self.submittedFirebaseId != identifer else {
+                    guard let firebaseId = identifer,
+                          self.submittedFirebaseId != firebaseId
+                    else {
                         callback?(false)
                         return
                     }
-                    params["firebase_id"] = identifer
+                    dict["firebase_id"] = firebaseId
+
+                    // ---------- .appsFlyer ----------
                 case .appsFlyer:
-                    guard identifer != nil else {
+                    guard let afIdent = identifer else {
                         callback?(false)
                         return
                     }
@@ -56,40 +79,37 @@ extension ApphudInternal {
                         callback?(false)
                         return
                     }
-                    params["appsflyer_id"] = identifer
 
-                    if let data = data {
-                        params["appsflyer_data"] = data
+                    dict["appsflyer_id"] = afIdent
 
-                        guard await self.submittedPreviouslyAF(data: data) else {
-                            apphudLog("Already submitted AppsFlyer attribution, skipping", forceDisplay: true)
-                            callback?(false)
-                            return
-                        }
+                    guard await self.submittedPreviouslyAF(data: dict) else {
+                        apphudLog("Already submitted AppsFlyer attribution, skipping", forceDisplay: true)
+                        callback?(false)
+                        return
                     }
                     self.isSendingAppsFlyer = true
+
+                    // ---------- .adjust ----------
                 case .adjust:
                     guard !self.isSendingAdjust else {
                         apphudLog("Already submitted Adjust attribution, skipping", forceDisplay: true)
                         callback?(false)
                         return
                     }
-                    if var data = data {
-                        if let adid = identifer {
-                            data["adid"] = adid
-                        }
-                        
-                        params["adjust_data"] = data
+                    if let adid = identifer {
+                        dict["adid"] = adid
+                    }
 
-                        guard await self.submittedPreviouslyAdjust(data: data) else {
-                            apphudLog("Already submitted Adjust attribution, skipping", forceDisplay: true)
-                            callback?(false)
-                            return
-                        }
+                    guard await self.submittedPreviouslyAdjust(data: dict) else {
+                        apphudLog("Already submitted Adjust attribution, skipping", forceDisplay: true)
+                        callback?(false)
+                        return
                     }
                     self.isSendingAdjust = true
+
+                    // ---------- .appleAdsAttribution ----------
                 case .appleAdsAttribution:
-                    guard identifer != nil else {
+                    guard let token = identifer else {
                         callback?(false)
                         return
                     }
@@ -99,28 +119,55 @@ extension ApphudInternal {
                         return
                     }
 
-                    if let searchAdsData = await self.getAppleAttribution(identifer!) {
-                        params["search_ads_data"] = searchAdsData
+                    if let searchAdsData = await self.getAppleAttribution(token) {
+                        for (key, value) in searchAdsData {
+                            dict[key] = value
+                        }
                     } else {
                         callback?(false)
                         return
                     }
+
                 default:
-                    return
+                    break
                 }
+                                
+                // Create Request params with raw_data
+                var params: [String: Any] = [
+                    "device_id": self.currentDeviceID,
+                    "provider": provider.toString(),
+                    "raw_data": dict
+                ]
 
-                // to avoid 404 problems on backend
+                var attributionDict: [String: any Sendable] = [:]
+                if let adNetwork = data.adNetwork          { attributionDict["ad_network"]    = adNetwork }
+                if let channel = data.channel              { attributionDict["channel"]  = channel }
+                if let campaign = data.campaign            { attributionDict["campaign"]      = campaign }
+                if let adSet = data.adSet                  { attributionDict["ad_set"]        = adSet }
+                if let creative = data.creative            { attributionDict["creative"]      = creative }
+                if let keyword = data.keyword              { attributionDict["keyword"]       = keyword }
+                if let custom1 = data.custom1              { attributionDict["custom_1"]      = custom1 }
+                if let custom2 = data.custom2              { attributionDict["custom_2"]      = custom2 }
+                
+                params["attribution"] = attributionDict
+                
                 try? await Task.sleep(nanoseconds: 2_000_000_000)
-
-                self.startAttributionRequest(params: params, provider: provider, identifer: identifer) { result in
+                
+                self.startAttributionRequest(params: params, apiVersion:.APIV2, provider: provider, identifer: identifer) { result in
                     Task {
                         if result {
                             switch provider {
                             case .appsFlyer:
-                                await ApphudDataActor.shared.setAFData(data)
+                                await ApphudDataActor.shared.setAFData(dict)
                             case .adjust:
-                                await ApphudDataActor.shared.setAdjustData(data)
-                            default :
+                                await ApphudDataActor.shared.setAdjustData(dict)
+                            case .firebase:
+                                self.submittedFirebaseId = identifer
+                            case .facebook:
+                                self.submittedFacebookAnonId = identifer
+                            case .appleAdsAttribution:
+                                self.didSubmitAppleAdsAttribution = true
+                            default:
                                 break
                             }
                         }
@@ -130,7 +177,7 @@ extension ApphudInternal {
             }
         }
     }
-
+    
     func submittedPreviouslyAF(data: [String: any Sendable]) async -> Bool {
         return await self.compareAttribution(first: data, second: ApphudDataActor.shared.submittedAFData ?? [:])
     }
@@ -146,8 +193,8 @@ extension ApphudInternal {
         return !dictionary1.isEqual(to: dictionary2 as! [AnyHashable: Any])
     }
 
-    func startAttributionRequest(params: [String: Any], provider: ApphudAttributionProvider, identifer: String?, callback: ((Bool) -> Void)?) {
-        self.httpClient?.startRequest(path: .attribution, params: params, method: .post, retry: true) { (result, _, _, _, _, _, _) in
+    func startAttributionRequest(params: [String: Any], apiVersion: ApphudHttpClient.ApphudApiVersion = .APIV1, provider: ApphudAttributionProvider, identifer: String?, callback: ((Bool) -> Void)?) {
+        self.httpClient?.startRequest(path: .attribution, apiVersion: apiVersion, params: params, method: .post, retry: true) { (result, _, _, _, _, _, _) in
             switch provider {
             case .adjust:
                 // to avoid sending the same data several times in a row
@@ -208,7 +255,7 @@ extension ApphudInternal {
         request.setValue("text/plain", forHTTPHeaderField: "Content-Type")
         request.httpBody = Data(appleAttibutionToken.utf8)
 
-        let response = try? await URLSession.shared.data(for: request, retries: 5, delay: 1.0)
+        let response = try? await URLSession.shared.data(for: request, retries: 5, delay: 7.0)
         if let data = response?.0,
            let result = try? JSONSerialization.jsonObject(with: data, options: .allowFragments) as? [String: any Sendable],
            let attribution = result["attribution"] as? Bool {

Examples/ApphudDemoSwiftUI/Pods/Pods.xcodeproj/project.pbxproj

@@ -14,7 +14,7 @@ import Foundation
 import UserNotifications
 import SwiftUI
 
-internal let apphud_sdk_version = "3.5.9"
+internal let apphud_sdk_version = "3.6.0"
 
 // MARK: - Initialization
 
@@ -776,17 +776,17 @@ final public class Apphud: NSObject {
     @objc public static func setAdvertisingIdentifier(_ idfa: String) {}
 
     /**
-     Submits attribution data to Apphud from your chosen attribution network provider.
+     Submits attribution data to Apphud
 
-     - parameter data: Required. The attribution data dictionary.
+     - parameter data: Required. The ApphudAttributionData model.
      - parameter provider: Required. The name of the attribution provider.
      - parameter identifier: Optional. An identifier that matches between Apphud and the Attribution provider.
      - parameter callback: Optional. A closure that returns `true` if the data was successfully sent to Apphud.
 
      - Note: Properly setting up attribution data is key for tracking and optimizing user acquisition strategies and measuring the ROI of marketing campaigns.
      */
-    @objc public static func addAttribution(data: [AnyHashable: Any]?, from provider: ApphudAttributionProvider, identifer: String? = nil, callback: ApphudBoolCallback?) {
-        ApphudInternal.shared.addAttribution(rawData: data, from: provider, identifer: identifer, callback: callback)
+    public static func setAttribution(data: ApphudAttributionData, from provider: ApphudAttributionProvider, identifer: String? = nil, callback: ApphudBoolCallback?) {
+        ApphudInternal.shared.setAttribution(data: data, from: provider, identifer: identifer, callback: callback)
     }
 
     /**

Examples/ApphudDemoVisionOS/ApphudSDKDemo.xcworkspace/contents.xcworkspacedata

@@ -0,0 +1,70 @@
+//
+//  ApphudAttributionData.swift
+//  ApphudSDK
+//
+//  Created by ren6 on 12/07/2019.
+//  Copyright © 2019 apphud. All rights reserved.
+//
+
+import Foundation
+
+public struct ApphudAttributionData {
+    
+    /// Raw attribution data received from MMPs, such as AppsFlyer or Branch.
+    /// Pass only `rawData` if no custom override logic is needed.
+    public let rawData: [AnyHashable: Any]
+
+    /// Overridden ad network responsible for user acquisition (e.g., "Meta Ads", "Google Ads").
+    /// Leave `nil` if no custom override logic is needed.
+    public let adNetwork: String?
+
+    /// Overridden channel that drove the user acquisition (e.g., "Instagram Feed", "Google UAC").
+    /// Leave `nil` if no custom override logic is needed.
+    public let channel: String?
+
+    /// Overridden campaign name associated with the attribution data.
+    /// Leave `nil` if no custom override logic is needed.
+    public let campaign: String?
+
+    /// Overridden ad set name within the campaign.
+    /// Leave `nil` if no custom override logic is needed.
+    public let adSet: String?
+
+    /// Overridden specific ad creative used in the campaign.
+    /// Leave `nil` if no custom override logic is needed.
+    public let creative: String?
+
+    /// Overridden keyword associated with the ad campaign (if applicable).
+    /// Leave `nil` if no custom override logic is needed.
+    public let keyword: String?
+
+    /// Custom attribution parameter for additional tracking or mapping.
+    /// Use this to store extra attribution data if needed.
+    public let custom1: String?
+
+    /// Another custom attribution parameter for extended tracking or mapping.
+    /// Use this to store extra attribution data if needed.
+    public let custom2: String?
+
+    public init(
+        rawData: [AnyHashable: Any],
+        adNetwork: String? = nil,
+        channel: String? = nil,
+        campaign: String? = nil,
+        adSet: String? = nil,
+        creative: String? = nil,
+        keyword: String? = nil,
+        custom1: String? = nil,
+        custom2: String? = nil
+    ) {
+        self.rawData = rawData
+        self.adNetwork = adNetwork
+        self.channel = channel
+        self.campaign = campaign
+        self.adSet = adSet
+        self.creative = creative
+        self.keyword = keyword
+        self.custom1 = custom1
+        self.custom2 = custom2
+    }
+}