Apple SearchAds Walkthrough

Apple SearchAds API version 4 is currently supported

Introduction

The Apple SearchAds source provides summarized reports by different granularities, 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've created a connection, as seen here:

Predefined Reports

Rivery 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, specific fields are restricted and can only be accessed through Custom Reports.

Custom Reports

Select a specific report to pull data from the Apple SearchAds API.
The following image provides an overview of the various custom reports:

Source API docs can be found in Apple SearchAds documentation.

Report Names

• Campaigns
• AdGroups
• Keywords
• Searchterms

Filters

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

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

• Choose Time Period Required.

  • 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 End Date has not been chosen, it will pull data until the most recent. The date range is managed by Rivery for incremental loading.
  • The Start Date won't be advanced if a River run is unsuccessful.
    If you don't want this default setting, click More Options and check the box to advance the start date even if the River run is unsuccessful (Not recommended).
    

• Result Granularity : Required. The time granularity in which the data is pulled. The granularity will affect 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 (i.e - the first date of the week [mon-fri] or the month).

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

• Group Report : Optional. Group your data given:

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

• Return Results without Metrics : Check this if you want AppleAds to return data for campaigns that don’t have 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.