Google Ads Query (GAQL)
Runs a read-only Google Ads Query Language (GAQL) report on a Google Ads account: any resources, fields, segments and metrics.
- 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. queryAuth: 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.query with the same body (free).
Example request
curl -sS -X POST "https://api.primaryapi.com/v1/run/google-ads.query" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"customerId":"123-456-7890","query":"SELECT campaign.name, campaign.id, metrics.clicks, metrics.impressions, metrics.cost_micros FROM campaign WHERE segments.date DURING LAST_7_DAYS ORDER BY metrics.clicks DESC"}'const res = await fetch('https://api.primaryapi.com/v1/run/google-ads.query', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.PRIMARYAPI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
customerId: '123-456-7890',
query: 'SELECT campaign.name, campaign.id, metrics.clicks, metrics.impressions, metrics.cost_micros FROM campaign WHERE segments.date DURING LAST_7_DAYS ORDER BY metrics.clicks DESC',
}),
});
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.query",
headers={"Authorization": f"Bearer {os.environ['PRIMARYAPI_API_KEY']}"},
json={
"customerId": "123-456-7890",
"query": "SELECT campaign.name, campaign.id, metrics.clicks, metrics.impressions, metrics.cost_micros FROM campaign WHERE segments.date DURING LAST_7_DAYS ORDER BY metrics.clicks DESC",
},
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.query",
"input": {
"customerId": "123-456-7890",
"query": "SELECT campaign.name, campaign.id, metrics.clicks, metrics.impressions, metrics.cost_micros FROM campaign WHERE segments.date DURING LAST_7_DAYS ORDER BY metrics.clicks DESC"
}
}
}Price this exact input first (free)
curl -sS -X POST "https://api.primaryapi.com/v1/quote/google-ads.query" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"customerId":"123-456-7890","query":"SELECT campaign.name, campaign.id, metrics.clicks, metrics.impressions, metrics.cost_micros FROM campaign WHERE segments.date DURING LAST_7_DAYS ORDER BY metrics.clicks DESC"}'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})$
querystringrequired- A Google Ads Query Language (GAQL) SELECT, e.g. "SELECT campaign.name, metrics.clicks FROM campaign WHERE segments.date DURING LAST_7_DAYS ORDER BY metrics.clicks DESC LIMIT 50". Read-only.max 20000 chars
limitintegerdefault100- Maximum number of results to return (1-1000, default 100).1–1000
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 rows, billed per item returned).
customerIdstringrowsobject[]- One object per result row, keyed by resource (campaign, adGroup, metrics, segments…) in lowerCamelCase; 64-bit numbers are strings
fieldMaskstring | null- The fields Google returned, comma-separated
nextCursorstring | null
TypeScript type
/** output.data when output.found is true */
type GoogleAdsQuery = {
customerId: string;
/** One object per result row, keyed by resource (campaign, adGroup, metrics, segments…) in lowerCamelCase; 64-bit numbers are strings */
rows: Array<Record<string, unknown>>;
/** The fields Google returned, comma-separated */
fieldMask: string | null;
nextCursor: string | 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",
"rows": [
{
"campaign": {
"resourceName": "customers/1234567890/campaigns/111",
"name": "Brand - Search",
"id": "111"
},
"metrics": {
"clicks": "842",
"impressions": "12904",
"costMicros": "412500000"
}
},
{
"campaign": {
"resourceName": "customers/1234567890/campaigns/222",
"name": "Generic - Search",
"id": "222"
},
"metrics": {
"clicks": "311",
"impressions": "25110",
"costMicros": "688100000"
}
}
],
"fieldMask": "campaign.name,campaign.id,metrics.clicks,metrics.impressions,metrics.costMicros",
"nextCursor": null
}
},
"provider": "PrimaryAPI",
"credits": 1,
"items": 2,
"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). Read-only: GAQL can only SELECT. Field names in the query are snake_case (metrics.cost_micros); the rows come back in lowerCamelCase (metrics.costMicros) and money is in micros (1,000,000 = one unit of the account currency). Manager accounts have no metrics: query a client account, passing the manager id as loginCustomerId. Add a LIMIT to keep large reports fast. A rejected query is an invalid input error (nothing is charged).
More Google Ads endpoints
Generated from the PrimaryAPI catalog. Machine-readable contract: GET https://api.primaryapi.com/v1/apis/google-ads.query.