Apply Target CPA Recommendations
Apply one or more target CPA recommendations.
URL
POST https://api.ads.apple.com/v1/recommendations/target-cpas/applyHeader Parameters
| Name | Type | Description |
|---|---|---|
X-Ap-Context Required | string |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | RecommendationApplyTargetCpaResponse | |
| 400 | Bad Request Content-Type: application/json | RecommendationResponseBody | |
| 401 | Unauthorized Content-Type: application/json | RecommendationResponseBody | |
| 403 | Forbidden Content-Type: application/json | RecommendationResponseBody | |
| 404 | Not Found Content-Type: application/json | RecommendationResponseBody | |
| 429 | Too Many Requests Content-Type: application/json | RecommendationResponseBody | |
| 500 | Internal Server Error Content-Type: application/json | RecommendationResponseBody |
Discussion
Applying a target CPA recommendation applies the recommendation’s recommendedTargetCPA value and moves the recommendation to APPLIED state. You can override the suggested value by passing appliedTargetCPA in the request. The response is a history record with both the recommended and applied values, plus the performance context behind the recommendation.
Payload Examples
This example applies a target CPA recommendation, overriding the suggested CPA with $5.00. The response confirms the recommendation is now APPLIED.
HTTP Body
Send an array of ApplyTargetCpaRecommendation objects, one per recommendation you want to apply. All items must share the same promotedObjectId, and each item needs id, promotedObjectId, and promotedObjectType. appliedTargetCPA is optional, use it to override the suggested value.