{"abstract":[{"text":"Create, retrieve, update, and delete campaigns using these endpoints.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.apple.documentation\/documentation\/technologies","doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API"]]},"identifier":{"interfaceLanguage":"data","url":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/campaigns-endpoints"},"kind":"article","legalNotices":{"copyright":"Copyright &copy; 2026 Apple Inc. All rights reserved.","privacyPolicy":"https:\/\/www.apple.com\/privacy\/privacy-policy","termsOfUse":"https:\/\/www.apple.com\/legal\/internet-services\/terms\/site.html"},"metadata":{"availableLanguages":["de-DE","en-US","es-419","fr-FR","it-IT","ja-JP","ko-KR","pt-BR","zh-CN"],"modules":[{"name":"Apple Ads Platform API"}],"platforms":[{"introducedAt":"1.0","name":"Apple Ads Platform API"}],"role":"collectionGroup","roleHeading":"API Collection","title":"Campaigns Endpoints"},"primaryContentSections":[{"content":[{"anchor":"Overview","level":2,"text":"Overview","type":"heading"},{"inlineContent":[{"text":"To promote iOS apps in the App Store or brands and locations on Apple Maps, use campaigns.","type":"text"}],"type":"paragraph"},{"anchor":"Use-These-Campaign-Endpoints","level":2,"text":"Use These Campaign Endpoints","type":"heading"},{"inlineContent":[{"text":"The following endpoints create, retrieve, update, and delete campaigns, and return per-country limited-status details for legacy app campaigns:","type":"text"}],"type":"paragraph"},{"header":"row","rows":[[[{"inlineContent":[{"text":"Method","type":"text"}],"type":"paragraph"}],[{"inlineContent":[{"text":"Path","type":"text"}],"type":"paragraph"}],[{"inlineContent":[{"text":"Description","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"code":"POST","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"code":"\/v1\/campaigns","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/POST-campaigns","isActive":true,"type":"reference"},{"text":" creates a new campaign.","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"code":"POST","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"code":"\/v1\/campaigns\/query","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/POST-campaigns-query","isActive":true,"type":"reference"},{"text":" retrieves campaigns matching the specified filters.","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"code":"GET","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"code":"\/v1\/campaigns\/{id}","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/GET-campaigns-_id_","isActive":true,"type":"reference"},{"text":" retrieves a single campaign by its ID.","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"code":"PUT","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"code":"\/v1\/campaigns\/{id}","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/PUT-campaigns-_id_","isActive":true,"type":"reference"},{"text":" updates an existing campaign.","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"code":"DELETE","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"code":"\/v1\/campaigns\/{id}","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/DELETE-campaigns-_id_","isActive":true,"type":"reference"},{"text":" soft-deletes a campaign by its ID.","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"code":"GET","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"code":"\/v1\/campaigns\/{id}\/legacy-app-limited-status-reason-details","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/GET-campaigns-_id_-legacy-app-limited-status-reason-details","isActive":true,"type":"reference"},{"text":" returns per-country limited-status reason details for a legacy app campaign.","type":"text"}],"type":"paragraph"}]]],"type":"table"},{"inlineContent":[{"text":"Both App Store ads and Apple Maps ads share the same campaign, ad group, and reporting infrastructure. They differ in ","type":"text"},{"code":"promotedObjectType","type":"codeVoice"},{"text":", creative requirements, and bid strategy options.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"Every campaign is scoped to a single ad account and identifies its promoted object through two immutable fields set at creation: ","type":"text"},{"code":"promotedObjectType","type":"codeVoice"},{"text":" and ","type":"text"},{"code":"promotedObjectId","type":"codeVoice"},{"text":". For App Store campaigns, ","type":"text"},{"code":"promotedObjectId","type":"codeVoice"},{"text":" is the app’s ","type":"text"},{"code":"adamId","type":"codeVoice"},{"text":". For Apple Maps campaigns, it’s the brand’s unique identifier. Retrieve the brand identifier from ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/Query-Brands","isActive":true,"type":"reference"},{"text":" or from ","type":"text"},{"code":"GET \/v1\/advertiser-resources?resourceType=BUSINESS_BRAND","type":"codeVoice"},{"text":". See ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/POST-campaigns","isActive":true,"type":"reference"},{"text":" for the required fields and payload examples for each campaign type.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"The following table compares how App Store and Apple Maps campaigns differ:","type":"text"}],"type":"paragraph"},{"header":"row","rows":[[[{"inlineContent":[],"type":"paragraph"}],[{"inlineContent":[{"text":"App Store","type":"text"}],"type":"paragraph"}],[{"inlineContent":[{"text":"Apple Maps","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"code":"promotedObjectType","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"code":"APPSTORE_APP","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"code":"BUSINESS_BRAND","type":"codeVoice"}],"type":"paragraph"}]],[[{"inlineContent":[{"text":"What is promoted","type":"text"}],"type":"paragraph"}],[{"inlineContent":[{"text":"An iOS app","type":"text"}],"type":"paragraph"}],[{"inlineContent":[{"text":"A brand and its business locations","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"code":"supplyPlacement","type":"codeVoice"},{"text":" values","type":"text"}],"type":"paragraph"}],[{"inlineContent":[{"code":"APPSTORE_SEARCH_RESULTS","type":"codeVoice"},{"text":", ","type":"text"},{"code":"APPSTORE_TODAY_TAB","type":"codeVoice"},{"text":", ","type":"text"},{"code":"APPSTORE_SEARCH_TAB","type":"codeVoice"},{"text":", ","type":"text"},{"code":"APPSTORE_PRODUCT_PAGES","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"code":"MAPS_SEARCH_RESULTS","type":"codeVoice"},{"text":", ","type":"text"},{"code":"MAPS_SEARCH_HOME","type":"codeVoice"}],"type":"paragraph"}]],[[{"inlineContent":[{"code":"supplySource","type":"codeVoice"},{"text":" values","type":"text"}],"type":"paragraph"}],[{"inlineContent":[{"code":"APPSTORE","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"code":"MAPS","type":"codeVoice"}],"type":"paragraph"}]],[[{"inlineContent":[{"text":"Creative source","type":"text"}],"type":"paragraph"}],[{"inlineContent":[{"text":"App Store product page (no upload required)","type":"text"}],"type":"paragraph"}],[{"inlineContent":[{"text":"Brand assets uploaded via the Assets API","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"text":"Bid strategy options","type":"text"}],"type":"paragraph"}],[{"inlineContent":[{"code":"MANUAL_CPT","type":"codeVoice"},{"text":", ","type":"text"},{"code":"MAX_CONVERSIONS","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"code":"MAX_ENGAGEMENTS","type":"codeVoice"},{"text":", ","type":"text"},{"code":"MANUAL_CPT","type":"codeVoice"},{"text":", ","type":"text"},{"code":"MANUAL_CPM","type":"codeVoice"}],"type":"paragraph"}]]],"type":"table"},{"inlineContent":[{"text":"To target both ","type":"text"},{"code":"MAPS_SEARCH_RESULTS","type":"codeVoice"},{"text":" and ","type":"text"},{"code":"MAPS_SEARCH_HOME","type":"codeVoice"},{"text":" on an Apple Maps campaign, omit ","type":"text"},{"code":"supplyPlacement","type":"codeVoice"},{"text":" from ","type":"text"},{"code":"targeting","type":"codeVoice"},{"text":" entirely rather than listing both values in ","type":"text"},{"code":"include","type":"codeVoice"},{"text":". See ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/CampaignTargetingCreate\/SupplyPlacement-data.dictionary","isActive":true,"type":"reference"},{"text":" for details.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"An ad account’s ","type":"text"},{"code":"productFeatures","type":"codeVoice"},{"text":" gate which campaign type it can create. An account authorized with ","type":"text"},{"code":"APPSTORE_APP_MANUAL","type":"codeVoice"},{"text":" can only create App Store campaigns, and an account authorized with ","type":"text"},{"code":"BUSINESS_BRAND_MANUAL","type":"codeVoice"},{"text":" can only create Apple Maps campaigns. See ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/ProductFeatures","isActive":true,"type":"reference"},{"text":" for details.","type":"text"}],"type":"paragraph"},{"anchor":"Promote-Apps","level":3,"text":"Promote Apps","type":"heading"},{"inlineContent":[{"text":"App Store campaigns (","type":"text"},{"code":"promotedObjectType: APPSTORE_APP","type":"codeVoice"},{"text":") promote iOS apps across App Store placements. See ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/CampaignTargeting","isActive":true,"type":"reference"},{"text":" for the full list of accepted App Store country or region and placement targeting values.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"The app must be available for purchase, download, or preorder in the App Store and Apple Ads must be available in the targeted countries. To check eligibility before creating a campaign, use ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/Find-Apps-eligibilities","isActive":true,"type":"reference"},{"text":". After you confirm eligibility, see ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/POST-campaigns","isActive":true,"type":"reference"},{"text":" to create the campaign.","type":"text"}],"type":"paragraph"},{"anchor":"Promote-Brands-and-Locations","level":3,"text":"Promote Brands and Locations","type":"heading"},{"inlineContent":[{"text":"Apple Maps campaigns (","type":"text"},{"code":"promotedObjectType: BUSINESS_BRAND","type":"codeVoice"},{"text":") promote brands on Apple Maps. The brand must have ","type":"text"},{"code":"eligibility.status: ELIGIBLE","type":"codeVoice"},{"text":" before a campaign can serve. The ad account must also have a ","type":"text"},{"code":"BUSINESS_BRAND","type":"codeVoice"},{"text":" delegation linking it to the brand before campaigns can go live. See ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/ProductFeatures","isActive":true,"type":"reference"},{"text":" for delegation requirements. The ","type":"text"},{"code":"billingEvent","type":"codeVoice"},{"text":" can be ","type":"text"},{"code":"TAPS","type":"codeVoice"},{"text":" (for ","type":"text"},{"code":"MANUAL_CPT","type":"codeVoice"},{"text":" or ","type":"text"},{"code":"MAX_ENGAGEMENTS","type":"codeVoice"},{"text":") or ","type":"text"},{"code":"IMPRESSIONS","type":"codeVoice"},{"text":" (for ","type":"text"},{"code":"MANUAL_CPM","type":"codeVoice"},{"text":").","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"See ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/brands-endpoints","isActive":true,"type":"reference"},{"text":" for the full setup workflow, then see ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/POST-campaigns","isActive":true,"type":"reference"},{"text":" to create the campaign.","type":"text"}],"type":"paragraph"},{"anchor":"Choose-a-Bid-Strategy","level":3,"text":"Choose a Bid Strategy","type":"heading"},{"inlineContent":[{"text":"The ","type":"text"},{"code":"bidStrategy","type":"codeVoice"},{"text":" object is always present on a campaign and controls how the campaign competes in auctions. It’s required at creation: you must send both ","type":"text"},{"code":"bidStrategyType","type":"codeVoice"},{"text":" and ","type":"text"},{"code":"bidStrategyGoal","type":"codeVoice"},{"text":", and the goal must match the type. See ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/BidStrategy","isActive":true,"type":"reference"},{"text":" for the type and goal pairings.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"Use the following table to match your goal to a ","type":"text"},{"code":"bidStrategyType","type":"codeVoice"},{"text":" and ","type":"text"},{"code":"bidStrategyGoal","type":"codeVoice"},{"text":" pair:","type":"text"}],"type":"paragraph"},{"header":"row","rows":[[[{"inlineContent":[{"text":"If you want to…","type":"text"}],"type":"paragraph"}],[{"inlineContent":[{"text":"Use ","type":"text"},{"code":"bidStrategyType","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"text":"With ","type":"text"},{"code":"bidStrategyGoal","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"text":"Campaign type","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"text":"Set a fixed price per tap","type":"text"}],"type":"paragraph"}],[{"inlineContent":[{"code":"MANUAL_CPT","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"code":"TAP","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"text":"App Store or Apple Maps","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"text":"Set a fixed price per 1,000 impressions","type":"text"}],"type":"paragraph"}],[{"inlineContent":[{"code":"MANUAL_CPM","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"code":"IMPRESSION","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"text":"Apple Maps only","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"text":"Automatically optimize for installs","type":"text"}],"type":"paragraph"}],[{"inlineContent":[{"code":"MAX_CONVERSIONS","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"code":"INSTALL","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"text":"App Store only","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"text":"Automatically optimize for taps on your place card","type":"text"}],"type":"paragraph"}],[{"inlineContent":[{"code":"MAX_ENGAGEMENTS","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"code":"TAP","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"text":"Apple Maps only","type":"text"}],"type":"paragraph"}]]],"type":"table"},{"inlineContent":[{"text":"A Maximize Conversions bid strategy (","type":"text"},{"code":"MAX_CONVERSIONS","type":"codeVoice"},{"text":") maximizes the number of tap-through conversions at or near your target CPA. It uses a cost-per-tap pricing model and requires an automated ad group.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"To switch a campaign’s bid strategy after creation, send an updated ","type":"text"},{"code":"bidStrategy","type":"codeVoice"},{"text":" object with a matching ","type":"text"},{"code":"bidStrategyType","type":"codeVoice"},{"text":"\/","type":"text"},{"code":"bidStrategyGoal","type":"codeVoice"},{"text":" pair via ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/PUT-campaigns-_id_","isActive":true,"type":"reference"},{"text":". See ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/BidStrategyUpdate","isActive":true,"type":"reference"},{"text":" for the field-level mechanics. For reports with a Maximize Conversions bid strategy, see ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/Get-app-campaign-reports","isActive":true,"type":"reference"},{"text":" and ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/Get-app-ad-group-reports","isActive":true,"type":"reference"},{"text":".","type":"text"}],"type":"paragraph"},{"anchor":"Manage-Budget-Orders","level":3,"text":"Manage Budget Orders","type":"heading"},{"inlineContent":[{"text":"A budget order enforces a spending cap for a group of campaigns within an ad account. Campaigns assigned to the same budget order share a common spend limit via the ","type":"text"},{"code":"sharedBudgets","type":"codeVoice"},{"text":" field. Budget orders are available to Apple Ads customers on monthly invoicing. A campaign with shared budget assignments also requires a ","type":"text"},{"code":"dailyBudget","type":"codeVoice"},{"text":". Both controls function independently: ","type":"text"},{"code":"dailyBudget","type":"codeVoice"},{"text":" caps daily spending. Each shared budget caps spending over its flight period.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"See ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/budget-orders-endpoints","isActive":true,"type":"reference"},{"text":" for details on creating and managing budget orders.","type":"text"}],"type":"paragraph"},{"anchor":"Monitor-Campaign-and-System-Status","level":3,"text":"Monitor Campaign and System Status","type":"heading"},{"inlineContent":[{"text":"Campaigns have three status fields and a bid strategy that together reflect their delivery state.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"The ","type":"text"},{"code":"status","type":"codeVoice"},{"text":" field captures the advertiser’s intent for the campaign to serve. Set it to ","type":"text"},{"code":"ENABLED","type":"codeVoice"},{"text":" to allow the campaign to serve or ","type":"text"},{"code":"PAUSED","type":"codeVoice"},{"text":" to stop delivery without deleting the campaign.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"The ","type":"text"},{"code":"systemStatus","type":"codeVoice"},{"text":" field is system-computed. A value of ","type":"text"},{"code":"RUNNING","type":"codeVoice"},{"text":" means the campaign is active and eligible to serve, and ","type":"text"},{"code":"NOT_RUNNING","type":"codeVoice"},{"text":" means a condition is preventing delivery.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"The ","type":"text"},{"code":"displayStatus","type":"codeVoice"},{"text":" field is system-computed and represents a rolled-up label that combines ","type":"text"},{"code":"status","type":"codeVoice"},{"text":" and ","type":"text"},{"code":"systemStatus","type":"codeVoice"},{"text":" into a single delivery state. It’s the same value that campaign reporting returns.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"The ","type":"text"},{"code":"bidStrategy","type":"codeVoice"},{"text":" object is always present on a campaign and is required at creation. See the Choose a Bid Strategy section above for details.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"The following table lists what each ","type":"text"},{"code":"displayStatus","type":"codeVoice"},{"text":" value means:","type":"text"}],"type":"paragraph"},{"header":"row","rows":[[[{"inlineContent":[{"code":"displayStatus","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"text":"Meaning","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"code":"RUNNING","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"text":"The campaign is actively delivering ads.","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"code":"PAUSED","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"text":"The advertiser paused the campaign.","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"code":"ON_HOLD","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"text":"A system or account condition stops delivery.","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"code":"LIMITED","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"text":"The campaign is serving at reduced capacity.","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"code":"PROCESSING","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"text":"The system recently created or modified the campaign and is still processing it.","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"code":"DELETED","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"text":"The advertiser soft-deleted the campaign.","type":"text"}],"type":"paragraph"}]]],"type":"table"},{"inlineContent":[{"text":"When ","type":"text"},{"code":"systemStatus","type":"codeVoice"},{"text":" is ","type":"text"},{"code":"NOT_RUNNING","type":"codeVoice"},{"text":", the system populates the ","type":"text"},{"code":"systemStatusReasons","type":"codeVoice"},{"text":" array with one or more ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/CampaignSystemStatusReason","isActive":true,"type":"reference"},{"text":" values explaining why. Reasons include scheduling, app or brand eligibility, budget exhaustion, payment issues, and ad group state, among others.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"When a campaign is running but delivering at reduced capacity, the system populates the ","type":"text"},{"code":"systemStatusLimitingReasons","type":"codeVoice"},{"text":" array with one or more ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/CampaignSystemLimitedStatusReason","isActive":true,"type":"reference"},{"text":" values. These don’t stop delivery. They indicate conditions that constrain reach or impression volume.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"To filter campaigns by status, see ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/POST-campaigns-query","isActive":true,"type":"reference"},{"text":".","type":"text"}],"type":"paragraph"},{"content":[{"inlineContent":[{"text":"The ","type":"text"},{"code":"cpaCap","type":"codeVoice"},{"text":" field on ad groups is deprecated. Configure conversion targeting via the ","type":"text"},{"code":"bidStrategy","type":"codeVoice"},{"text":" object using ","type":"text"},{"code":"bidStrategyType: MAX_CONVERSIONS","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"Note","style":"note","type":"aside"},{"anchor":"Continue-Building-Campaign-Delivery","level":3,"text":"Continue Building Campaign Delivery","type":"heading"},{"inlineContent":[{"text":"Once a campaign exists, continue building out its delivery: create ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/adgroups-endpoints","isActive":true,"type":"reference"},{"text":" to configure targeting and bid strategy, add ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/keywords-and-negative-keywords","isActive":true,"type":"reference"},{"text":" for App Store search campaigns, and create ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/ads-endpoints","isActive":true,"type":"reference"},{"text":" to serve within each ad group.","type":"text"}],"type":"paragraph"}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"seeAlsoSections":[{"anchor":"Campaigns","generated":true,"identifiers":["doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/campaigns-data-objects","doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/campaign-data-types"],"title":"Campaigns"}],"topicSections":[{"anchor":"Topics","identifiers":["doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/POST-campaigns","doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/POST-campaigns-query","doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/GET-campaigns-_id_","doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/PUT-campaigns-_id_","doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/DELETE-campaigns-_id_","doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/GET-campaigns-_id_-legacy-app-limited-status-reason-details"]}],"variants":[{"paths":["\/documentation\/apple-ads-platform-api\/campaigns-endpoints"],"traits":[{"interfaceLanguage":"data"}]}],"references":{"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API":{"abstract":[{"text":"Programmatically manage App Store and Apple Maps advertising campaigns through a single RESTful API.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API","kind":"symbol","navigatorTitle":[{"kind":"text","text":"Apple Ads Platform API"}],"role":"collection","title":"Apple Ads Platform API","type":"topic","url":"\/documentation\/apple-ads-platform-api"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/BidStrategy":{"abstract":[{"text":"Defines how an ad group or campaign competes in auctions, including bid type, optimization goal, and bid amount.","type":"text"}],"fragments":[{"kind":"text","text":"object "},{"kind":"identifier","text":"BidStrategy"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/BidStrategy","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"BidStrategy"}],"role":"symbol","title":"BidStrategy","type":"topic","url":"\/documentation\/apple-ads-platform-api\/bidstrategy"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/BidStrategyUpdate":{"abstract":[{"text":"The request body for updating a bid strategy on an ad group or campaign.","type":"text"}],"fragments":[{"kind":"text","text":"object "},{"kind":"identifier","text":"BidStrategyUpdate"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/BidStrategyUpdate","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"BidStrategyUpdate"}],"role":"symbol","title":"BidStrategyUpdate","type":"topic","url":"\/documentation\/apple-ads-platform-api\/bidstrategyupdate"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/CampaignSystemLimitedStatusReason":{"abstract":[{"text":"A reason code indicating that a campaign is running but delivering at reduced capacity.","type":"text"}],"fragments":[{"kind":"text","text":"type "},{"kind":"identifier","text":"CampaignSystemLimitedStatusReason"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/CampaignSystemLimitedStatusReason","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"CampaignSystemLimitedStatusReason"}],"role":"symbol","title":"CampaignSystemLimitedStatusReason","type":"topic","url":"\/documentation\/apple-ads-platform-api\/campaignsystemlimitedstatusreason"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/CampaignSystemStatusReason":{"abstract":[{"text":"A reason code explaining why a campaign is not currently running.","type":"text"}],"fragments":[{"kind":"text","text":"type "},{"kind":"identifier","text":"CampaignSystemStatusReason"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/CampaignSystemStatusReason","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"CampaignSystemStatusReason"}],"role":"symbol","title":"CampaignSystemStatusReason","type":"topic","url":"\/documentation\/apple-ads-platform-api\/campaignsystemstatusreason"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/CampaignTargeting":{"abstract":[{"text":"Defines where a campaign is eligible to serve ads, including supply source, placement, and geographic markets.","type":"text"}],"fragments":[{"kind":"text","text":"object "},{"kind":"identifier","text":"CampaignTargeting"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/CampaignTargeting","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"CampaignTargeting"}],"role":"symbol","title":"CampaignTargeting","type":"topic","url":"\/documentation\/apple-ads-platform-api\/campaigntargeting"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/CampaignTargetingCreate/SupplyPlacement-data.dictionary":{"abstract":[{"text":"The specific placement within a supply source where a new campaign’s ads are eligible to appear.","type":"text"}],"fragments":[{"kind":"text","text":"object "},{"kind":"identifier","text":"CampaignTargetingCreate.SupplyPlacement"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/CampaignTargetingCreate\/SupplyPlacement-data.dictionary","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"CampaignTargetingCreate.SupplyPlacement"}],"role":"symbol","title":"CampaignTargetingCreate.SupplyPlacement","type":"topic","url":"\/documentation\/apple-ads-platform-api\/campaigntargetingcreate\/supplyplacement-data.dictionary"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/DELETE-campaigns-_id_":{"abstract":[{"text":"Soft-delete a campaign by its unique identifier, cascading to its ad groups, keywords, and ads.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/DELETE-campaigns-_id_","kind":"symbol","navigatorTitle":[{"kind":"text","text":"Delete a Campaign"}],"role":"symbol","title":"Delete a Campaign","type":"topic","url":"\/documentation\/apple-ads-platform-api\/delete-campaigns-_id_"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/Find-Apps-eligibilities":{"abstract":[{"text":"Check whether an app is eligible to run on certain Apple Ads placements and in specific countries or regions.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/Find-Apps-eligibilities","kind":"symbol","navigatorTitle":[{"kind":"text","text":"Check App Eligibility"}],"role":"symbol","title":"Check App Eligibility","type":"topic","url":"\/documentation\/apple-ads-platform-api\/find-apps-eligibilities"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/GET-campaigns-_id_":{"abstract":[{"text":"Retrieve a single campaign by its unique identifier.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/GET-campaigns-_id_","kind":"symbol","navigatorTitle":[{"kind":"text","text":"Get a Campaign"}],"role":"symbol","title":"Get a Campaign","type":"topic","url":"\/documentation\/apple-ads-platform-api\/get-campaigns-_id_"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/GET-campaigns-_id_-legacy-app-limited-status-reason-details":{"abstract":[{"text":"Return a map of country or region codes to their associated limited-status reason for legacy app campaigns.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/GET-campaigns-_id_-legacy-app-limited-status-reason-details","kind":"symbol","navigatorTitle":[{"kind":"text","text":"Get Legacy App Limited Status Reason Details"}],"role":"symbol","title":"Get Legacy App Limited Status Reason Details","type":"topic","url":"\/documentation\/apple-ads-platform-api\/get-campaigns-_id_-legacy-app-limited-status-reason-details"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/Get-app-ad-group-reports":{"abstract":[{"text":"Retrieve performance metrics for ad groups.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/Get-app-ad-group-reports","kind":"symbol","navigatorTitle":[{"kind":"text","text":"Ad Groups Report"}],"role":"symbol","title":"Ad Groups Report","type":"topic","url":"\/documentation\/apple-ads-platform-api\/get-app-ad-group-reports"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/Get-app-campaign-reports":{"abstract":[{"text":"Retrieve performance metrics for campaigns.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/Get-app-campaign-reports","kind":"symbol","navigatorTitle":[{"kind":"text","text":"Campaigns Report"}],"role":"symbol","title":"Campaigns Report","type":"topic","url":"\/documentation\/apple-ads-platform-api\/get-app-campaign-reports"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/POST-campaigns":{"abstract":[{"text":"Create a new advertising campaign with a promoted object, budget, targeting, and bid strategy configuration.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/POST-campaigns","kind":"symbol","navigatorTitle":[{"kind":"text","text":"Create a Campaign"}],"role":"symbol","title":"Create a Campaign","type":"topic","url":"\/documentation\/apple-ads-platform-api\/post-campaigns"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/POST-campaigns-query":{"abstract":[{"text":"Query campaigns using filters, sorting, and pagination.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/POST-campaigns-query","kind":"symbol","navigatorTitle":[{"kind":"text","text":"Query Campaigns"}],"role":"symbol","title":"Query Campaigns","type":"topic","url":"\/documentation\/apple-ads-platform-api\/post-campaigns-query"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/PUT-campaigns-_id_":{"abstract":[{"text":"Update a campaign’s name, status, budget, targeting, or bid strategy.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/PUT-campaigns-_id_","kind":"symbol","navigatorTitle":[{"kind":"text","text":"Update a Campaign"}],"role":"symbol","title":"Update a Campaign","type":"topic","url":"\/documentation\/apple-ads-platform-api\/put-campaigns-_id_"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/ProductFeatures":{"abstract":[{"text":"Product features are the advertising capabilities for an ad account.","type":"text"}],"fragments":[{"kind":"text","text":"type "},{"kind":"identifier","text":"ProductFeatures"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/ProductFeatures","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"ProductFeatures"}],"role":"symbol","title":"ProductFeatures","type":"topic","url":"\/documentation\/apple-ads-platform-api\/productfeatures"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/Query-Brands":{"abstract":[{"text":"Retrieve a paginated list of brands using filters and sorting.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/Query-Brands","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Query Brands"}],"role":"symbol","title":"Query Brands","type":"topic","url":"\/documentation\/apple-ads-platform-api\/query-brands"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/adgroups-endpoints":{"abstract":[{"text":"Create, retrieve, update, and delete ad groups.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/adgroups-endpoints","kind":"article","role":"collectionGroup","title":"Ad Groups Endpoints","type":"topic","url":"\/documentation\/apple-ads-platform-api\/adgroups-endpoints"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/ads-endpoints":{"abstract":[{"text":"Create, retrieve, update, and delete ads using these endpoints.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/ads-endpoints","kind":"article","role":"collectionGroup","title":"Ads Endpoints","type":"topic","url":"\/documentation\/apple-ads-platform-api\/ads-endpoints"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/brands-endpoints":{"abstract":[{"text":"Query and retrieve brands, business categories, and creative rejection reasons.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/brands-endpoints","kind":"article","role":"collectionGroup","title":"Ads on Apple Maps Endpoints","type":"topic","url":"\/documentation\/apple-ads-platform-api\/brands-endpoints"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/budget-orders-endpoints":{"abstract":[{"text":"Create, retrieve, update, and delete budget orders through these endpoints.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/budget-orders-endpoints","kind":"article","role":"collectionGroup","title":"Budget Orders Endpoints","type":"topic","url":"\/documentation\/apple-ads-platform-api\/budget-orders-endpoints"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/campaign-data-types":{"abstract":[{"text":"Look up the enumerated values and scalar types used across campaign fields.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/campaign-data-types","kind":"article","role":"collectionGroup","title":"Campaigns Data Types","type":"topic","url":"\/documentation\/apple-ads-platform-api\/campaign-data-types"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/campaigns-data-objects":{"abstract":[{"text":"Reference the request and response schemas for creating, retrieving, and updating campaigns.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/campaigns-data-objects","kind":"article","role":"collectionGroup","title":"Campaigns Data Objects","type":"topic","url":"\/documentation\/apple-ads-platform-api\/campaigns-data-objects"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/keywords-and-negative-keywords":{"abstract":[{"text":"Create and manage keywords and negative keywords for ad groups and campaigns.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/keywords-and-negative-keywords","kind":"article","role":"article","title":"Managing Keywords and Negative Keywords","type":"topic","url":"\/documentation\/apple-ads-platform-api\/keywords-and-negative-keywords"},"doc://com.apple.documentation/documentation/technologies":{"abstract":[],"identifier":"doc:\/\/com.apple.documentation\/documentation\/technologies","kind":"technologies","role":"overview","title":"Technologies","type":"topic","url":"\/documentation\/technologies"}}}