- 2 Minutes to read
- Print
- DarkLight
- PDF
Apple Ads Connection
- 2 Minutes to read
- Print
- DarkLight
- PDF
Apple Ads Credentials Type
Apple Ads connection provide 2 types of connectivity methods:
* Zip archive file (Legacy): The legacy way to provide the API credentials. It is going to be deprecated soon, and isn't yet available for new API users.
* The OAuth Way (JWT): The new way to provide API credentials on Apple Ads. Based on client_id, team_id, key_id and a public key provided you by Rivery.
OAuth (JWT)
In order to connect to Apple Ads there's a need to create a specific user for Rivery with the right API scope, create a new key pair in Rivery, add to Apple Ads the public key Rivery provided, and provide back the client_id, team_id and key_id to Rivery.
Step 1: Invite an Apple ID with API permissions
- Sign in to Apple Ads, using Advanced mode, and with an Account admin permissions Apple ID.
- Click on your Name in the top right corner, choose the account you want to manage, and then click on Settings.
- In the Account Settings, go to Users Management, and then Invite Users.
- Invite the user that you want Rivery will connect with, and set it's permissions to API Account Read Only. Click on Send Invite.
- Complete the invitation process, and connect to Apple Ads again with the user you've just invited.
Step2: Generate a new public key in Rivery
Apple Ads API requires from its users to provide a pre-generated public key, which refers to a private key, and with it Rivery generates a new token every run. In order to do that, please follow the next.
- In Rivery console, go to connections -> create new connection.
- Choose Apple Ads from the list of connections.
- In order to provide a public key for Apple Ads, choose an existing key from the list, or click on create new key pair.
- Click on Display public key.
- Copy the entire public key including the BEGIN PUBLIC KEY and the END PUBLIC KEY or use the copy icon.
- Keep it for the next steps.
Step 3: Provide the public key to Apple Ads and get the client id, team id and key id
- Connect again to the API Account Read Only user invited in Step 1 using Advanced login.
- Click on your Name in the top right corner, choose the account you want to manage, and then click on Settings.
- Go to API and Paste the public key generated on Step 2. Click Save.
- In Rivery, go to the Apple Ads connection, and provide the ClientId, TeamId and KeyId generated from Apple Ads.
- Test the connection.
- Name it and click on Save.
Zip archive file (Legacy)
In order to connect to Apple Ads, you will first need to generate a *.zip archive file with certification keys files, which Apple provides.
- Sign in to Apple Ads.
- Click Your Name, at the right top corner of the screen.
- Press Settings:
- Go to the API section and click on Create API Certificate:
- Give a name to your certification. Choose the account and set the role to Read Only. Press Create.
- After the certificate appears on your list, check it and click on Actions and Download Certificate. This will produce a zip archive file. Save it in a safe place.
- In Rivery, go to Connections -> New Connection.
- Choose Apple Ads from the sources
- Give a name to your connection.
- Choose Legacy in Credentials Type. Upload the zip archive file you just generated.
- Test your credentials by pressing Test Connection.
- Save the connection.