In the Apple Search Ads section within Settings, you can the enable Apple Search Ads integration with Superwall:

Apple offers two different search ad services, “Basic” and “Advanced” tiers. Superwall supports both of them, though more data is available with the Advanced ads.

Basic search ads setup

If you’re only using basic search ads, click the toggle next to Basic Apple Search Ads to enable the integration:

That’s it, you’re all set. With basic Apple Search Ads enabled, you’ll be to see users acquired via search ads in the users page.

To see what you can do with advanced search ads data, skip down to the use cases section.

Advanced search ads setup

Advanced search ads takes a few more steps since it requires the Campaign Management API. The overview is as follows, with more details about each step below them:

  • First, you’ll need to create a user in Apple Search Ads using a different Apple Account than your primary Apple Account.
  • This new user will need to be setup with either the API Account Manager or API Account Read Only role.
  • Then, you’ll generate three things by pasting in a public key from Superwall: a client ID, team ID and key ID.
  • Finally, you’ll enter those three values into Superwall.

Step One: Invite a new user

  1. Go to searchads.apple.com and click Sign In -> Advanced.
  2. Locate your account name in the top right corner and click Account Name -> Settings.
  3. Under User Management, click Invite Users.
  4. Grant the user appropriate permissions and enter in the rest of the details. The email address here is the one you’ll want to use to create a new user in Apple Search Ads:

Step Two: Accept the invitation
Open the email and follow Apple’s instructions to setup a new user with Apple Search ads. The email will look similar to this:

Once you’ve accepted the invitation using the invited Apple Account:

  1. Once again, go to searchads.apple.com and click Sign In -> Advanced.
  2. Locate your account name in the top right corner and click Account Name -> Settings.
  3. Over in Superwall, go to the Settings -> Apple Search Ads -> click copy under the public key:
  4. Back in Apple Search Ads, paste the public key under Public Key and click Generate API Client:

Step Three: Generate the client ID, team ID and key ID
Now, you should see three values that have been generated by Apple Search Ads, a client ID, team ID and key ID.

  1. Copy each generated value.
  2. In Superwall, paste each value in and click “Update ASA Configuration.”
  3. Finally, click on “Check Configuration” and confirm everything is setup properly.

Use cases

Once you’ve enabled Apple Search Ads, you can use the data in a few ways. First, users who’ve been acquired from a search ad will display that information in the users page under “Apple Search Ads.” This is available with either the basic or advanced search ads. This can be useful for understanding the quality of users acquired from search ads.

If you’re using advanced search ads, you get significantly more capabilities:

  • You can leverage search ad data in your campaigns. This opens up the ability to do things like showing a specific paywall to a user who was acquired via a search ad, tailor messaging from the keyword that was used, and more.
  • You can view search ads data in charts, breaking down metrics by campaign name and more.

Viewing users acquired via Apple Search Ads

If any user was acquired via a search ad, you’ll see that data in the users page. This can be useful for understanding the quality of users acquired from search ads:

Here’s a breakdown of the attributes you’ll see:

AttributeExampleDescription
Ad Group Id1684936422The identifier for the ad group. Use Get Ad Group-Level Reports to correlate your attribution response by adGroupId.
Ad Group NamePrimary Ad GroupThe name of the ad group for organizational and reporting purposes.
Ad Id-1The identifier representing the assignment relationship between an ad object and an ad group. Applies to devices running iOS 15.2 and later.
AttributiontrueA Boolean value indicating if the attribution was successful. Returns true if a user clicks an ad up to 30 days before downloading your app.
Bid Amount0.25The cost-per-click (CPC) bid amount placed for this ad group.
Bid CurrencyGBPThe currency used for the bid amount.
Campaign Id1633810596The unique identifier for the campaign. Use Get Campaign-Level Reports to correlate your attribution response by campaignId.
Campaign NamePrimary Campaign (US)The name of the campaign, useful for tracking and organizational purposes.
Conversion TypeDownloadThe type of conversion, either Download or Redownload.
Country Or RegionUSThe country or region for the campaign.
Keyword Id1685193881The identifier for the keyword.
Keyword Namebaskeball appThe specific keyword that triggered the ad.
Match TypeEXACTThe keyword matching type used to trigger the ad (e.g., EXACT, BROAD, or PHRASE).
Org Id3621140The identifier of the organization that owns the campaign. This is the same as your account in the Apple Search Ads UI.

Using search ad data in campaigns

Using the table above, you can turn around and use any of those values to create campaign filters:

There is a delay from the moment a user downloads your app via a search ad to the time that event is sent to Superwall from Apple’s servers. For that reason, using search ad data as a filter on events like an app’s launch is discouraged.

Charts

Use data from Apple Search Ads in our charts as a breakdown and filter:

Apple Search Ads data can be used in the following charts:

  • Proceeds
  • Sales
  • Conversions
  • New Subscriptions
  • New Trials
  • Trial Conversions
  • Refund Rate

As far as search ads data, you can create breakdowns using the following:

  • Ad Group Name
  • Campaign Name
  • Keywords Match Name
  • Match Type

Some common use cases here are:

  • Attributing new trials from a search campaign.
  • Seeing which keywords generate the most revenue.
  • Understanding the quality of users acquired from a search ad.
  • etc.