Contents

NegativeKeyword

A keyword exclusion that prevents ads from showing when a search query matches the excluded term.

Declaration

object NegativeKeyword

Properties

NameTypeDescription
adAccountIdint64

The ad account this negative keyword belongs to. Informational. Read-only.

campaignIdint64

The campaign ID. Negative keywords can be defined at campaign or ad group level. Filterable (EQUALS). Immutable after creation.

adGroupIdint64

The ad group this negative keyword belongs to. Null if defined at campaign level. Filterable (EQUALS, IN, IS_NULL, IS_NOT_NULL, NOT_EQUALS). Immutable after creation.

textstring

The original advertiser-given keyword text. Filterable (EQUALS, STARTS_WITH). Immutable after creation.

matchTypeNegativeKeyword.MatchType

Match type for this negative keyword. The schema accepts all four KeywordMatchType values (EXACT, BROAD, PHRASE, CATEGORY). In practice, EXACT and BROAD apply to App Store negatives and PHRASE applies to Apple Maps negatives. CATEGORY is not supported for negative keywords. See KeywordMatchType. Filterable (EQUALS, IN). Immutable after creation.

statusNegativeKeyword.Status

Whether the negative keyword is active or paused. See NegativeKeywordStatus. Filterable (EQUALS, IN). Mutable.

idint64

System-assigned unique identifier. Read-only. Filterable (EQUALS, IN).

creationTimedate-time

Timestamp when the negative keyword was created. Read-only.

modificationTimedate-time

Timestamp of the last modification. Read-only.

deletedboolean

Whether the negative keyword has been deleted. Read-only.

Discussion

A NegativeKeyword prevents ads from showing when a search query matches the excluded term.

  • The EXACT match negatives block only searches that precisely match the term.

  • The BROAD match negatives block a wider range of related queries.

  • The PHRASE match negatives block Apple Maps searches that match the term and close variants.

Pausing a negative keyword (status: PAUSED) temporarily re-enables traffic from that term without permanently removing the exclusion. A deleted negative keyword is soft-deleted and excluded from serving but remains accessible in query results.

You can use fields marked Filterable in the dictionary keys as filter criteria in query endpoint requests. See Calling the Apple Ads Platform API for details on constructing queries.

Example

{
  "id": 777888999,
  "adAccountId": 123456789,
  "campaignId": 444555666,
  "text": "free app",
  "matchType": "BROAD",
  "status": "ENABLED",
  "creationTime": "2025-01-10T08:00:00.000",
  "modificationTime": "2025-01-10T08:00:00.000",
  "deleted": false
}

Topics

Type Aliases

See Also