Apple Search Ads
On This Page
You can use Hevo Pipelines to replicate your Apple Search Ads reports such as campaign reports and search term reports into the desired Destination system for scalable analysis. For this, you must authorize Hevo to access data from your Apple Search Ads account using the API keys.
You must use your Apple Search Account credentials to authenticate the account with Hevo for all Pipelines created after Release 1.87. The credentials are a combination of a public key and a private key.
Note: The certificate based authentication has been completely deprecated.
Prerequisites
-
The user account has either
API Account Read-only
orAPI Account Manager
access. This can be provided by your Apple Search Ads admin. -
The user account has access to at least one application hosted on the App Store.
Generate your Apple Search Ads Credentials
-
Copy the Public key from the Source configuration page in Hevo.
-
In the Settings, API tab, paste the public key from the public key certificate that you copied in Step 2 above and click Generate API Client.
-
Copy the
clientId
,teamId
, andkeyId
and paste these in Hevo’s Apple Search Ads configuration screen.
Configuring Apple Search Ads as a Source
Perform the following steps to configure Apple Search Ads as the Source in your Pipeline:
-
Click PIPELINES in the Asset Palette.
-
Click + CREATE in the Pipelines List View.
-
In the Select Source Type page, select Apple Search Ads.
-
In the Configure your Apple Search Ads Source page, specify the following:
-
Pipeline Name: A unique name for your Pipeline.
-
Public Key: The public key that you retrieved from your Apple Search Ads account settings in Step 2 above.
-
Client ID: The Client ID mentioned in your Apple Search Ads account settings.
-
Team Id: The Team ID mentioned in your Apple Search Ads account settings.
-
Key ID: The Key ID mentioned in your Apple Search Ads account settings.
-
Organizations: One or more organizations from which you want to ingest the data.
-
Historical Sync Duration: The duration for which the past data must be ingested. Default value: 1 Year.
-
-
Click TEST & CONTINUE.
-
Proceed to configuring the data ingestion and setting up the Destination.
Source Considerations
Apple Search Ads API users can authenticate using only the API keys. Even if an existing certificate is still valid, you need to recreate the Pipeline using the API Keys. This is because Apple Search Ads has deprecated certificate based authentication.
Limitations
None.
Revision History
Refer to the following table for the list of key updates made to this page:
Date | Release | Description of Change |
---|---|---|
Apr-25-2022 | 1.87 | - Removed section, Authorize Hevo Using an API Certificate and structured the existing content accordingly. - Updated sections, Schema and Primary Keys and Data Model with the latest list of objects and their respective descriptions. - Added section, Source Considerations. |
Apr-11-2022 | 1.86 | Updated sections, Schema and Primary Keys and Data Model with the information relating to the support for the country_or_region field. |
Oct-25-2021 | NA | Added the Pipeline frequency information in the Data Replication section. |
Aug-05-2021 | 1.68 | - Added section, Authorizing Hevo Using API Keys - Updated section, Configuring Apple Search Ads as a Source with steps to configure the Source using API Key credentials. |