Contents

Get a Campaign Negative Keyword

Fetches a specific negative keyword in a campaign.

URL

GET https://api.searchads.apple.com/api/v5/campaigns/{campaignId}/negativekeywords/{keywordId}

Path Parameters

NameTypeDescription
campaignId Requiredint64

The unique identifier for the campaign.

keywordId Requiredint64

The unique identifier for the keyword.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
NegativeKeywordResponse

If the call succeeds, the API returns a list of NegativeKeyword objects in the response payload with an HTTP status code of 200(OK). If unsuccessful, the HTTP status code indicates the error with details in the error message.

401Unauthorized
Content-Type: application/json
ApiErrorResponse

An unauthenticated call fails to get the requested response.

403Forbidden
Content-Type: application/json
ApiErrorResponse

Insufficient rights to the resource.

404Not 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.

500Internal 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 a specific campaign negative keyword, use the associated campaignId and keywordId 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.

Payload example: Get a campaign negative keyword

See Also

Campaign Negative Keywords Endpoints