<!--
{
  "availability" : [
    "Apple Ads Platform API: 1.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "apple-ads-platform-api",
  "identifier" : "/documentation/Apple-Ads-Platform-API",
  "metadataVersion" : "0.1.0",
  "role" : "Web Service",
  "symbol" : {
    "kind" : "Web Service",
    "modules" : [
      "Apple Ads Platform API"
    ],
    "preciseIdentifier" : "Apple-Ads-Platform-API"
  },
  "title" : "Apple Ads Platform API"
}
-->

# Apple Ads Platform API

Programmatically manage App Store and Apple Maps advertising campaigns through a single RESTful API.

## Overview

Apple Ads helps people discover and engage with your app or business. With the Apple Ads Platform API, you can build campaigns with budgets, and create ad groups that include keywords, audience refinement criteria, and scheduling. Through a single RESTful interface, you can also create and manage ads and creative assets, configure targeting and bidding, and monitor performance through reports, insights, and recommendations.

New to the API? Start with the workflow guides. [Advertising Your App on the App Store](/documentation/apple-ads-platform-api/journey-app-store-ads) and [Advertising Your Business on Apple Maps](/documentation/apple-ads-platform-api/journey-apple-maps-brand-ads) walk you through launching your first campaign on each placement.

## Topics

### Essentials

[Implementing OAuth for the Apple Ads Platform API](/documentation/apple-ads-platform-api/implementing-oauth-for-the-apple-ads-platform-api)

Generate a key pair and request an access token to authenticate with the Apple Ads Platform API.

[Calling the Apple Ads Platform API](/documentation/apple-ads-platform-api/calling-apple-ads-platform-api)

Authenticate requests, structure endpoint calls, and interpret responses when using the Apple Ads Platform API.

[Using Client Libraries](/documentation/apple-ads-platform-api/client-libraries)

Integrate the Apple Ads Platform API using an Apple-maintained client library instead of a custom HTTP client.

[Applying Rate Limits](/documentation/apple-ads-platform-api/rate-limits)

Track your remaining quota and pace requests.

[Advertising Your App on the App Store](/documentation/apple-ads-platform-api/journey-app-store-ads)

Set up and launch an App Store campaign, from account verification through keyword targeting to performance reporting.

[Advertising Your Business on Apple Maps](/documentation/apple-ads-platform-api/journey-apple-maps-brand-ads)

Identify your brand, upload creative assets, build location groups, and create campaigns, ad groups, creatives, and ads to promote it on Apple Maps.

### Account Management

[Managing Ad Accounts and API Access](/documentation/apple-ads-platform-api/access-overview)

Authenticate your requests, scope them to an ad account, and apply role-based access levels.

[Org & Me Endpoints](/documentation/apple-ads-platform-api/org-me)

Retrieve the authenticated user’s identity, organization details, and ad account access list.

[Ad Account Endpoints](/documentation/apple-ads-platform-api/ad-account-endpoints)

Create, retrieve, and update ad accounts, and discover delegable advertiser resources.

[Account Management Data Objects](/documentation/apple-ads-platform-api/account-management-data-objects)

Reference the data objects for account management, access control, and organization resources.

[Account Management Data Types](/documentation/apple-ads-platform-api/account-management-data-types)

Reference the enumerations and scalar types for account management, access control, and organization resources.

### Search Apps

[Search Apps Endpoints](/documentation/apple-ads-platform-api/search-apps-endpoints)

Browse the endpoints for searching apps and retrieving app details.

[Search Apps Data Objects](/documentation/apple-ads-platform-api/search-apps-data-objects)

Browse the response objects returned by the search apps and app details endpoints.

### App Eligibility

[App Eligibility Endpoints](/documentation/apple-ads-platform-api/app-eligibility-endpoints)

Check whether apps qualify to run ads and look up rejection reasons for creatives.

[App Eligibility Data Objects](/documentation/apple-ads-platform-api/app-eligibility-data-objects)

Reference the request and response objects used by the app eligibility and rejection reason endpoints.

### Ads on Apple Maps

[Ads on Apple Maps Endpoints](/documentation/apple-ads-platform-api/brands-endpoints)

Query and retrieve brands, business categories, and creative rejection reasons.

[Managing Location Groups](/documentation/apple-ads-platform-api/location-groups-overview)

Organize business locations into named groups that define which locations an ad group’s targeting applies to in Apple Maps campaigns.

[Understanding Locations](/documentation/apple-ads-platform-api/locations-overview)

Query and inspect the business locations associated with your brand for use in Apple Maps campaigns.

[Brands Data Objects](/documentation/apple-ads-platform-api/brands-data-objects)

Reference the request and response objects for brand, location, and location group endpoints.

[Brands Data Types](/documentation/apple-ads-platform-api/brands-data-types)

Look up the enumerations and metric types used in Apple Maps campaigns.

### Campaigns

[Campaigns Endpoints](/documentation/apple-ads-platform-api/campaigns-endpoints)

Create, retrieve, update, and delete campaigns using these endpoints.

[Campaigns Data Objects](/documentation/apple-ads-platform-api/campaigns-data-objects)

Reference the request and response schemas for creating, retrieving, and updating campaigns.

[Campaigns Data Types](/documentation/apple-ads-platform-api/campaign-data-types)

Look up the enumerated values and scalar types used across campaign fields.

### Ad Groups

[Ad Groups Endpoints](/documentation/apple-ads-platform-api/adgroups-endpoints)

Create, retrieve, update, and delete ad groups.

[Ad Groups Data Objects](/documentation/apple-ads-platform-api/adgroups-data-objects)

Reference the request and response objects for ad group endpoints.

[Ad Groups Data Types](/documentation/apple-ads-platform-api/adgroups-data-types)

Reference the enumerations and scalar types for ad groups.

### Geo Targeting

[Geo Targeting Endpoints](/documentation/apple-ads-platform-api/geo-targeting-endpoints)

Retrieve geographic location metadata used for geo targeting.

[Geo Targeting Data Objects](/documentation/apple-ads-platform-api/geo-targeting-data-objects)

Reference the request and response objects for geo targeting.

[Geo Targeting Data Types](/documentation/apple-ads-platform-api/geo-targeting-data-types)

Reference the enumerations and scalar types for geo targeting.

### Keywords

[Managing Keywords and Negative Keywords](/documentation/apple-ads-platform-api/keywords-and-negative-keywords)

Create and manage keywords and negative keywords for ad groups and campaigns.

[Keywords Endpoints](/documentation/apple-ads-platform-api/keywords-endpoints)

Endpoints for creating, retrieving, updating, and deleting keywords.

[Negative Keywords Endpoints](/documentation/apple-ads-platform-api/negative-keywords-endpoints)

Endpoints for creating, retrieving, updating, and deleting negative keywords.

[Keywords Data Objects](/documentation/apple-ads-platform-api/keywords-data-objects)

Request, response, and data objects for managing keywords in ad group campaigns.

[Negative Keywords Data Objects](/documentation/apple-ads-platform-api/negative-keywords-objects)

Request and response objects for negative keyword endpoints.

[Keywords Shared Data Types](/documentation/apple-ads-platform-api/keywords-shared-data-types)

Shared enumerations used by keyword and negative keyword objects.

### Ads

[Ads Endpoints](/documentation/apple-ads-platform-api/ads-endpoints)

Create, retrieve, update, and delete ads using these endpoints.

[Ads Data Objects](/documentation/apple-ads-platform-api/ads-data-objects)

Reference the request and response objects used by ad endpoints.

[Ads Data Types](/documentation/apple-ads-platform-api/ads-data-types)

Reference the enumerations and scalar types used by ad objects and endpoints.

### Creatives

[Creatives Endpoints](/documentation/apple-ads-platform-api/creatives-endpoints)

Create, retrieve, update, and delete ad creatives through these endpoints.

[Ad Creatives Data Objects](/documentation/apple-ads-platform-api/creatives-data-objects)

Reference the request and response payloads used by ad creative endpoints.

[Ad Creative Data Types](/documentation/apple-ads-platform-api/creative-data-types)

Look up the allowed values for creative type, status, and destination type fields.

### Assets

[Assets Endpoints](/documentation/apple-ads-platform-api/assets-endpoints)

Upload, query, retrieve, and delete Apple Maps creative assets.

[Assets Data Objects](/documentation/apple-ads-platform-api/assets-data-objects)

Reference the request and response objects for asset endpoints.

[Assets Data Types](/documentation/apple-ads-platform-api/assets-data-types)

Look up the enumerations and scalar types used for assets.

### Product Pages

[Product Pages Endpoints](/documentation/apple-ads-platform-api/product-pages-endpoints)

Retrieve product pages and their localized details.

[Product Pages Data Objects](/documentation/apple-ads-platform-api/product-pages-data-objects)

Reference the response objects returned by product page endpoints.

### Bulk Operations

[Bulk Operations Endpoints](/documentation/apple-ads-platform-api/bulk-operations-endpoints)

Create and update keywords and negative keywords in bulk.

[Bulk Data Objects](/documentation/apple-ads-platform-api/bulk-data-objects)

Use these objects to build bulk keyword and negative keyword requests and read their responses.

### Budget Orders

[Budget Orders Endpoints](/documentation/apple-ads-platform-api/budget-orders-endpoints)

Create, retrieve, update, and delete budget orders through these endpoints.

[Budget Order Data Objects](/documentation/apple-ads-platform-api/budget-orders-data-objects)

Use these objects to build budget order requests and read their responses.

[Budget Order Data Types](/documentation/apple-ads-platform-api/budget-orders-data-types)

Track budget order status, status reasons, and payment model with these enumerated types.

### Reports

[Managing Reports](/documentation/apple-ads-platform-api/reports)

Retrieve performance data for campaigns, ad groups, ads, keywords, and search terms.

[App Store Reports Endpoints](/documentation/apple-ads-platform-api/apps-reports-endpoints)

Endpoints for retrieving App Store campaign, ad group, ad, keyword, and search term performance data.

[Brands Reports Endpoints](/documentation/apple-ads-platform-api/brands-reports-endpoints)

Retrieve performance data for Apple Maps campaigns, ad groups, ads, keywords, and search terms.

[Apps Data Objects](/documentation/apple-ads-platform-api/apps-reports-objects)

Request, response, and metadata objects for Apps report endpoints.

[Brands Data Objects](/documentation/apple-ads-platform-api/brands-reports-objects)

Explore the request, response, and metadata objects that Brands report endpoints use.

[Shared Objects](/documentation/apple-ads-platform-api/reports-shared-objects)

Shared request and response objects used across Apps and Brands report endpoints.

### Insights

[Insights Endpoints](/documentation/apple-ads-platform-api/insights-endpoints)

Query impression share and search term popularity data for your apps.

[Insights Data Objects](/documentation/apple-ads-platform-api/insights-data-objects)

Build the request and response objects for impression share and search term popularity queries.

### Recommendations

[Recommendations Endpoints](/documentation/apple-ads-platform-api/recommendations-endpoints)

Endpoints for querying, applying, and dismissing budget and Target CPA recommendations.

[Recommendations Data Objects](/documentation/apple-ads-platform-api/recommendations-data-objects)

Request and response objects for recommendation endpoints.

[Recommendations Query and Filter Objects](/documentation/apple-ads-platform-api/recommendations-query-filter-objects)

Query, filter, pagination, and sorting objects for recommendation requests.

### Suggestions

[Suggestions Endpoints](/documentation/apple-ads-platform-api/suggestions-endpoints)

Endpoints for querying keyword, phrase, category, and Target CPA suggestions.

[Suggestions Data Objects](/documentation/apple-ads-platform-api/suggestions-data-objects)

Response objects for keyword, phrase, category, and Target CPA suggestion endpoints.

### Change History

[Change History Endpoints](/documentation/apple-ads-platform-api/change-history-endpoints)

Query audit summaries and retrieve change detail records for entities in an ad account.

[Change History Response Objects](/documentation/apple-ads-platform-api/change-history-response-objects)

Parse the audit summary and change detail objects returned by change history endpoints.

[Change History Query Objects](/documentation/apple-ads-platform-api/change-history-query-objects)

Build the filter, sort, and pagination inputs for change history query requests.

[Change History Enumerations](/documentation/apple-ads-platform-api/change-history-enumerations)

Look up the enumerated values accepted in change history query and response fields.

### Changelog

[Apple Ads Platform API Changelog](/documentation/apple-ads-platform-api/changelog-apple-ads-platform-api)

A log of changes to the Apple Ads Platform API.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)