Set up App Tracking Transparency

If you want to record the device’s ID for Advertisers (IDFA), you must display a prompt to get your user’s authorization. To do this, include Apple’s ATT framework in your app. The Adjust SDK stores the user’s authorization status and sends it to Adjust’s servers with every request.

Authorization statuses

ATT authorization wrapper

The Adjust SDK contains a wrapper around Apple’s requestTrackingAuthorizationWithCompletionHandler method. You can use this wrapper if you don’t want to customize the ATT prompt.

The callback method triggers when the user responds to the consent dialog. This method sends the user’s consent status code to Adjust’s servers. You can define how your app responds to each status code within the callback function.

You must provide text content for the ATT request dialog by adding your message to the NSUserTrackingUsageDescription key in your app’s Info.plist file.

1
local adjust = require "plugin.adjust"
2

3
adjust.requestAppTrackingAuthorization(function(status)
4
    if status.message == 0 then
5
        -- ATTrackingManagerAuthorizationStatusNotDetermined case
6
    elseif status.message == 1 then
7
        -- ATTrackingManagerAuthorizationStatusRestricted case
8
    elseif status.message == 2 then
9
        -- ATTrackingManagerAuthorizationStatusDenied case
10
    elseif status.message == 3 then
11
        -- ATTrackingManagerAuthorizationStatusAuthorized case
12
    else
13
        -- error case
14
    end
15
end)

Get current authorization status

You can retrieve a user’s current authorization status at any time. Call the getAppTrackingAuthorizationStatus method to return the authorization status code as a number.

1
local adjust = require "plugin.adjust"
2

3
adjust.getAppTrackingAuthorizationStatus(function(status)
4
    print("Authorization status: " .. status.message)
5
end)

Custom prompt timing

If your app includes onboarding steps or a tutorial, you may want to delay sending the user’s ATT consent status until after this process. You can do this by setting the attConsentWaitingInterval key in your configuration table. This delays sending data for up to 360 seconds, giving the user time to finish onboarding. Once the timeout ends, or as soon as the user sets their consent status, the SDK sends all recorded information to Adjust’s servers along with the consent status.

1
local adjust = require "plugin.adjust"
2

3
adjust.initSdk({
4
    appToken = "YourAppToken",
5
    environment = "SANDBOX",
6
    logLevel = "VERBOSE",
7
    attConsentWaitingInterval = 30
8
})

Disable the usage of App Tracking Transparency

If you want to prevent the Adjust SDK from automatically interacting with AppTrackingTransparency.framework, set the isAppTrackingTransparencyUsageEnabled key in your configuration table to false before SDK initialization.

1
local adjust = require "plugin.adjust"
2

3
adjust.initSdk({
4
    appToken = "YourAppToken",
5
    environment = "SANDBOX",
6
    logLevel = "VERBOSE",
7
    isAppTrackingTransparencyUsageEnabled = false
8
})