Apple Search Ads API

By Sai Srujan Reddy
4 min read

Table of Contents

Learn how Apple Search Ads helps people discover your app on the App Store. It’s the efficient and easy way to be seen at the top of App Store search.

API Overview

Apple Search Ads is a powerful tool that helps businesses promote their apps and services on the App Store. With Apple Search Ads, businesses can create and manage ad campaigns that target users based on their search queries. The application provides a user-friendly interface that makes it easy to create and manage ad campaigns, as well as track their performance. Apple Search Ads is an effective way for businesses to reach new customers and grow their app revenue.

Apple Search Ads API is a RESTful API that allows developers to automate tasks and integrate Apple Search Ads data into their own applications. The API provides access to a wide range of data, including campaign performance, keyword data, and search term data. Developers can use the API to create custom reports, automate campaign management tasks, and integrate Apple Search Ads data into their own CRM or analytics systems. The API also supports webhooks, which allow developers to receive real-time updates on campaign performance. Apple Search Ads API is subject to rate limits to ensure the stability and performance of the service.

API Request Limits

SDKs

APIs

Campaigns

Method: GET

Description: Get campaign information..

Endpoint: /v1/campaigns/{campaignId}

Parameters: campaignId

Audiences

Method: GET

Description: Get list of audiences..

Endpoint: /v1/audiences

Parameters: campaignId

Keywords

Method: GET

Description: Get a list of the most popular keywords..

Endpoint: /v1/keywords

Parameters: campaignId

Metrics

Method: GET

Description: Get information about performance metrics..

Endpoint: /v1/metrics

Parameters: campaignId

AdGroups

Method: GET

Description: Get all ad groups..

Endpoint: /v1/campaigns/{campaignId}/adGroups

Parameters: campaignId

Keywords

Method: POST

Description: Create a new keyword..

Endpoint: /v1/campaigns/{campaignId}/adGroups/{adGroupId}/keywords

Parameters: campaignId, adGroupId

Keywords

Method: PUT

Description: Update the state of a keyword..

Endpoint: /v1/campaigns/{campaignId}/adGroups/{adGroupId}/keywords

Parameters: campaignId, adGroupId

Reports

Method: POST

Description: Create a report request..

Endpoint: /v1/campaigns/{campaignId}/reports

Parameters: campaignId

Keywords

Method: DELETE

Description: Delete keyword..

Endpoint: /v1/campaigns/{campaignId}/adGroups/{adGroupId}/keywords/{keywordId}

Parameters: campaignId, adGroupId, keywordId

Keywords

Method: GET

Description: Get all keywords..

Endpoint: /v1/campaigns/{campaignId}/adGroups/{adGroupId}/keywords

Parameters: campaignId, adGroupId

AdGroups

Method: POST

Description: Create an ad group..

Endpoint: /v1/campaigns/{campaignId}/adGroups

Parameters: campaignId

AdGroups

Method: PUT

Description: Update the state of an ad group..

Endpoint: /v1/campaigns/{campaignId}/adGroups

Parameters: campaignId

Campaigns

Method: POST

Description: Create a new campaign..

Endpoint: /v1/campaigns

Parameters: None

AdGroups

Method: GET

Description: Get all ad groups..

Endpoint: /v1/campaigns/{campaignId}/adGroups/{adGroupId}

Parameters: campaignId, adGroupId

Campaigns

Method: PUT

Description: Update the state of a campaign..

Endpoint: /v1/campaigns/{campaignId}

Parameters: campaignId

CreativeSets

Method: GET

Description: Get all creative sets..

Endpoint: /v1/campaigns/{campaignId}/creativeSets

Parameters: campaignId

Keywords

Method: GET

Description: Get all keywords..

Endpoint: /v1/campaigns/{campaignId}/adGroups/{adGroupId}/keywords/{keywordId}

Parameters: campaignId, adGroupId, keywordId

CreativeSets

Method: POST

Description: Create a creative set..

Endpoint: /v1/campaigns/{campaignId}/creativeSets

Parameters: campaignId

Keywords

Method: GET

Description: Get list of the top keywords..

Endpoint: /v1/keywords

Parameters: None

Keywords

Method: PATCH

Description: Update the state of a keyword..

Endpoint: /v1/campaigns/{campaignId}/adGroups/{adGroupId}/keywords/{keywordId}

Parameters: campaignId, adGroupId, keywordId

AppStoreCharts

Method: GET

Description: Get a list of top charts..

Endpoint: /v1/appStoreCharts

Parameters: country, genre, subGenre, platform

Audiences

Method: GET

Description: Use this request to get the audiences that are available for use as targets in Apple Search Ads..

Endpoint: /v1/audiences

Parameters: None

Reports

Method: GET

Description: Get a list of all report requests..

Endpoint: /v1/campaigns/{campaignId}/reports

Parameters: campaignId

Reports

Method: GET

Description: Retrieve report data..

Endpoint: /v1/reports/{reportId}

Parameters: reportId

CreativeSets

Method: PUT

Description: Update the state of a creative set..

Endpoint: /v1/campaigns/{campaignId}/creativeSets/{creativeSetId}

Parameters: campaignId, creativeSetId

Keywords

Method: GET

Description: Get a list of the most popular Search Match variants..

Endpoint: /v1/keywords/searchMatch

Parameters: campaignId

CampaignSearchTerms

Method: GET

Description: Retrieve data about the search terms associated with a campaign..

Endpoint: /v1/campaigns/{campaignId}/campaignSearchTerms

Parameters: campaignId

AppStoreCharts

Method: GET

Description: Get a list of top charts..

Endpoint: /v1/appStoreCharts/developer

Parameters: developerId, platform

FAQ

To authenticate to the Apple Search Ads APIs

The Apple Search Ads APIs implement a tiered rate limit system

To create a sandbox account for testing Apple Search Ads

The developer account in Apple Search Ads allows you to manage your apps and campaigns

If you need help with the Apple Search Ads APIs

Last Update: September 18, 2024