Update Targeting Keywords
Updates targeting keywords in ad groups.
URL
PUT https://api.searchads.apple.com/api/v5/campaigns/{campaignId}/adgroups/{adgroupId}/targetingkeywords/bulkPath 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 | KeywordListResponse | If the call succeeds, the API returns a list of Keyword objects 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
To update targeting keywords, use the associated campaignId and adgroupId in the URI. The id in the payload must belong to a keyword that exists inside the ad group in the URI. The status and bidAmount fields are modifiable in the payload. Use partial updates to edit a subset of object properties without having to include all object properties in the payload. For more information, see the Use Partial Updates section of Using Apple Ads API Functionality.
Payload example: Update ad group targeting keywords
When updating keywords in a campaign with a Maximize Conversions bidding strategy, bidAmount cannot be changed to a non-zero/non-null value.
HTTP Body
The request body that includes keyword targeting details.