🚧

Attention

The iAd framework is no longer attributing downloads from Apple Search Ads campaigns. Integration works only for iOS 14.3+ devices using AdServices framework.

How to Add Integration?

Step 1

For every app installation, pass the attribution token from the app to Apphud.

📘

Important Note

Call the code below for every app installation, regardless ATT consent

import AdServices

// call at AppDelegate's didFinishLaunching method
private func trackAppleSearchAds() {
        if #available(iOS 14.3, *) {
            DispatchQueue.global(qos: .default).async {
                if let token = try? AAAttribution.attributionToken() {
                    DispatchQueue.main.async {
                        Apphud.addAttribution(data: nil, from: .appleAdsAttribution, identifer: token, callback: nil)
                    }
                }
            }
        }
   }

#import <AdServices/AdServices.h>

- (void)trackAppleSearchAds {
    if (@available(iOS 14.3, *)) {
        dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_HIGH, 0), ^{
        NSString *token = [AAAttribution attributionTokenWithError:nil];
        if (token != nil) {
            dispatch_async(dispatch_get_main_queue(), ^{
                [Apphud addAttributionWithData:nil from:ApphudAttributionProviderAppleAdsAttribution identifer:token callback:nil];
            });
        }
        });
    }
}

Step 2

• At Apphud go to Settings > Search Ads Settings.
• By default, Apphud generates public-private key pair automatically so you will need just to copy the public key value. However, if you are already using services like Asapty or your own solution, you will need to paste the private key instead. Read here for details.

Step 3

In your Apple Search Ads account go to Settings > User Management page. In order for Apphud to fetch attribution data you need to invite another Apple ID account and grant it API Account Manager access.

📘

Note

For an unknown reason, granting API Account Read Only role doesn't work.
Please grant the Account Manager role as described.

Step 4

• Log out from your primary Search Ads Account
• Log in to Apple Search Ads with Apple ID that has API access that you invited from step 3.
• Go to Settings > API and paste your public key to generate credentials.
• Copy Client ID, Team ID, and Key ID fields.

Step 5

Go to Apphud Settings > Search Ads Settings and fill in all the fields.
If all is done correctly Access Token field with the Organisations list will show up on the page:

Click Save and you're all set!

View Apple Search Ads Attribution Data in Apphud

Regardless of what of the two methods you use you can view attribution data from Apple Search Ads in Apphud charts or on the user page.

Troubleshooting

I enter a valid public key to Apple Search Ads Console but get an error

If you believe you did everything right, but still experience an issue with pasting public key to Apple Search Ads setting, try opening the same webpage in the incognito mode or delete caches of your browser. This is a known issue with cache on Apple side.

I see Undetermined [0123456789] attribution in Charts

Make sure your credentials are accurately set up as per documentation above.

I don't see any attribution data in Charts

Make sure you pass attribution information from within the app. See Step 1 of the documentation.

I am unable to paste the public key copied from Apphud

In this case generate your own public-private key pair on your computer. Please follow these two steps:

1. Generate the private key

To generate private key run in Terminal:

openssl ecparam -genkey -name prime256v1 -noout -out private-key.pem

Paste this private key content to the Apple Search Ads integration page in Apphud by clicking "paste it". See the screenshot below:

2. Generate public key

To extract public key from your private key run in Terminal:

openssl ec -in private-key.pem -pubout -out public-key.pem

Paste this public key in your Apple Search Ads settings page of Apple ID account with API Account Manager role.
Use generated team id, client id and key id values and paste them to Apphud ASA settings page.