Get keywords

GET {{baseUrl}}/ad_accounts/:ad_account_id/keywords?campaign_id=91255&ad_group_id=123123123&match_types=BROAD&page_size=25&bookmark=reprehenderit Ut

Get a list of keywords based on the filters provided.

For more information, see Keyword targeting.

Notes:

  • Advertisers and campaigns can only be assigned keywords with excluding ('_NEGATIVE').
  • All keyword match types are available for ad groups.

For more information on match types, see match type enums.

Returns:

  • A successful call returns an object containing an array of new keyword objects and an empty "errors" object array.

  • An unsuccessful call returns an empty keywords array, and, instead, inserts the entire object with nulled/negated properties into the "errors" object array:

     { "keywords": [], "errors": [ { "data": { "archived": null, "match_type": "EXACT", "parent_type": null, "value": "foobar", "parent_id": null, "type": "keyword", "id": null }, "error_messages": [ "Advertisers and Campaigns only accept excluded targeting attributes." ] } } 

Rate limit: WRITE.

Request Params

KeyDatatypeRequiredDescription
campaign_idnumberCampaign Id to use to filter the results.
ad_group_idnumberAd group Id.
match_typesstringKeyword <a href="/docs/redoc/#section/Match-type-(keyword).">match type</a>
page_sizenumberMaximum number of items to include in a single page of the response. See documentation on <a href='/docs/getting-started/pagination/'>Pagination</a> for more information.
bookmarkstringCursor used to fetch the next page of items

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;items&quot;:[],&quot;bookmark&quot;:&quot;cillum eiusmod&quot;}