Growth and ads
Connect Apple Ads to Sondola
What Sondola reads from Apple Ads: taps and cost per tap. Read-only, with the source and period beside every number.
Read-only. Sondola never changes your data in Apple Ads.
- Credential
- Key pair, signed tokens
- Refresh
- Twice a day
- How it connects
- Collected automatically
- Setup time
- About 10 minutes
What Sondola reads from Apple Ads
- Taps
- Cost per tap
What you need
- You need to be an account administrator in Apple Ads. Nothing is installed on your computer, and nothing here can spend money: the collector only ever reads.
Collection timing and the period a reading covers are separate. Check the source's data-through date as well as the metric's reporting period.
Connect Apple Ads in 5 steps
- Make sure your user has an API role
Sign in at ads.apple.com (Sign In → Advanced). Account Settings → User Management → your user. Any API role works (API Account Manager, API Campaign Manager, API Account Read Only). The API page only appears for users who hold one.
Read-only API role: API Account Read Only.A read-only API role is the safer choice and shows green here. A read-write role still connects and shows amber.Apple Ads Help: user roles ↗ - Generate the key pair here
Press Generate key pair. The private half is encrypted on our servers at once and never shown. The public half appears below the button with a Copy button.
- Paste the public key into Apple Ads and press Save
Account Settings → API → paste the whole public key, including the BEGIN and END lines → Save. Apple then shows a code block with clientId, teamId and keyId. Until you press Save in Apple, the key is not registered and the test answers invalid_client.
Apple: implementing OAuth ↗ - Copy the three IDs from Apple's code block
Client ID and Team ID both start with SEARCHADS. and Key ID is a UUID. Paste each into its field exactly as shown, nothing else.
- Organisation ID, then Save and test
The number after /cm/app/ in your Apple Ads URL. Save and test issues one token and reads /acls: it confirms the organisation is visible to this user and reports the user's API role.
Enter credentials only in your Sondola workspace. Keep keys out of screenshots, public repositories and support messages.
What Sondola asks you for
Generated for you when you press Generate key pair. The private half is encrypted and never shown to anyone. The public half is what you paste into Apple Ads at Account Settings → API. The collector signs a short-lived client secret from the private key on every run, so nothing expires.
The Apple Ads user who uploads the public key must hold the account-wide role API Account Read Only. The campaign-group role API Read Only is not enough.Shown in the code block after you upload the public key at Account Settings → API.
Same code block as the Client ID.
Same code block as the Client ID.
The number after /cm/app/ in your Apple Ads URL, for example app-ads.apple.com/cm/app/1234567. Every run checks that the token can see exactly this organisation before it reads anything.
Secrets are stored encrypted in your workspace, in a vault kept separate from the application database. Sondola never shows them again.
Permissions
- Any Apple Ads API role connects. API Account Read Only is the safer choice and shows green. A read-write role still connects and shows amber.
- The private half of the key pair is encrypted on Sondola's servers and never shown.
- Nothing here can spend money. The collector only reads.
Refresh and first reading
Twice a day. Most tools refresh once or twice a day, and every number shows when it was read.
If you ever disconnect, the key pair is deleted with the credential. Reconnecting means a new pair and a new public key in Apple Ads. The old key can be removed there.
Troubleshooting
Save and test rejects the credential.
The Apple Ads user who uploads the public key must hold the account-wide role API Account Read Only. The campaign-group role API Read Only is not enough. A read-only API role is the safer choice and shows green here. A read-write role still connects and shows amber.
The test passes but no reading appears.
The collector runs on its schedule, so a successful test does not mean a reading has landed. Check the source's data-through date and the metric's reporting period, and treat a missing reading as missing, not zero.
A number differs from Apple Ads.
Compare the definition, unit and reporting period with the same number in Apple Ads before treating a difference as an error. When a stored reading changes, its history keeps the old value, the new value and the reason.
Provider documentation
Readings missing or old? Read the setup and troubleshooting guide and the worked freshness example.
Related integrations
See your company clearly by Monday.
Apply in two minutes. Once you are in, your first numbers arrive minutes after you connect a tool.
Free for qualifying startups. Read-only.