Skip to main content

Negate Search Terms

POST 

/api/advertising/search-terms/negate

Adds search terms as negative keywords. Each item becomes a negative keyword in its campaign, or in the ad group when ad_group_id is given, with match_type exact (default) or phrase.

Required scope: advertising:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

The result is a change set that must be approved before anything reaches the ad platform (or a simulated set with dry_run: true).

Requires the advertising.manage permission and the Advertising Manager feature.

Body fields:

  • ad_account_id (required, existing ad account ID)
  • dry_run (optional, boolean, default false): true creates a simulated change set only
  • items (required, 1-500 rows):
    • items.*.ad_campaign_id (required, integer): the campaign the term appeared in; must be a live campaign of the account
    • items.*.ad_group_id (optional, integer)
    • items.*.search_term (required, string, max 500)
    • items.*.destination_ad_group_id (integer)
    • items.*.bid (optional, > 0)
    • items.*.negate_in_source (optional, boolean)
    • items.*.match_type (optional, exact or phrase)

destination_ad_group_id, bid and negate_in_source are accepted but ignored by negate.

Returns 201 with the change set and its lines.

Request​

Responses​

Created

Response Headers
    Content-Type