Create an Ad
Creates an ad in an ad group with a creative.
URL
POST https://api.searchads.apple.com/api/v5/campaigns/{campaignId}/adgroups/{adgroupId}/adsPath Parameters
| Name | Type | Description |
|---|---|---|
adgroupId Required | int64 | The unique identifier for the ad group. |
campaignId Required | int64 | The unique identifier for the campaign. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | AdResponse | If the call succeeds, the API returns the AdResponse object in the response payload with an HTTP status code of |
| 400 | Bad Request Content-Type: application/json | ApiErrorResponse | An invalid query or missing required parameters. |
| 401 | Unauthorized Content-Type: application/json | ApiErrorResponse | An unauthenticated call fails to get the requested response. |
| 403 | Forbidden Content-Type: application/json | ApiErrorResponse | Insufficient rights to the resource. |
| 404 | Not 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. |
| 500 | Internal 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. |
Discussion
Use this endpoint to create an Ad object using your creativeId in the request payload. To obtain a creativeId, use the Create a Creative endpoint. See Update an Ad to update or replace the ad group assignment of an Ad object.
In API version 5.2, this endpoint supports default product page ads. For more information, see Apple Ads Campaign Management API 5.
The Id in the response is your adId, representing the assignment of a creative to an AdGroup. Use your adId in the resource path with Get an Ad, Update an Ad, Delete an Ad, and in Get Ad-Level Reports. Your adId is also output in the AdServices attribution framework.
Payload example: Create an ad
HTTP Body
The request body that includes the details of the Ad object creation request.