Find Targeting Keywords in a Campaign
Fetches targeting keywords in a campaign’s ad groups.
URL
POST https://api.searchads.apple.com/api/v5/campaigns/{campaignId}/adgroups/targetingkeywords/findPath Parameters
| Name | Type | Description |
|---|---|---|
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. |
Mentioned in
Discussion
Use this endpoint to find targeting keywords in different ad groups within the same campaign. Use the associated campaignId in the URI. Find calls use Selector Condition operators to narrow results. If you don’t specify any selector conditions in the payload, the API returns all keywords across all ad groups of the campaign. For more information about available selection condition operators to use, see the Keyword object.
Payload example: Find targeting keywords in a campaign
HTTP Body
The request body that includes the selector Condition. Selector objects define what data the API returns when fetching resources.