Apple SearchAds Connection

Introduction

This document provides step-by-step instructions for setting up and configuring your Apple Search Ads API integration using Rivery.

Apple Ads connection in Rivery supports two types of connectivity methods:

1. OAuth (JWT):
   The new standard for API credentials, utilizing a JWT (JSON Web Token) based approach with 'Client ID', 'Team ID' ,'Key ID' and a public key provided by Rivery.

2. 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

To establish a connection to Apple Ads using OAuth (JWT), follow these steps:

Step 1: Generate a New Public Key in Rivery

Apple Ads API requires a public key to generate tokens for authentication. Follow these steps:

1. Create a Connection:

   • In the Rivery console, navigate to Connections and select Create New Connection.
   • Choose Apple Ads from the list of connections.

2. Generate Public Key:

   • Select an existing key from the list, or click Create New Key Pair.
   • Click on Display Public Key.

3. Copy Public Key:

   • Copy the entire public key, including the BEGIN PUBLIC KEY and END PUBLIC KEY lines, or use the copy icon.
   • Save this key for the next step.

Step 2: Provide the Public Key to Apple Ads and Retrieve 'Client ID', 'Team ID' ,'Key ID'

1. Access Apple Ads with the API Account Read Only User:
   Log in using the invited user credentials.

2. Navigate to API Settings:
   Click on your name, choose the relevant account, and go to Settings -> API.

3. Submit Public Key:

   • Paste the public key copied from Rivery in the API section.
   • Click Save.

4. Retrieve Credentials:
   • After saving, Apple Ads will generate the 'Client ID', 'Team ID' ,'Key ID'.
   • Provide these details in Rivery under the Apple Ads connection.

Step 3: Test and Save the Connection

1. Test Connection:
   After entering the client_id, team_id, and key_id, test the connection to ensure it's functioning correctly.

2. Save:
   Name the connection and click Save to complete the setup.