ContextQMD
Back to Airbyte

Apple Ads (Apple Search Ads)

docs/integrations/sources/apple-search-ads.md

2.0.012.3 KB
Original Source

Apple Ads (Apple Search Ads)

This page contains the setup guide and reference information for the Apple Ads source connector.

Setup guide

Step 1: Set up Apple Ads

  1. With an administrator account, create an API user role from the Apple Ads UI.
  2. Then implement OAuth for your API user in order to the required Client Secret and Client Id.

Step 2: Set up the source connector in Airbyte

For Airbyte Open Source

  1. Log in to your Airbyte Open Source account.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Apple Ads from the Source type dropdown.
  4. Enter a name for your source.
  5. For Org Id, enter the Id of your organization (found in the Apple Ads UI).
  6. Enter the Client ID and the Client Secret from Step 1.
  7. For Start Date and End Date, enter the date in YYYY-MM-DD format. For DAILY reports, the Start Date can't be earlier than 90 days from today. If the End Date field is left blank, Airbyte will replicate data to today.
  8. For Time Zone, select either UTC (Coordinated Universal Time) or ORTZ (Organization Time Zone). The default is UTC.
  9. For Lookback Window, enter the number of days (1-30) to re-fetch data during incremental syncs. The default is 30 days, which matches Apple Search Ads' attribution window. You can decrease this value to sync smaller amounts of data on each incremental sync, but this may result in missing late data attributions.
  10. For Exponential Backoff Factor, enter a value between 1 and 20 to control the delay between retry attempts when rate limits are encountered. The default is 5. Increase this value when syncing large amounts of data to reduce the chance of synchronization failures.
  11. Click Set up source.

Supported sync modes

The Apple Ads source connector supports the following sync modes:

Supported Streams

The Apple Ads source connector supports the following streams. For more information, see the Apple Ads API.

Base streams

Report Streams

::: note The usual primary keys for reports are date and campaignId. However, there are cases where active fields must be selected as primary keys to ensure data deduplication is correct. One example is countryOrRegion. :::

Report aggregation

The Apple Ads currently offers aggregation at hourly, daily, weekly, or monthly level.

However, at this moment and as indicated in the stream names, the connector only offers data with daily aggregation.

Changelog

<details> <summary>Expand to review</summary>
VersionDatePull RequestSubject
1.0.92026-03-1074512Update dependencies
1.0.82026-03-0374180Update dependencies
1.0.72026-02-0372690Update dependencies
1.0.62026-01-2071888Update dependencies
1.0.52026-01-1471435Update dependencies
1.0.42025-12-1870810Update dependencies
1.0.32025-11-2569891Update dependencies
1.0.22025-11-1869577Update dependencies
1.0.12025-10-2968392Update dependencies
1.0.02025-10-2166557Update adgroups_report_daily and keywords_report_daily to use global state cursor
0.8.102025-10-1467979Update dependencies
0.8.92025-10-0767173Update dependencies
0.8.82025-09-3066272Update dependencies
0.8.72025-09-12TBDUpdate to CDK v7
0.8.62025-08-2365312Update dependencies
0.8.52025-08-0964663Update dependencies
0.8.42025-07-1963453Update dependencies
0.8.32025-07-1263087Update dependencies
0.8.22025-06-1561626Update dependencies
0.8.12025-05-1760627Update dependencies
0.8.02025-05-1360241Add token refresh endpoint override configuration override
0.7.92025-05-1059888Update dependencies
0.7.82025-05-0359308Update dependencies
0.7.72025-04-2658712Update dependencies
0.7.62025-04-1958275Update dependencies
0.7.52025-04-1257658Update dependencies
0.7.42025-04-0557158Update dependencies
0.7.32025-03-2956573Update dependencies
0.7.22025-03-2556383add countryorregion to report schemas
0.7.12025-03-2256109Update dependencies
0.7.02025-03-2055839countryOrRegion metadata info included
0.6.02025-03-2055785Add timezone config parameter
0.5.12025-03-0855366Update dependencies
0.5.02025-03-0555210Remove primary keys
0.4.32025-03-0154873Update dependencies
0.4.22025-02-2454646Fix paginator settings for incremental report streams
0.4.12025-02-2254284Update dependencies
0.4.02025-02-2054170Externalize backoff factor and lookback window configurations
0.3.32025-02-1553920Update dependencies
0.3.22025-02-1453685Fix granularity to daily
0.3.12025-02-0853422Update dependencies
0.3.02025-02-0353136Update API version to V5
0.2.92025-02-0152899Update dependencies
0.2.82025-01-2552197Update dependencies
0.2.72025-01-1851745Update dependencies
0.2.62025-01-1151249Update dependencies
0.2.52024-12-2850469Update dependencies
0.2.42024-12-2150155Update dependencies
0.2.32024-12-1449561Update dependencies
0.2.22024-12-1247751Update dependencies
0.2.12024-11-0848440Set authentication grant_type to client_credentials
0.2.02024-10-0146288Migrate to Manifest-only
0.1.202024-09-2846153Update dependencies
0.1.192024-09-2145803Update dependencies
0.1.182024-09-1445474Update dependencies
0.1.172024-09-0745326Update dependencies
0.1.162024-08-3145013Update dependencies
0.1.152024-08-2444654Update dependencies
0.1.142024-08-1744322Update dependencies
0.1.132024-08-1243912Update dependencies
0.1.122024-08-1043514Update dependencies
0.1.112024-08-0343195Update dependencies
0.1.102024-07-2742660Update dependencies
0.1.92024-07-2042225Update dependencies
0.1.82024-07-1341722Update dependencies
0.1.72024-07-1041546Update dependencies
0.1.62024-07-0940832Update dependencies
0.1.52024-06-2540364Update dependencies
0.1.42024-06-2240186Update dependencies
0.1.32024-06-0438967[autopull] Upgrade base image to v1.2.1
0.1.22024-05-2138502[autopull] base image + poetry + up_to_date
0.1.12023-07-1128153Fix manifest duplicate key (no change in behavior for the syncs)
0.1.02022-11-1719557Initial release with campaigns, adgroups & keywords streams (base and daily reports)
</details>