Skip to main content

Apple Search Ads

info

API Documentation: Apple Search Ads API Documentation

The Apple Search Ads API allows you to access data related to your advertising campaigns on the Apple Search Ads platform. This connector syncs both entity data (for example, campaigns, ad groups, keywords) and performance reporting data (for example, impressions, taps, spend) at multiple levels.

Source Setup Guide​

This connector uses an OAuth-based setup:

  1. Click Connect with Apple.
  2. Authenticate with an Apple Search Ads user (preferably an admin).
  3. Grant Extract the necessary permissions to read campaign performance.
  4. Approve the connection.

Apple Search Ads enforces date range and lookback limits that vary by report granularity. If you request a range outside these limits, the sync may fail or return incomplete data.

  • Hourly
    • Maximum range: 7 days
    • Maximum lookback: 30 days
  • Daily
    • Maximum range: 90 days
    • Maximum lookback: 90 days
  • Weekly
    • Minimum range: 14 days
    • Maximum range: 365 days
    • Maximum lookback: ~24 months
  • Monthly
    • Minimum range: ~3 months
    • Maximum lookback: ~24 months

Connection Setup Guide​

After connecting Apple Search Ads to a destination, configure the connection:

  • Connection Pull Schedule: How frequently data is extracted from the source.
  • Backfill (Days): How many days of historical data to retrieve on each run.
    • Apple Search Ads enforces maximum lookback windows depending on report granularity (for example, hourly reporting has a shorter lookback than daily/weekly/monthly). If your backfill exceeds what the API allows for the selected report granularity, Extract will only be able to retrieve data within the API’s supported lookback.
  • Organizations Whitelist: Select specific organizations to sync, or sync all organizations.
  • Destination-specific settings: Settings such as dataset name / target schema (depends on destination).
  • Schema Migration Policy: How Extract handles schema changes from the source.

Connector Information​

info

Sync behavior and limits​

  • Reporting date chunking: To stay within API constraints, reporting data is fetched in date ranges (“chunks”).
    • Most report streams are fetched in 90-day chunks.
    • Impression Share reporting is fetched in 30-day chunks.
  • Rate limits / quota: Sync throughput depends on your Apple Search Ads API quota and account size (number of orgs, campaigns, etc.).

Important notes​

  • Apple Search Ads has two solutions: Advanced and Basic (see differences).
    • Campaigns running on Basic are not supported by Apple’s reporting API, so Extract cannot report costs for those campaigns.
  • Timezone: By default, Extract pulls reporting data in the timezone configured in the Apple Search Ads dashboard.

Schema ERD​

Explore the interactive entity relationship diagram for Apple Search Ads.

Open page

Data Streams​

ad_level_report​

Loading ....
Loading ....

adgroup_level_report​

Loading ....

adgroup​

Loading ....

adgroup.todo​

Loading ....

app​

Loading ....

campaign_level_report​

Loading ....

campaign​

Loading ....

creative​

Loading ....

impression_share_report​

Loading ....

keyword_level_report​

Loading ....

keyword​

Loading ....

negative_keyword​

Loading ....

organization​

Loading ....

product_page​

Loading ....

searchterm_level_report​

Loading ....