Contents

Create a Campaign

Creates a campaign to promote an app.

URL

POST https://api.searchads.apple.com/api/v5/campaigns

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
CampaignResponse

If the call succeeds, the API returns the Campaign object in the response payload with an HTTP status code of 200(OK). If unsuccessful, the HTTP status code indicates the error with details in the error message.

400Bad Request
Content-Type: application/json
ApiErrorResponse

An invalid query or missing required parameters.

401Unauthorized
Content-Type: application/json
ApiErrorResponse

An unauthenticated call fails to get the requested response.

403Forbidden
Content-Type: application/json
ApiErrorResponse

Insufficient rights to the resource.

404Not Found
Content-Type: application/json
ApiErrorResponse

The API can’t locate the resource.

429
Content-Type: application/json
ApiErrorResponse

The API calls exceed rate-limit thresholds. See the Rate Limits subsection of Calling the Apple Ads API.

500Internal Server Error
Content-Type: application/json
ApiErrorResponse

The Apple Ads server is temporarily down or unreachable. The request may be valid, but you need to retry it later.

Mentioned in

Discussion

Essential points for creating campaigns are:

  • Use Search for iOS apps to retrieve your adamId to use in the request payload.

  • Use Find App Eligibility Records to determine your app eligibility to run in campaigns.

  • A dailyBudgetAmount is a required field to manage the daily budget of your campaigns.

  • Use the countriesOrRegions attribute to assign App Store locations. To advertise in multiple markets, group countries and regions into a single campaign using ISO alpha-2 country code values.

  • See the Campaign object and SupplySource for descriptions of attributes.

After creating a campaign, see Create an Ad Group.

Payload example: Create a campaign with a manual bid strategy

Payload example: Create a campaign with a Maximize Conversions bid strategy

  • Set the biddingStrategy value to MAX_CONVERSIONS. If not specified, biddingStrategy defaults to MANUAL_CPT.

  • A targetCpa is required.

  • Only the APPSTORE_SEARCH_RESULTS supplySources placement is supported.

After creating a Maximize Conversions bid strategy, see the automated ad group payload example in Create an Ad Group.

HTTP Body

The request body that includes the details of the campaign.

See Also

Campaign Endpoints