Google search ads API

Search ads in the Google ads library

curl --request POST \
  --url https://api.stophy.dev/v1/google/ads/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "nike.com"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({domain: 'nike.com'})
};

fetch('https://api.stophy.dev/v1/google/ads/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/google/ads/search"

payload = { "domain": "nike.com" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "adUrl": "<string>",
        "advertiserUrl": "<string>",
        "format": "text",
        "adId": "<string>",
        "advertiserId": "<string>",
        "advertiserName": "<string>",
        "domain": "<string>",
        "firstShownAt": "2023-11-07T05:31:56Z",
        "lastShownAt": "2023-11-07T05:31:56Z",
        "daysShown": 0,
        "previewUrl": "<string>",
        "imageUrl": "<string>"
      }
    ],
    "totalMin": 0,
    "totalMax": 0,
    "cursor": "<string>"
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

POST

google

ads

Search ads in the Google ads library

curl --request POST \
  --url https://api.stophy.dev/v1/google/ads/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "nike.com"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({domain: 'nike.com'})
};

fetch('https://api.stophy.dev/v1/google/ads/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/google/ads/search"

payload = { "domain": "nike.com" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "adUrl": "<string>",
        "advertiserUrl": "<string>",
        "format": "text",
        "adId": "<string>",
        "advertiserId": "<string>",
        "advertiserName": "<string>",
        "domain": "<string>",
        "firstShownAt": "2023-11-07T05:31:56Z",
        "lastShownAt": "2023-11-07T05:31:56Z",
        "daysShown": 0,
        "previewUrl": "<string>",
        "imageUrl": "<string>"
      }
    ],
    "totalMin": 0,
    "totalMax": 0,
    "cursor": "<string>"
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

Searches ads in the Google ads library.

Request

At least one of query, advertiser or domain is required.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.google.ads.search({ domain: "nike.com" });
console.log(result.data.results);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.google.ads.search(domain="nike.com")
print(result["data"]["results"])

curl -X POST https://api.stophy.dev/v1/google/ads/search \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"domain":"nike.com"}'

stophy google ads search --domain nike.com

Response

If successful, the response body contains the standard envelope. data.results[] contains the ads, each with its advertiser and the days it ran. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "results": [
      {
        "adId": "CR00462730911658541057",
        "adUrl": "https://adstransparency.google.com/advertiser/AR16735076323512287233/creative/CR00462730911658541057",
        "advertiserId": "AR16735076323512287233",
        "advertiserName": "Nike, Inc.",
        "advertiserUrl": "https://adstransparency.google.com/advertiser/AR16735076323512287233",
        "domain": "nike.com",
        "format": "text",
        "firstShownAt": "2022-11-30T14:47:52.000Z",
        "lastShownAt": "2026-10-05T20:27:35.000Z",
        "daysShown": 1350,
        "imageUrl": "https://tpc.googlesyndication.com/archive/simgad/5743239130676952852"
      }
    ],
    "totalMin": 100000,
    "totalMax": 200000,
    "cursor": "CgoAP7zmi4ohfCUHEhBNRhEc0rwv/RRMIVUAAAAAGgn8+Ghj+Osc6yI="
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`cursor`	string	The pagination token. Pass it as `cursor` to retrieve the next page. Omitted on the last page.
`totalMin`	integer	With `totalMax`, the range for the number of matching ads.
`firstShownAt`	string (ISO 8601)	The first day the ad was shown.
`lastShownAt`	string (ISO 8601)	The last day the ad was shown.

For every field, see the response schema on this page.

Optional parameters

Parameter	Type	Description
`query`	string	A domain such as `nike.com`.
`advertiser`	string	An advertiser id from Google ads advertisers.
`domain`	string	A domain such as `nike.com`.
`country`	string	Two-letter country code, such as `de`. Only ads shown there are returned.
`mediaType`	string	Restricts results to ads of this type. Acceptable values are `text`, `image` and `video`.
`platform`	string	Where the ad was shown. Acceptable values are `search`, `youtube`, `play`, `maps` and `shopping`.
`shownFrom`	string (date)	Restricts results to ads shown on or after this day. Format: `YYYY-MM-DD`.
`shownTo`	string (date)	Restricts results to ads shown on or before this day. Format: `YYYY-MM-DD`.
`cursor`	string	The pagination token from the previous response.

The Google ad library does not support keyword search. To search by advertiser name, first resolve the advertiser ID with Google advertisers.

Billing

Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.

Pagination

Results are paginated. To retrieve the next page, pass the value of data.cursor as cursor in a subsequent request. A response that omits cursor is the last page.

Google ads search: Accepts an advertiserId as advertiser. Searches ads in the Google ads library.
Google ad details: Accepts adUrl. Returns a Google ad’s details.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

query

string

A domain like nike.com. Google's library finds ads by domain or advertiser, not by keyword.

Required string length: 1 - 200

advertiser

string

domain

string

country

string

Country code like de. Only ads shown in this country are returned. Any case is accepted.

Pattern: ^[A-Za-z]{2}$

mediaType

enum<string>

Available options:

text,

image,

video

platform

enum<string>

Google's own Platform filter: where the ad was shown.

Available options:

search,

youtube,

play,

maps,

shopping

shownFrom

string<date>

Google's own Date range: ads shown on or after this day.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

shownTo

string<date>

Google's own Date range: ads shown on or before this day.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

cursor

string

The cursor from the previous response. Send it as is.

Minimum string length: 1

Response

The data, and the credits this call used.

success

any

required

data

object

required

Show child attributes

creditsUsed

integer

required

requestId

string

required

Using the API

Catalog

Account

Search and AI answers

Video

Social

Places and travel

Jobs

Shopping

Apps

Real estate

Ads

Google search ads API

Request

Response

Optional parameters

Billing

Authorizations

Body

Response

​Request

​Response

​Optional parameters

​Billing

​Pagination

​Related methods

Authorizations

Body

Response

Request

Response

Optional parameters

Billing

Pagination

Related methods