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

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.


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


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 following:

    API Key-based settings

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

  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

The following tables (objects) are created in the Destination when you run the Pipeline.

Note: In Pipelines created from Release 1.87 onwards, Hevo also loads the country_or_region field for all the object reports. If you need this field in an existing Pipeline, you need to recreate the Pipeline.

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

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.
Last updated on 02 May 2022