Apple Search Ads

Availability:

Airbyte Cloud Airbyte OSS PyAirbyte

Support Level:

Marketplace

Connector Version:

0.1.13(Last updated 4 days ago)

CDK Version:

1.0.0

Sync Success Rate:

Usage Rate:

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

1. With an administrator account, create an API user role from the Apple Search 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 Search 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 Search 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. Click Set up source.

Supported sync modes

The Apple Search Ads source connector supports the following sync modes:

• Full Refresh - Overwrite
• Full Refresh - Append
• Incremental - Append
• Incremental - Append + Deduped

Supported Streams

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

Base streams

• campaigns
• adgroups
• keywords

Report Streams

• campaigns_report_daily
• adgroups_report_daily
• keywords_report_daily

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

Expand to review

Version	Date	Pull Request	Subject
0.1.13	2024-08-12	43912	Update dependencies
0.1.12	2024-08-10	43514	Update dependencies
0.1.11	2024-08-03	43195	Update dependencies
0.1.10	2024-07-27	42660	Update dependencies
0.1.9	2024-07-20	42225	Update dependencies
0.1.8	2024-07-13	41722	Update dependencies
0.1.7	2024-07-10	41546	Update dependencies
0.1.6	2024-07-09	40832	Update dependencies
0.1.5	2024-06-25	40364	Update dependencies
0.1.4	2024-06-22	40186	Update dependencies
0.1.3	2024-06-04	38967	[autopull] Upgrade base image to v1.2.1
0.1.2	2024-05-21	38502	[autopull] base image + poetry + up_to_date
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)