Apple Ads

Apple Ads Create Creative

Create a new ad creative by linking a Custom Product Page to your organization. One creative per custom product page per organization. After creating a creative, use its ID when creating or updating an ad in an ad group. List custom product pages for the app first to obtain product_page_id.

Apple Ads Create Impression Share Report

Create an Impression Share report for competitive analysis. Shows how your app's impression share compares to competitors for specific search terms. Returns a report ID Returns a report ID to poll until the report completes. Metrics: impression share range (low/high), rank, and search popularity. Max 10 reports per 24 hours, max 30-day span. Use WEEKLY granularity with date_range (not start/end dates).

Apple Ads Delete Ad

Permanently delete an ad from an ad group. CAUTION: This action cannot be undone. Consider updating the ad to set status to PAUSED instead.

Apple Ads Delete Adgroup

Permanently delete an ad group from a campaign. CAUTION: This action cannot be undone. All keywords and ads within the ad group will be removed. Consider updating the ad group to set status to PAUSED instead.

Apple Ads Delete Campaign

Permanently delete an Apple Ads campaign. CAUTION: This action cannot be undone. All ad groups, keywords, and ads within the campaign will be removed. Consider updating the campaign to set status to PAUSED instead.

Apple Ads Delete Keyword

Permanently delete a targeting keyword from an ad group. CAUTION: This action cannot be undone. Consider updating keywords in bulk to set status to PAUSED instead.

Apple Ads Delete Negative Keywords

Permanently delete negative keywords in bulk. CAUTION: This action cannot be undone. Removing negative keywords may cause ads to start showing for previously blocked searches. Pass adgroup_id for ad-group-level, or omit for campaign-level.

Apple Ads Get Adgroup Report

Get performance reports for ad groups within a campaign. Returns metrics per ad group: impressions, taps, tap-through rate, installs, average CPA/CPT, spend, conversion rate. Use to compare ad group performance and identify which targeting strategies work best. Drill into keyword performance reports for keyword-level details.

Apple Ads Get Adgroups

Get ad groups within a campaign. Pass adgroup_id to retrieve a single ad group with full details (name, bid amount, targeting dimensions, status, scheduling), or omit to list all ad groups. Returns ad group IDs needed for keyword and ad listing and for ad group create, update, or delete operations.

Apple Ads Get Ad Rejection Reasons

Find reasons why ad creatives were rejected by Apple. Returns rejection codes, reason types, affected product pages, and Apple's comments. Filter by app (adam_id), product page, country, or supply source. Use when ads have status issues to understand what needs to be fixed in App Store Connect before the ad can run.

Apple Ads Get Ad Report

Get performance reports for individual ads within a campaign. Returns per-ad metrics: impressions, taps, installs, CPA, CPT, spend, conversion rate. Use to compare ad creative performance and identify which creatives drive the most conversions at the lowest cost.

Apple Ads Get Ads

Get ads assigned to an ad group. Pass ad_id to retrieve a single ad with full details (name, creative assignment, status, serving state), or omit to list all ads. Each ad group can have one active ad. Use the ad performance report for performance metrics.

Apple Ads Get App Details

Fetch metadata for an App Store app. Returns app name, developer, categories, and supported countries. Set localized=true for locale-specific product page details including screenshots and app previews per language. Useful for planning which creatives and product pages to use in campaigns.

Apple Ads Get Budget Orders

Get budget orders for the organization. Budget orders cap total spend across campaigns and are available to monthly-invoicing customers. Pass budget_order_id to retrieve a single order, or omit to list all. Returns budget limits, start/end dates, and spend-to-date. Use the user access list to confirm your payment model supports budget orders.

Apple Ads Get Campaign Report

Get performance reports for all campaigns. Returns metrics per campaign: impressions, taps, tap-through rate, installs, new downloads, redownloads, average CPA, average CPT, spend, and conversion rate. Includes row totals for quick summaries. Default: last 7 days, daily granularity. Start here for a high-level performance overview, then drill into ad group performance reports for campaign-specific breakdowns.

Apple Ads Get Campaigns

Get Apple Ads campaigns. Pass campaign_id to retrieve a single campaign with full details (name, budget, status, countries, supply sources), or omit to list all campaigns. Returns campaign IDs needed for ad group listing, campaign performance reports, and campaign create, update, or delete operations.

Apple Ads Get Creatives

Get ad creatives for the organization. Creatives link custom product pages to ads. Pass creative_id to fetch a single creative, or omit to list all. Returns creative ID, name, type, state, associated Adam ID, and product page ID. Use the creative ID when creating or updating ads in an ad group.

Apple Ads Get Impression Share Report

Fetch an Impression Share report by ID, or list all reports. Reports contain competitive metrics: impression share range, rank, and search popularity per search term. Poll after creating an impression share report until state is COMPLETED, then use the downloadUri for full data. States: QUEUED → RUNNING → COMPLETED/FAILED.

Apple Ads Get Keyword Report

Get performance reports for targeting keywords. Returns per-keyword metrics: impressions, taps, installs, CPA, CPT, spend, conversion rate. Pass adgroup_id for keyword metrics within a specific ad group, or omit for campaign-wide keyword performance. Use to identify high-performing keywords to increase bids on and low-performing keywords to pause or reduce bids.

Apple Ads Get Keywords

Get targeting keywords for an ad group. Pass keyword_id to retrieve a single keyword with full details (text, matchType, bidAmount, status), or omit to list all. Up to 5000 targeting keywords allowed per ad group. Use the keyword performance report for performance metrics.

Apple Ads Get Negative Keywords

Get negative keywords that prevent ads from showing for specific search terms. Pass adgroup_id for ad-group-level negatives, or omit for campaign-level. Pass keyword_id to retrieve a single negative keyword, or omit to list all. Negative keywords help eliminate irrelevant traffic and reduce wasted spend.

Apple Ads Get Product Pages

Fetch Custom Product Pages for an app. Product pages are created in App Store Connect and used to create ad creatives for different audiences. Pass product_page_id to get locale-specific details (screenshots, previews). Omit to list all product pages and their IDs. Use those IDs when creating ad creatives.

Apple Ads Get Search Term Report

Get performance reports for actual search terms users typed that triggered your ads. Returns per-search-term metrics: impressions, taps, installs, CPA, spend. Critical for keyword optimization: find high-converting search terms to add as targeting keywords, and irrelevant terms to add as negative keywords. Pass adgroup_id for ad-group-level, or omit for campaign-wide. Default is daily breakdown (granularity=DAILY). Set return_row_totals=true for one aggregated row per search term across the date

Apple Ads Get User Acl

Fetch the roles and organizations the API credentials have access to. Returns organization IDs, names, payment models, and role permissions. Use this to discover available org IDs (needed for report tools), confirm API access level, and see which organizations you can manage.