Contents

Create a Campaign

Create a new advertising campaign with a promoted object, budget, targeting, and bid strategy configuration.

URL

POST https://api.ads.apple.com/v1/campaigns

Header Parameters

NameTypeDescription
X-Ap-Context Requiredstring

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
CampaignResponse
400Bad Request
Content-Type: application/json
ErrorResponse
401Unauthorized
Content-Type: application/json
ErrorResponse
403Forbidden
Content-Type: application/json
ErrorResponse
404Not Found
Content-Type: application/json
ErrorResponse
429Too Many Requests
Content-Type: application/json
ErrorResponse
500Internal Server Error
Content-Type: application/json
ErrorResponse

Discussion

This endpoint creates a new campaign with a promoted object, budget, targeting, and bid strategy configuration. Every campaign identifies what it promotes through two immutable fields set at creation, promotedObjectType and promotedObjectId. You can’t change these fields after you create the campaign. To advertise a different app or brand, create a new campaign. For a full comparison of App Store and Apple Maps campaigns, including supported placements, supply sources, and creative sources, see the Campaigns Endpoints overview.

The promotedObjectType field determines which kind of object promotedObjectId points to:

  • APPSTORE_APP: The campaign promotes an iOS app. promotedObjectId is the app’s adamId, retrieved from Search for Apps. See Campaigns Endpoints for eligibility requirements before creating the campaign.

  • BUSINESS_BRAND: The campaign promotes a brand and its business locations on Apple Maps. promotedObjectId is the brand’s unique identifier, retrieved from Query Brands or GET /v1/advertiser-resources?resourceType=BUSINESS_BRAND. See Campaigns Endpoints for eligibility requirements before creating the campaign.

Campaign Type

Required Fields

promotedObjectType

promotedObjectId

App Store

adAccountId, billingEvent, bidStrategy, dailyBudget, name, promotedObjectId, promotedObjectType, startTime, endTime, targeting

APPSTORE_APP

The app’s adamId. Retrieve it from Searches For A List Of Apps.

Apple Maps

adAccountId, billingEvent, bidStrategy, dailyBudget, name, promotedObjectId, promotedObjectType, startTime, endTime, targeting

BUSINESS_BRAND

The brand’s unique identifier. Retrieve it from Query Brands or GET /v1/advertiser-resources?resourceType=BUSINESS_BRAND.

Within bidStrategy, bidStrategyType and bidStrategyGoal are both required and must correspond per the pairings in BidStrategy (for example, MAX_CONVERSIONSINSTALL, MANUAL_CPTTAP). Omitting either field, or sending a goal that doesn’t match the type, returns an error.

Payload Examples

See Also