Google Ads Keywords
Lists the keywords of a Google Ads account with match type, status, Quality Score, bid and impressions, clicks, cost and conversions for a date range.
- Price per call
- 1 credit
- per successful call
- Price ceiling
- 1 credit
- every call, same price
- Failed calls
- Free
- retried automatically
- Billed
- Per call
- only on success
Endpoint
api.primaryapi.com/ v1/ run/ google-ads. keywordsAuth: API key with run or full access, or a dashboard session
Send the input below as a JSON body. The call is routed to a healthy upstream; if an attempt fails, it is retried automatically inside the same request and you pay only for the answer you get. To check an input and see the exact price without running anything, call POST /v1/quote/google-ads.keywords with the same body (free).
Example request
curl -sS -X POST "https://api.primaryapi.com/v1/run/google-ads.keywords" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"customerId":"1234567890"}'const res = await fetch('https://api.primaryapi.com/v1/run/google-ads.keywords', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.PRIMARYAPI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
customerId: '1234567890',
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.code}: ${body.error}`);
// found:false is a successful answer ("does not exist"), not an error
console.log(body.output.found ? body.output.data : body.output.reason, body.credits);import os
import requests
res = requests.post(
"https://api.primaryapi.com/v1/run/google-ads.keywords",
headers={"Authorization": f"Bearer {os.environ['PRIMARYAPI_API_KEY']}"},
json={
"customerId": "1234567890",
},
timeout=60,
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['code']}: {body['error']}")
# found=False is a successful answer ("does not exist"), not an error
print(body["output"]["data"] if body["output"]["found"] else body["output"]["reason"], body["credits"]){
"name": "run_api",
"arguments": {
"sku": "google-ads.keywords",
"input": {
"customerId": "1234567890"
}
}
}Price this exact input first (free)
curl -sS -X POST "https://api.primaryapi.com/v1/quote/google-ads.keywords" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"customerId":"1234567890"}'Returns credits (what the call is expected to cost) and maxCredits (the most it can cost, which is set aside while it runs). Invalid input fails here the same way it would on run.
Input
JSON body fields. Unknown fields are rejected with 400 invalid_input (never silently ignored). You may add the routing controls preferLatencyUnderMs and maxCredits to the same object.
customerIdstringrequired- Google Ads customer (account) id, 10 digits with or without hyphens, e.g. "123-456-7890". List yours with google-ads.accounts.pattern: ^(\d{3})-?(\d{3})-?(\d{4})$
dateRangeenumdefault"LAST_30_DAYS"- Period of the metrics, in the account’s time zone (default LAST_30_DAYS). Ignored when startDate/endDate are set.one of: TODAY, YESTERDAY, LAST_7_DAYS, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, THIS_MONTH, LAST_MONTH, THIS_WEEK_SUN_TODAY, THIS_WEEK_MON_TODAY, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN
startDatestring- Custom period start (YYYY-MM-DD), with endDate.pattern: ^\d{4}-\d{2}-\d{2}$
endDatestring- Custom period end (YYYY-MM-DD), inclusive, with startDate.pattern: ^\d{4}-\d{2}-\d{2}$
limitintegerdefault50- Maximum number of results to return (1-1000, default 50).1–1000
statusesenum[]default["ENABLED","PAUSED"]- Keyword statuses to include (default ENABLED and PAUSED).min 1 items · max 3 items
campaignIdstring- Only the keywords of this campaign (numeric id).pattern: ^\d{1,20}$
adGroupIdstring- Only the keywords of this ad group (numeric id, from google-ads.ad_groups).pattern: ^\d{1,20}$
cursorstring- Opaque pagination cursor: pass the previous response's nextCursor.
loginCustomerIdstring- Only when the connected Google account reaches `customerId` THROUGH a manager (MCC) account: that manager account’s id (10 digits). Sent as the login-customer-id header. Omit for accounts the Google account can open directly.pattern: ^(\d{3})-?(\d{3})-?(\d{4})$
connectionstring- Which connected account to use when the workspace has several for this provider: the customId you gave it (exact), its connection id ("con_…"), its handle (login, email or @handle) or its name. Optional; prefer the customId or id, which never match two accounts.max 200 chars
Output
When output.found is true, output.data has these fields (a list under keywords, billed per item returned).
customerIdstringcurrencyCodestring | nullperiodstring- The GAQL date condition used, e.g. "DURING LAST_30_DAYS"
nextCursorstring | nullkeywordsobject[]keywords[].criterionIdstringkeywords[].resourceNamestringkeywords[].textstring | nullkeywords[].matchTypestring | null- EXACT, PHRASE or BROAD
keywords[].statusstring | null- ENABLED, PAUSED or REMOVED
keywords[].primaryStatusstring | null- ELIGIBLE, PAUSED, REMOVED, PENDING or NOT_ELIGIBLE
keywords[].approvalStatusstring | null- APPROVED, DISAPPROVED, PENDING_REVIEW or UNDER_REVIEW
keywords[].qualityScoreinteger | null- 1-10; null when Google does not have enough data to score the keyword
keywords[].predictedCtrstring | null- Expected click-through rate compared with other advertisers (search_predicted_ctr)
keywords[].creativeQualitystring | null- The ad compared with other advertisers (creative_quality_score)
keywords[].landingPageQualitystring | null- Landing page quality (post_click_quality_score)
keywords[].cpcBidnumber | null- Keyword max CPC bid, in the account currency
keywords[].cpcBidMicrosinteger | nullkeywords[].effectiveCpcBidnumber | nullkeywords[].effectiveCpcBidMicrosinteger | nullkeywords[].adGroupobjectkeywords[].adGroup.idstring | nullkeywords[].adGroup.namestring | nullkeywords[].campaignobjectkeywords[].campaign.idstring | nullkeywords[].campaign.namestring | nullkeywords[].metricsobjectkeywords[].metrics.impressionsinteger | nullkeywords[].metrics.clicksinteger | nullkeywords[].metrics.costnumber | null- In the account currency
keywords[].metrics.costMicrosinteger | nullkeywords[].metrics.conversionsnumber | nullkeywords[].metrics.conversionsValuenumber | nullkeywords[].metrics.ctrnumber | nullkeywords[].metrics.averageCpcnumber | null- cost ÷ clicks, in the account currency
TypeScript type
/** output.data when output.found is true */
type GoogleAdsKeywords = {
customerId: string;
currencyCode: string | null;
/** The GAQL date condition used, e.g. "DURING LAST_30_DAYS" */
period: string;
nextCursor: string | null;
keywords: {
criterionId: string;
resourceName: string;
text: string | null;
/** EXACT, PHRASE or BROAD */
matchType: string | null;
/** ENABLED, PAUSED or REMOVED */
status: string | null;
/** ELIGIBLE, PAUSED, REMOVED, PENDING or NOT_ELIGIBLE */
primaryStatus: string | null;
/** APPROVED, DISAPPROVED, PENDING_REVIEW or UNDER_REVIEW */
approvalStatus: string | null;
/** 1-10; null when Google does not have enough data to score the keyword */
qualityScore: number | null;
/** Expected click-through rate compared with other advertisers (search_predicted_ctr) */
predictedCtr: string | null;
/** The ad compared with other advertisers (creative_quality_score) */
creativeQuality: string | null;
/** Landing page quality (post_click_quality_score) */
landingPageQuality: string | null;
/** Keyword max CPC bid, in the account currency */
cpcBid: number | null;
cpcBidMicros: number | null;
effectiveCpcBid: number | null;
effectiveCpcBidMicros: number | null;
adGroup: {
id: string | null;
name: string | null;
};
campaign: {
id: string | null;
name: string | null;
};
metrics: {
impressions: number | null;
clicks: number | null;
/** In the account currency */
cost: number | null;
costMicros: number | null;
conversions: number | null;
conversionsValue: number | null;
ctr: number | null;
/** cost ÷ clicks, in the account currency */
averageCpc: number | null;
};
}[];
};If what you asked about does not exist, is private, or a search matches nothing, the call still succeeds: output.found is false, output.data is null and output.reason says why. Such misses are free unless the notes below say misses are billed, in which case a miss costs the price of one call.
Pagination. Pass the previous response’s nextCursor as cursor to get the next page. nextCursor: null means there is nothing more. See Pagination.
Example response
Values are placeholders that follow the output schema (strings as "string", numbers as 0); credits shows what this call would cost at the usual price.
{
"output": {
"found": true,
"data": {
"customerId": "1234567890",
"currencyCode": "USD",
"period": "DURING LAST_30_DAYS",
"keywords": [
{
"criterionId": "3331",
"resourceName": "customers/1234567890/adGroupCriteria/2221~3331",
"text": "example store",
"matchType": "PHRASE",
"status": "ENABLED",
"primaryStatus": "ELIGIBLE",
"approvalStatus": "APPROVED",
"qualityScore": 8,
"predictedCtr": "ABOVE_AVERAGE",
"creativeQuality": "ABOVE_AVERAGE",
"landingPageQuality": "AVERAGE",
"cpcBid": 1.2,
"cpcBidMicros": 1200000,
"effectiveCpcBid": 1.2,
"effectiveCpcBidMicros": 1200000,
"adGroup": {
"id": "2221",
"name": "Brand terms"
},
"campaign": {
"id": "111",
"name": "Brand - Search"
},
"metrics": {
"impressions": 2100,
"clicks": 250,
"cost": 137.5,
"costMicros": 137500000,
"conversions": 12.5,
"conversionsValue": 1375.25,
"ctr": 0.1190476,
"averageCpc": 0.55
}
}
],
"nextCursor": null
}
},
"provider": "PrimaryAPI",
"credits": 1,
"items": 1,
"requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z",
"nextCursor": null
}Pricing and reliability
Calls go only to upstreams that are healthy right now. If an attempt fails, the call is retried automatically inside the same request; a failed attempt costs nothing, and a call never costs more than its quote’s maxCredits. Live figures below are measured on real traffic.
Success rate, uptime, latency and call counts are measured live from real traffic over 30 days and show “—” until there is data.
Errors
Errors are JSON { code, error, requestId } and are never charged. The ones to handle for this endpoint:
- invalid_inputThe request failed validation before anything ran.
- unauthorizedNo valid API key or session was presented.
- insufficient_balanceThe balance cannot cover the most this call could cost.
- key_limit_reachedThe key’s own spend limit is used up for the current window.
- trial_cap_reachedAn agent trial key has used its whole trial budget.
- forbiddenThe credential is valid but may not do this.
- not_foundThe thing addressed by the URL does not exist for you.
- idempotency_conflictThe
Idempotency-Keyis already bound to a different request. - rate_limitedToo many requests in the current window.
- all_sources_failedThe call could not be answered, even after automatic retries.
- service_unavailableThis API cannot run in this deployment right now.
- timeoutThe request passed its deadline before it finished.
Notes
Runs as your connected Google account and needs the Google Ads capability (ads). Lists the keywords of the keyword report; amounts are in the account currency (currencyCode). Quality Score is today’s score (1-10) with its three parts (predicted CTR, creative and landing page quality, each BELOW_AVERAGE, AVERAGE or ABOVE_AVERAGE), null when Google has too little data. Sorted by cost, highest first. Narrow with campaignId or adGroupId; see what people actually searched with google-ads.search_terms.
More Google Ads endpoints
Generated from the PrimaryAPI catalog. Machine-readable contract: GET https://api.primaryapi.com/v1/apis/google-ads.keywords.