Apple Search Ads

Apple Search Ads are sponsored ads for driving awareness and downloads for apps within Apple’s App Store. This allows you to promote your applications at the top of the search results on the App Store.

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 in one of the following ways:

For creating Pipelines using this Source, Hevo provides you a fully managed BigQuery data warehouse as a possible Destination. This option remains available till the time you set up your first BigQuery Destination irrespective of any other Destinations that you may have. With the managed warehouse, you are only charged the cost that Hevo incurs for your project in Google BigQuery. The invoice is generated at the end of each month and payment is recovered as per the payment instrument you have set up. You can now create your Pipeline and directly start analyzing your Source data. Read Hevo Managed Google BigQuery.


Authorizing Hevo Using API Keys

Hevo recommends this method of authentication for all existing and new Pipelines.

Prerequisites

  • The user account has either API Account Read-only or API Account Manager access. This can be provided by your Apple Search Ads admin.

    user roles

  • The user account has access to at least one application hosted on the App Store.

Generate your Apple Search Ads Credentials

  1. Copy the Public key from the Source configuration page in Hevo.

  2. Open Apple Search Ads Settings.

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

    Generate API Client

  4. Copy the clientId, teamId, and keyId and paste these in Hevo’s Apple Search Ads configuration screen.

    Copy IDs


Authorizing Hevo Using an API Certificate

The Apple Search Ads API certificate allows Hevo to establish a two-way SSL authentication and replicate your Apple Search Ads data into your desired Destination system. You must use the PEM File and Key File from the certificate to authenticate Hevo to access your data.

New API Certificates cannot be generated as of June 15, 2021. Therefore, this method of authentication will be deprecated by October 1, 2021. We recommend switching over to API Key-based authentication for your existing Pipelines.

Prerequisites

Download the Apple Search Ads API Certificate

  1. Log in to your Apple Search Ads Account.

  2. In the drop-down on the top right, click Settings against your selected account.

    Click settings

  3. In the Account Settings page, click the API tab.

  4. Select the created certificate, and then, in the Actions drop-down, select Download certificate.

    Download certificate

  5. Your Apple Search Ads API certificate gets downloaded in ZIP format. The ZIP file contains

    • <file_name>.key

    • <file_name>.pem

    Use the key and pem files to configure the Apple Search Ads Source settings in Hevo.


Configuring Apple Search Ads as a Source

Perform the following steps to configure Apple Search Ads as the Source in your Pipeline:

  1. Click PIPELINES in the Asset Palette.

  2. Click + CREATE in the Pipelines List View.

  3. In the Select Source Type page, select Apple Search Ads.

  4. In the Configure your Apple Search Ads Source page, specify the configuration settings based on the authentication method you selected.

    • For API Certificate-based authentication:

      API Certificate-based Settings

      1. Pipeline Name: A unique name for your Pipeline.

      2. Upload PEM file: The PEM file extracted from your Apple Search Ads API certificate.

      3. Upload key file: The key file extracted from your Apple Search Ads API certificate.

      4. Organizations: The account(s) for which the apple search ads data needs to be synced.

      5. Historical Sync Duration: The duration for which the past data must be ingested. Default value: 1 Year.

    • For API Key-based authentication:

      API Key-based settings

      1. Pipeline Name: A unique name for your Pipeline.

      2. Client ID: The Client ID retrieved from your Apple Search Ads account settings.

      3. Team Id: The Team ID mentioned in your Apple Search Ads account settings.

      4. Key ID: The Key ID mentioned in your Apple Search Ads account settings.

      5. Organizations: One or more organizations from which you want to ingest the data.

      6. Historical Sync Duration: The duration for which the past data must be ingested. Default value: 1 Year.

  5. Click TEST & CONTINUE.

  6. Proceed to configuring the data ingestion and setting up the Destination.


Data Replication

Default Pipeline Frequency Minimum Pipeline Frequency Maximum Pipeline Frequency Custom Frequency Range (Hrs)
6 Hrs 1 Hr 24 Hrs 1-24

Note: The custom frequency must be set in hours, as an integer value. For example, 1, 2, 3 but not 1.5 or 1.75.

  • Historical Data: When the Pipeline is created, Hevo fetches all past data created since June 15, 2016 for your account till the current date and loads it into your Destination.

  • Incremental Data: Once the historical load is completed, all new and updated records are synchronized with your Destination. Hevo ingests data every 6 hours by default.

  • Refresh: Hevo refreshes the data for all the objects on a rolling basis to update any conversions attributed to clicks within the last 30 days.


Schema and Primary Keys

Hevo uses the following schema to upload the records in the Destination:


Data Model

Hevo uses the following data model to ingest data from your Apple Search Ads account:

Table Description
Ad Group Contains all the ad group entities associated with a campaign, and the ad group for each campaign group.
AdGroup Report Contains daily report of each ad group.
Campaign Group Contains all the campaign groups and the Access Control List(ACL) of the authenticated Apple Search Ads account.
Campaign Contains details about all the campaigns assigned to a campaign group.
Campaign Report Contains daily report of each searched campaign.
Creative Set Report Contains daily report of creative sets used in your campaign.
Keyword Report Contains daily report of each keyword associated with an Ad Group.
Search Terms Report Contains daily report of search terms used in the App Store.
Targeting Keyword Contains details about the targeting keywords associated with each ad group. Targeting keywords display ads based on relevant search terms used.

Limitations

None.


Revision History

Refer to the following table for the list of key updates made to this page:

Date Release Description of Change
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.
Last updated on 22 Oct 2021