Collect Advertising ID (IDFA)

• iOS 13 and below: the SDK collects the IDFA automatically, provided advertising tracking is enabled on the device. No extra integration is required.
• iOS 14 and later: Apple’s App Tracking Transparency framework requires explicit user permission. Your app requests this permission and passes the result to the SDK using one of the two methods below.

​

Method A: setAdvertisingIdByATTStatus

​

Syntax

Collect.getInstance()?.setAdvertisingIdByATTStatus(status: ATTrackingManager.AuthorizationStatus)

​

Parameters

​

Behavior

• When status == .authorized, the SDK reads the IDFA from ASIdentifierManager and adds both advertising_id and att_authorization_status to the user payload.
• For any other status (.denied, .notDetermined, .restricted), the SDK adds only att_authorization_status. No advertising_id is sent.

​

Example

import AppTrackingTransparency

ATTrackingManager.requestTrackingAuthorization { status in
    Collect.getInstance()?.setAdvertisingIdByATTStatus(status: status)
}

​

Method B: setATTStatusAndAdvertisingId

​

Syntax

Collect.getInstance()?.setATTStatusAndAdvertisingId(
    status: ATTrackingManager.AuthorizationStatus,
    advertisingId: String = ""
)

​

Parameters

​

Behavior

​

Example

import AppTrackingTransparency
import AdSupport

ATTrackingManager.requestTrackingAuthorization { status in
    switch status {
    case .authorized:
        Collect.getInstance()?.setATTStatusAndAdvertisingId(
            status: status,
            advertisingId: ASIdentifierManager.shared().advertisingIdentifier.uuidString
        )
    case .denied:
        Collect.getInstance()?.setATTStatusAndAdvertisingId(status: status)
    case .notDetermined:
        Collect.getInstance()?.setATTStatusAndAdvertisingId(status: status)
    case .restricted:
        Collect.getInstance()?.setATTStatusAndAdvertisingId(status: status)
    @unknown default:
        break
    }
}

​

Authorization status values

​

Best Practices

1. Initialize the SDK first. Call Collect.initialize(option:) (typically in application(_:didFinishLaunchingWithOptions:)) before requesting tracking authorization.
2. Request at the right moment. Show your own context (pre-permission) screen before triggering the native ATT prompt, and avoid requesting during critical flows.
3. Add NSUserTrackingUsageDescription. The ATT prompt will not appear without it.
4. Respect the user’s choice. When the status is not authorized, the SDK does not send an advertising_id; continue to operate without it.

​

Related Documentation

• Track User Consent: Manage GDPR / CCPA consent signals.
• Consent Configuration Options: SDK options such as optout, useConsent.
• Apple — Requesting authorization to track: Official ATT reference.