Get All Campaign Negative Keywords
Fetches all negative keywords in a campaign.
URL
GET https://api.searchads.apple.com/api/v5/campaigns/{campaignId}/negativekeywordsPath Parameters
| Name | Type | Description |
|---|---|---|
campaignId Required | int64 | The unique identifier for the campaign. |
Query Parameters
| Name | Type | Description |
|---|---|---|
limit Optional | int32 | The number of items to return per request. The maximum is 1000 for most objects. |
offset Optional | int32 | The offset pagination that limits the number of returned records. The start of each page is offset by the specified number. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | NegativeKeywordListResponse | If the call succeeds, the API returns a list of NegativeKeyword objects in the response payload with an HTTP status code of |
| 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 return all campaign negative keywords, use the associated campaignId in the URI. You can also use a partial fetch. For more information, see the Use a Partial Fetch section of Using Apple Ads API Functionality.