Article

Search Ads API Release Notes

Make adjustments to your API implementation.

Overview

The current version of the Apple Search Ads Campaign Management API is 2.1.

Version	Release Date
2.1	November, 2019
2.0	March, 2019

Updated Creative Sets Functionality

API version 2.1 includes additional support for Creative Sets. New features include:

Creating new Creative Sets and linking to an ad group.
Reassigning Creative Sets to an ad group.
Retrieving app assets linked to Creative Sets used in campaigns.
Deleting Creative Sets linked to ad groups.

Deprecation of Search Ads API 1.0

As of October, 2019, the Apple Search Ads Campaign Management API 1.0 is deprecated. A 301 RESOURCE_MOVED_PERMANENTLY error will result if you use a 1.0 endpoint. API usage requires version 2.x.

Storefront Terminology

As of Apple Search Ads Campaign Management API 2.0 release, Storefront terminology has changed. Version 2.0 broadens international support by allowing advertisers to include multiple countries or regions within a single campaign. App Store territories are now reflected as follows.

countriesOrRegions: Used in the Campaign object.
countriesOrRegions: Used in the ReportingCampaign object.
countryOrRegion: Used as a groupBy dimension in the ReportingRequest object.

Reports Fields

Report field changes are as follows. See ExtendedSpendRow and SpendRow for field descriptions.

API 2.0 Report Field Term	API 1.0 Report Field Term
i`nstalls`	`conversions`
`latOnInstalls`	`conversionsLATOn`
`latOffInstalls`	`conversionsLATOff`
`newDownloads`	`conversionsNewDownloads`
`redownloads`	`conversionsRedownloads`

Decoupled Objects

Negative keywords and ad groups have been decoupled from the campaign object.
Negative keywords and targeting keywords have been decoupled from ad groups.

Removed Fields

The following Apple Search Ads Campaign Management 1.0 fields have been removed from the corresponding API object and do not apply to 2.0.

referenceLabel: Campaign object
locInvoiceDetails.billingContactName: Campaign object
ageCriteria.excluded: TargetingDimensions object
genderCriteria.excluded: TargetingDimensions object
adminAreaCriteria.excluded: TargetingDimensions object
localityCriteria.excluded: TargetingDimensions object
deviceClassCriteria.excluded: TargetingDimensions object
daypartCriteria.userTime.excluded: TargetingDimensions object