Apple Search Ads (Edge)

Configure Apple Search Ads as a Source in your Pipeline

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

1. Click Pipelines in the Navigation Bar.

2. Click + Create Pipeline in the Pipelines List View.

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

4. On the Select Destination Type page, select the type of Destination you want to use.

5. On the Select Pipeline Type page, click Edge, and then click Continue.

   

   This page appears only if the selected Destination type is supported in Edge and your Team has an existing Apple Search Ads Pipeline with the same Destination type. Otherwise, you can proceed to create an Edge Pipeline.

6. In the Connect to your Apple Search Ads account section, specify the following:

   

   • Client ID: The clientId generated from your Apple Search Ads account.

   • Team ID: The teamId generated from your Apple Search Ads account.

   • Key ID: The keyId generated from your Apple Search Ads account.

   • Click Authenticate With Apple Search Ads to authenticate Hevo with your Apple Search Ads account.

7. In the Sync Settings section:

   

   • Sync Mode: Choose whether to sync data from all organizations or only specific organizations.

     • Sync All Organizations: Hevo syncs data for all existing and new organizations accessible to the API user.

     • Sync Specific Organizations: Hevo ingests data only for the organizations you select from the Organizations to sync drop-down.

       

   • In the Report Settings section:

     • Report data time zone: The time zone Apple uses to group report data by day.

     • Show records with no metrics: Enable this option to load rows for days with no activity in the campaign, ad group, keyword, and ad-level reports. This may significantly increase your Event usage.

     • Historical Sync Duration: The duration for which you want to ingest existing data from the Source. Default value: 12 months.

   • In the Custom Reports section, click + Add Report to add a report, and specify the following for each report:

     

     • Report Name: A unique name for the Destination table where Hevo loads the data for this report.

     • Report type: The type of Apple Search Ads data you want to ingest.

     • Dimensions: The attributes used to break down the report data.

   Note:

   • Click Save after configuring each report. Reports that are not saved before you click Test & Continue are not included in the Pipeline.

   • If you add a new custom report or edit an existing one after the Pipeline is created, resync the corresponding object to apply the changes and load the data using the updated configuration.

8. Click Test & Continue to test the connection to your Apple Search Ads Source. Once the test is successful, you can proceed to set up your Destination.

---

Data Replication

Hevo replicates data for all the objects selected on the Configure Objects page during Pipeline creation. By default, all supported objects and their available fields are selected. However, you can modify this selection while creating or editing the Pipeline.

Hevo ingests the following types of data from your Source objects:

• Historical Data: The first run of the Pipeline ingests historical data for the selected objects, based on the Historical Sync Duration specified when creating the Pipeline, and loads it into the Destination.

• Incremental Data: Once the historical load is complete, new and updated records for objects are ingested as per the sync frequency.

For the following objects, Hevo ingests only the incremental data in subsequent Pipeline runs:

• Ad Group Report

• Ad Level Report

• Campaign Report

• Impression Share Report

• Keyword Report

• Search Term Report

For all other objects, Hevo ingests the entire data during each Pipeline run.

Apple Search Ads enforces a rate limit on the number of requests that can be made to its API in a given period of time. If this limit is exceeded, a rate limit exception occurs. To understand how Hevo handles such scenarios, read Handling Rate Limit Exceptions.

Note: You can create a Pipeline with this Source only using the Merge load mode. The Append mode is not supported for this Source.

---

Schema and Primary Keys

Hevo uses the following schema to upload the records to the Destination. For a detailed view of the objects, fields, and relationships, click the ERD.

---

Data Model

The following is the list of tables (objects) that are created at the Destination when you run the Pipeline: