Zernio
Zernio
API Reference

Campaigns and Ads

Overview

Get campaign treeGETGet daily account metricsGET

Campaigns

List campaignsGETCreate a standalone campaignPOSTGet live campaign detailsGETUpdate a campaignPUTDuplicate a campaignPOSTDelete a campaignDELETEPause or resume a campaignPUTPause or resume many campaignsPOSTList campaign assetsGETAttach campaign assetsPOSTUpdate campaign assetsPUTRemove campaign assetsDELETERead a Google campaign's device, location, and language targetingGETEdit a Google campaign's device, location, or language targetingPUTRead a campaign's ad schedule (dayparting)GETReplace a campaign's ad schedule (dayparting)PUTGet campaign conversion goalsGETUpdate campaign conversion goalsPATCH

Asset Groups

List Performance Max asset groupsGETCreate a Performance Max asset groupPOSTGet a Performance Max asset groupGETUpdate a Performance Max asset groupPATCHRemove a Performance Max asset groupDELETELink or unlink asset group assetsPOSTReplace an asset group's listing-group treePUT

Ad Sets

List ad setsGETCreate a standalone ad groupPOSTGet live ad-set detailsGETUpdate an ad setPUTDuplicate an ad setPOSTDelete an ad setDELETEPause or resume a single ad setPUTList ad-group assetsGETAttach ad-group assetsPOSTUpdate ad-group assetsPUTRemove ad-group assetsDELETE

Ads

List adsGETGet ad detailsGETCreate standalone adPOSTBoost post as adPOSTUpdate adPUTDuplicate an adPOSTCancel an adDELETEPause or resume a single adPUT

Keywords

List Search keywordsGETAdd Search ad-group keywordsPOSTPause or enable a Search keywordPATCHRemove a Search keywordDELETEList campaign-level negative keywordsGETReplace campaign-level negative keywordsPUTList campaign negative listsGETReplace campaign negative listsPUT

Bidding

Read a campaign's current biddingGETList portfolio bid strategiesGETCreate portfolio bid strategyPOSTUpdate portfolio bid strategyPATCH

Recommendations

List Google Ads recommendationsGETApply Google Ads recommendationsPOSTDismiss Google Ads recommendationsPOST

Other

Read the platform's review verdict for an adGET
Dashboard
llms.txtOpenAPI
OverviewPlatformsAPI ReferenceResources
Campaigns and Ads

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.

PlatformsGoogle
PATCH
/v1/ads/keywords/{keywordId}

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Path Parameters

keywordId*string

Zernio keyword ID (id), or Google's native {adSetId}~{platformCriterionId} (the tail of resourceName, e.g. 1234567890~987654321). A bare criterion id is rejected because it is only unique within its ad group.

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.updateAdKeyword({  path: {    keywordId: 'keyword_abc123',  },  body: {    status: 'active',  },});console.log(data);
{  "keyword": {    "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    }  }}
Was this page helpful?

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.

Remove a Search keyword

Removes one keyword criterion (positive or negative) from its ad group (M.140).

status*string

Value in

  • "active"
  • "paused"