To begin using Apple Ads as a data source, you’ll first need to set up access through the Apple Ads platform:
Sign in with an administrator account and create an API user role within the Apple Ads interface.
Configure OAuth authentication for this user to obtain the required Client ID and Client Secret for API access.
Connecting Apple Search Ads in xGen
Follow the steps below to configure Apple Search Ads as a data source:
In the source setup section, choose Apple Ads from the Source type dropdown.
Provide a custom name for the connector to help identify it in your workspace.
Enter your Organization ID, which can be found in your Apple Ads dashboard.
Supply the Client ID and Client Secret that were generated during OAuth setup.
Input the Start Date and optionally the End Date in the YYYY-MM-DD format.
Note: For DAILY reports, the start date must be within the past 90 days.
If no end date is provided, data will sync up to the current date.
To avoid sync failures caused by rate limits when pulling large datasets, consider adjusting the Exponential Backoff Factor to better handle retries.
You may also reduce the Lookback Window to limit the range of data pulled during each incremental sync. Be aware this may exclude delayed attribution data.
Click Set up source to start the integration process.
Supported Sync Modes
The Apple Ads connector offers the following synchronization options:
Mode
Description
Full Refresh – Overwrite
Replaces all existing data
Full Refresh – Append
Adds all retrieved data
Incremental – Append
Adds only newly available records
Incremental – Append + Deduped
Adds new data and removes duplicates
Available Data Streams
Base Entities
campaigns
adgroups
keywords
Reporting Streams
While most reports use date and campaignId as primary keys, in some cases (e.g., countryOrRegion), additional fields may be required to ensure deduplication accuracy.