Apple Search Ads connection
Apple Ads connection in Data Integration supports two types of connectivity methods:
-
OAuth (JWT):
The new standard for API credentials, using a JWT (JSON Web Token) based approach with 'Client ID', 'Team ID', Key ID', and a public key provided by Data Integration. -
Zip archive file (legacy): The legacy method for providing API credentials using a Zip file.
Prerequisites
- An account administrator role in Apple Search Ads.
- An API user account.
OAuth (JWT) method
You can establish a connection to Apple Ads using OAuth (JWT).
Step 1: Generate a new public key in Data Integration
Apple Ads API requires a public key to generate tokens for authentication. Follow these steps:
-
Create a connection:
- In the Data Integration Console, navigate to Connections and select Create New Connection.
- Choose Apple Ads from the list of connections.
-
Generate public key:
- Select an existing key from the list, or click Create New Key Pair.
- Click Display Public Key.
-
Copy public key:
- Copy the entire public key, including the
BEGIN PUBLIC KEYandEND PUBLIC KEYlines, or use the copy icon. - Save this key for the next step.
- Copy the entire public key, including the
Step 2: Provide the public key to Apple Ads and retrieve 'Client ID', 'Team ID', 'Key ID'
-
Access Apple Ads with the API account read-only user: Log in using the invited user credentials.
-
Navigate to API settings: Click on your name, choose the relevant account, and go to Settings > API.
-
Submit public key:
- Paste the public key copied from Data Integration in the API section.
- Click Save.
-
Retrieve credentials:
- After saving, Apple Ads generates the 'Client ID', 'Team ID', and 'Key ID'.
- Provide these details in Data Integration under the Apple Ads connection.
Step 3: Test and save the connection
-
Test Connection: After entering the
client_id,team_id, andkey_id, test the connection to ensure it functions correctly. -
Save: Name the connection and click Save to complete the setup.