> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Google search ads API
> Search ads in the Google ads library. Call the Google search ads API and get JSON back in one request. 1 credit per call. Failed calls cost nothing.
Searches ads in the Google ads library.
## Request
At least one of `query`, `advertiser` or `domain` is required.
```typescript TypeScript icon="https://mintcdn.com/sirathic/7E4w9-IC4ysabjfc/images/icons/typescript.svg?fit=max&auto=format&n=7E4w9-IC4ysabjfc&q=85&s=d8272a85e64145620f1fbbfcf7932986" theme={null}
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);
```
```python Python icon="python" theme={null}
from stophy import Stophy
stophy = Stophy() # reads STOPHY_API_KEY
result = stophy.google.ads.search(domain="nike.com")
print(result["data"]["results"])
```
```bash cURL icon="terminal" theme={null}
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"}'
```
```bash CLI icon="square-terminal" theme={null}
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.
```json theme={null}
{
"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](/api-reference/endpoint/google-ads-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.
## Related methods
* [Google ads search](/api-reference/endpoint/google-ads-search): Accepts an `advertiserId` as `advertiser`. Searches ads in the Google ads library.
* [Google ad details](/api-reference/endpoint/google-ads-ad): Accepts `adUrl`. Returns a Google ad's details.
## OpenAPI
````yaml api-reference/openapi.json POST /v1/google/ads/search
openapi: 3.1.0
info:
title: Stophy API
version: '1'
description: >-
Every endpoint is a POST that takes its input as a JSON object body. Unknown
fields are rejected with 400.
Responses leave out empty values: null, empty strings, empty objects and
empty nested lists are not sent.
x-credits is what one call costs. Every call costs the same, whatever it
returns, unless an operation's description says it costs per 10 results, or
per second of audio. Then x-credits is the lowest price and x-credits-max
the most one call can cost. Where an operation takes limit, send it to
return fewer results and pay for fewer.
When a response has a cursor, send it back unchanged with the same input to
get the next page. When it has a page, send the next page number.
servers:
- url: https://api.stophy.dev
security:
- apiKey: []
paths:
/v1/google/ads/search:
post:
summary: Search ads in the Google ads library
description: Costs 1 credit per call. Pages with cursor.
operationId: googleAdsSearch
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
query:
description: >-
A domain like nike.com. Google's library finds ads by domain
or advertiser, not by keyword.
type: string
minLength: 1
maxLength: 200
advertiser:
type: string
domain:
type: string
country:
type: string
pattern: ^[A-Za-z]{2}$
description: >-
Country code like de. Only ads shown in this country are
returned. Any case is accepted.
mediaType:
type: string
enum:
- text
- image
- video
platform:
description: 'Google''s own Platform filter: where the ad was shown.'
type: string
enum:
- search
- youtube
- play
- maps
- shopping
shownFrom:
description: 'Google''s own Date range: ads shown on or after this day.'
type: string
format: date
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:
description: 'Google''s own Date range: ads shown on or before this day.'
type: string
format: date
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:
type: string
minLength: 1
description: The cursor from the previous response. Send it as is.
additionalProperties: false
example:
domain: nike.com
responses:
'200':
description: The data, and the credits this call used.
headers:
X-Request-ID:
$ref: '#/components/headers/RequestId'
x-credits-used:
$ref: '#/components/headers/CreditsUsed'
X-RateLimit-Limit:
$ref: '#/components/headers/RateLimitLimit'
X-RateLimit-Remaining:
$ref: '#/components/headers/RateLimitRemaining'
X-RateLimit-Reset:
$ref: '#/components/headers/RateLimitReset'
x-cache:
$ref: '#/components/headers/Cache'
x-cache-age:
$ref: '#/components/headers/CacheAge'
content:
application/json:
schema:
type: object
required:
- success
- data
- creditsUsed
- requestId
properties:
success:
const: true
data:
type: object
additionalProperties: false
properties:
totalMin:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
totalMax:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
results:
type: array
items:
type: object
additionalProperties: false
properties:
adId:
type: string
adUrl:
type: string
format: uri
advertiserId:
type: string
advertiserName:
type: string
advertiserUrl:
type: string
format: uri
domain:
type: string
format:
type: string
enum:
- text
- image
- video
- unknown
firstShownAt:
type: string
format: date-time
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])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
lastShownAt:
type: string
format: date-time
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])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
daysShown:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
previewUrl:
type: string
format: uri
imageUrl:
type: string
format: uri
required:
- adUrl
- advertiserUrl
- format
cursor:
type: string
required:
- results
creditsUsed:
type: integer
requestId:
type: string
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
components:
headers:
RequestId:
description: The request id. Quote it when you report a problem.
schema:
type: string
CreditsUsed:
description: Credits this call used.
schema:
type: integer
RateLimitLimit:
description: Requests allowed in the current window.
schema:
type: integer
RateLimitRemaining:
description: Requests left in the current window.
schema:
type: integer
RateLimitReset:
description: Unix time in seconds when the current window resets.
schema:
type: integer
Cache:
description: hit if this result came from the cache, miss if it was fetched live.
schema:
type: string
CacheAge:
description: Seconds since the returned result was written to the cache.
schema:
type: integer
RetryAfter:
description: Seconds to wait before retrying.
schema:
type: integer
responses:
Error:
description: The request failed. retryable says whether trying again can help.
headers:
X-Request-ID:
$ref: '#/components/headers/RequestId'
Retry-After:
$ref: '#/components/headers/RetryAfter'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Error:
type: object
required:
- success
- error
properties:
success:
const: false
error:
type: object
required:
- code
- message
- retryable
- requestId
properties:
code:
type: string
enum:
- cliSessionCompleted
- cliSessionExists
- cliSessionNotFound
- forbidden
- insufficientCredits
- internalError
- inviteClaimed
- inviteDisabled
- inviteExpired
- inviteUsedUp
- invalidCliSession
- invalidCliVerifier
- invalidRequest
- notFound
- rateLimited
- sourceChanged
- sourceRefused
- sourceTimeout
- sourceUnavailable
- tooManyInFlight
- unauthorized
- unsupportedMediaType
message:
type: string
retryable:
type: boolean
retryAfterSeconds:
type: integer
requestId:
type: string
requiredCredits:
type: number
availableCredits:
type: number
billingUrl:
type: string
const: https://stophy.dev/billing
securitySchemes:
apiKey:
type: http
scheme: bearer
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.