Apple Search Ads
This page contains the setup guide and reference information for the Apple Search Ads source connector.
Setup guide
Step 1: Set up Apple Search Ads
- With an administrator account, create an API user role from the Apple Search Ads UI.
- 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
- Log in to your Airbyte Open Source account.
- Click Sources and then click + New source.
- On the Set up the source page, select Apple Search Ads from the Source type dropdown.
- Enter a name for your source.
- For Org Id, enter the Id of your organization (found in the Apple Search Ads UI).
- Enter the Client ID and the Client Secret from Step 1.
- 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.
- Click Set up source.
Supported sync modes
The Apple Search 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 Search Ads API.
Base streams
Report Streams
Report aggregation
The Apple Search 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.
Reference
Config fields reference
Field
Type
Property name
integer
org_id
string
client_id
string
client_secret
string
start_date
string
end_date
Changelog
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 0.1.1 | 2023-07-11 | 28153 | Fix manifest duplicate key (no change in behavior for the syncs) |
| 0.1.0 | 2022-11-17 | 19557 | Initial release with campaigns, adgroups & keywords streams (base and daily reports) |