2025-01 Apple SearchAds Upgrade v5

Starting on January 28th, 2025, Data Integration’s Apple Search Ads integration will be upgraded to leverage Apple Search Ads API v5. This upgrade ensures access to enhanced features, new metrics, and reporting improvements.

Key changes in Apple Search Ads API v5

Reporting enhancements

AdGroups report

• Group by multiple dimensions:
  • Added the ability to group by multiple dimensions for supported endpoints, including the Ad Groups report.
  • For details, refer to the Get Ad Group-Level Reports documentation.

Keyword-level reports

• Get Keyword-Level Reports and Get Keyword-Level within Ad Group Reports:
  • Introduced the suggestedBidAmount field, replacing the deprecated bidMin and bidMax fields.

Search term-level reports

• Get Search Term-Level Reports and Get Search Term-Level within Ad Group Reports:
  • Now require the timezone to be specified as ORTZ.

Campaign creation requirements

• Daily Budget Requirement:
  • A dailyBudgetAmount is now mandatory for all new campaigns.
  • Previously, campaigns could be created with dailyBudgetAmount, budgetAmount, or both.

Campaign report enhancements

• New Fields:
  • endTime
  • startTime
• For further details, refer to the Apple Developer Documentation for Campaigns.

New metrics

• SpendRow
• ExtendedSpendRow

New report

• New report type: All Ads
  • A custom report featuring parameters for Campaign, Account, and date range.
  • For details, refer to the Get All Ads documentation.

Deprecated features

• Creative Sets Endpoints:

  • All endpoints related to Creative Sets are deprecated and unavailable in API v5.

• Creative Sets Report:

  • This report type has been deprecated.

Recommended actions

1. For New Fields:
   Use the "Auto Mapping" option in the Schema tab to update your River’s mapping.

2. For Deprecated Metrics:

   • If no action is taken, deprecated metrics will appear as null values.
   • To remove these metrics from your Target table, update the schema mapping in the Schema tab of your Rivers.

3. Campaign Creation:

   • Ensure that all new campaigns include the mandatory dailyBudgetAmount field.