Add Search ad-group keywords
Adds one or more keyword criteria to an existing Google Search ad group,
without touching the keywords already there (unlike the whole-set diff on
PUT /v1/ads/{adId}, keywords/negativeKeywords in platformSpecificData,
which replaces the set). Set negative: true to add ad-group-level negatives
instead of positive keywords.
Authorization
bearerAuth API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.adcampaigns.addAdKeywords({ body: { accountId: 'account_abc123', adSetId: 'adset_abc123', keywords: [ 'string', ], },});console.log(data);{ "keywords": [ { "id": "string", "platformCriterionId": "string", "resourceName": "string", "accountId": "string", "profileId": "string", "platform": "google", "adAccountId": "string", "campaignId": "string", "campaignName": "string", "campaignStatus": "string", "adSetId": "string", "adSetName": "string", "adSetStatus": "string", "keyword": "string", "matchType": "exact", "status": "active", "negative": true, "qualityScore": 0, "quality": { "score": 0, "expectedCtr": "BELOW_AVERAGE", "adRelevance": "BELOW_AVERAGE", "landingPageExperience": "BELOW_AVERAGE" }, "syncedAt": "2019-08-24T14:15:22Z", "metrics": { "windowDays": 0, "clicks": 0, "impressions": 0, "cost": 0, "conversions": 0, "firstPageCpc": 0, "firstPositionCpc": 0 } } ]}List Search keywords
Returns the Google Search keyword criteria (positive and negative) synced from connected Google Ads accounts, one row per ad-group keyword. Refreshed about once a day per Google Ads customer (the keyword sweep rides the ads discovery pass on a slower slot), so keywords added on Google can take up to a day to appear. A customer synced for the first time is populated on the next discovery pass rather than waiting for its daily slot, and connecting an account or triggering a manual sync refreshes it immediately. Campaign-level negative keywords are not included; only ad-group-level criteria are.
Pause or enable a Search keyword
Changes `ad_group_criterion.status` for one keyword criterion (M.140). Negative keywords have no status on Google and cannot be paused or enabled.