Skip to main content
Feedback

Apple Search Ads walkthrough

info

Apple SearchAds API version 5 is currently supported.

The Apple SearchAds source provides summarized reports by different levels of granularity, across time zones, and resolutions of your campaigns.

Connection

  • To connect Apple SearchAds with your destination, follow our step-by-step tutorial.
  • Choose a Source Connection after you have created a connection.

Predefined reports

Data Integration provides a convenient entry point and recommended approach for accessing a range of predefined reports for your use. Each report includes a concise data description, a list of customizable fields (if applicable), and the schema mapping.

Since these reports follow a standardized format, you can access specific restricted fields only through Custom Reports.

Custom reports

Select a specific report to pull data from the Apple SearchAds API.

Source API docs are available in Apple SearchAds documentation.

Report names

Filters

  • Account: Optional.  Filter results by account from the accounts list.

  • Campaign:  Optional. Filter results by campaign from the accounts list.

  • Choose Time Period :

    • Time Frame:  You can choose from built-in time frames (Yesterday, Month to date) and set the timezone offset from UTC.
    • Date Range: Choose the starting and ending dates. If the End Date is not chosen, it will pull data until the most recent. Data Integration manages the date range for incremental loading.
    • The Start Date will not be advanced if a River run is unsuccessful.

    If you do not want this default setting, click More Options and select the checkbox to advance the start date even if the River run is unsuccessful (Not recommended).

  • Result Granularity: The time granularity in which the data is pulled. The granularity affects your date column. You can choose between Day, Week, or Month. The data in the date column will be the first date period of the granularity selection (the first date of the week [mon-fri] or the month).

  • Result Time Zone: The time zone for which the data is pulled. UTC|ORTZ (Organization Timezone).

  • Group Report- Group your data given:

    • countryCode
    • adminArea - Will group the data by countryCode + adminArea
    • ageGroup
    • deviceClass

  • Return Results without Metrics: Select this if you want AppleAds to return data for campaigns without metrics.

Granularity limit

  • Hourly: The startTime and endTime is <= 7 days apart and the startTime is <= 30 days in the past.
  • Daily: The startTime and endTime is <= 90 days apart and the startTime is <= 90 days is in the past.
  • Weekly: The startTime and endTime is > 14 days and <= 365 days apart and the startTime is <= 24 months in the past.
  • Monthly: The startTime and endTime is > 3 months apart and the startTime is <= 24 months in the past.
note

The Search Terms report includes only search terms with at least 10 impressions on a given day for a specific campaign to be a part of the output results set.

On this Page