Docs
View as Markdown

google.ad

beta 2 credits needs a pack

One Google Ads Transparency creative: advertiser, format, impression and spend ranges, targeting, copy.

GET /v1/google/ad

What you get#

One Google record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

  • 2 credits for a fresh fetch, charged only when it succeeds.
  • Free when served from cache (0.2 credit for a cached response over 100 KB).
  • Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

NameTypeRequiredDefaultWhat it isConstraints
urlstringyes(required)Ads Transparency Center creative URL (…/advertiser/AR…/creative/CR…)max 255 chars; must match https://adstransparency\.google\.com/advertiser/AR[0-9]{10,30}/creative/CR[0-9]{10,30}[^\s]{0,100}; trimmed

Request#

curl "https://api.onekey.dev/v1/google/ad?url=https%3A%2F%2Fadstransparency.google.com%2Fadvertiser%2FAR01614014350098432001%2Fcreative%2FCR07443539616616939521" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Google response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": {
    "content": {
      "id": "CR07443539616616939521",
      "type": "text",
      "updatedAt": "2025-06-18T18:09:00Z",
      "title": "lululemon Official Site - Best Birthday Gifts",
      "text": "Find The Perfect Gifts At lululemon."
    },
    "author": {
      "id": "AR01614014350098432001"
    },
    "media": {
      "url": "https://tpc.googlesyndication.com/archive/simgad/1"
    },
    "ext": {
      "impressionsMin": "250000",
      "impressionsMax": "300000",
      "spendCurrency": "USD",
      "spendLower": "5000",
      "spendUpper": "6000"
    }
  },
  "metadata": {
    "platform": "google",
    "endpoint": "ad",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 2,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
creativeIdcontent.id-
advertiserIdauthor.id-
formatcontent.type-
lastShowncontent.updatedAttoIsoDate
variations.0.headlinecontent.title-
variations.0.descriptioncontent.text-
variations.0.imageUrlmedia.urlsafeUrl
overallImpressions.minext.impressionsMin-
overallImpressions.maxext.impressionsMax-
spend.currencyext.spendCurrency-
spend.lowerext.spendLower-
spend.upperext.spendUpper-

Caching and freshness#

  • Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
  • Between 30 minutes and 6 hours the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
  • If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
  • A "not found" is remembered for 5 minutes and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundThat record does not exist. Free; do not retry.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: beta (not yet verified against the live source).