{ "openapi": "3.0.1", "info": { "title": "Google Ads Transparency Scraper with Ad Text", "description": "Extract Search, YouTube, Shopping, Maps and Play ads from the Google Ads Transparency Center by brand, domain or advertiser ID. Ad text included at no extra cost.", "version": "0.2", "x-build-id": "xzDUU0yeWIuUCoKFm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/billy_turambar~google-ads-transparency-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-billy_turambar-google-ads-transparency-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/billy_turambar~google-ads-transparency-scraper/runs": { "post": { "operationId": "runs-sync-billy_turambar-google-ads-transparency-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/billy_turambar~google-ads-transparency-scraper/run-sync": { "post": { "operationId": "run-sync-billy_turambar-google-ads-transparency-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "queries": { "title": "Brands or advertiser names", "type": "array", "description": "Brand or advertiser names to search, e.g. \"Nike\". Each query is resolved to the best matching advertisers. Values that look like a domain (nike.com) are searched as domains.", "items": { "type": "string" } }, "domains": { "title": "Domains", "type": "array", "description": "Website domains whose ads you want, e.g. hubspot.com. Returns ads from every advertiser promoting that domain.", "items": { "type": "string" } }, "advertiserIds": { "title": "Advertiser IDs", "type": "array", "description": "Advertiser IDs from the Transparency Center (they start with AR).", "items": { "type": "string" } }, "startUrls": { "title": "Transparency Center URLs", "type": "array", "description": "Advertiser or creative URLs copied from adstransparency.google.com.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "region": { "title": "Region", "type": "string", "description": "Two-letter country code (US, DE, GB...) or \"anywhere\" for all regions.", "default": "anywhere" }, "platform": { "title": "Platform", "enum": [ "ANY", "SEARCH", "YOUTUBE", "SHOPPING", "MAPS", "PLAY" ], "type": "string", "description": "Only return ads shown on this platform.", "default": "ANY" }, "format": { "title": "Ad format", "enum": [ "ANY", "TEXT", "IMAGE", "VIDEO" ], "type": "string", "description": "Only return ads of this format.", "default": "ANY" }, "dateFrom": { "title": "Shown from", "type": "string", "description": "Only ads shown on or after this date (YYYY-MM-DD)." }, "dateTo": { "title": "Shown until", "type": "string", "description": "Only ads shown on or before this date (YYYY-MM-DD)." }, "maxAdsPerTarget": { "title": "Max ads per target", "minimum": 1, "type": "integer", "description": "Maximum number of ads returned for each query, domain, advertiser or URL.", "default": 100 }, "maxAdvertisersPerQuery": { "title": "Max advertisers per query", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many matching advertisers to scrape for each brand query.", "default": 3 }, "extractAdText": { "title": "Extract ad text", "type": "boolean", "description": "Read the headline and description of each ad. Search text ads are rendered as images, so their text is read with OCR. Included at no extra cost.", "default": true }, "ocrLanguages": { "title": "OCR languages", "type": "string", "description": "Tesseract language codes used to read text ads, joined with + (e.g. eng+deu+spa).", "default": "eng" }, "includeDetails": { "title": "Include creative details", "type": "boolean", "description": "Fetch all A/B variations and the list of regions where each ad was shown. Billed per ad.", "default": false }, "onlyNewAds": { "title": "Only new ads (monitoring)", "type": "boolean", "description": "Skip ads returned by previous runs with the same monitoring key. Ideal for scheduled runs that track competitors.", "default": false }, "monitoringKey": { "title": "Monitoring key", "type": "string", "description": "Name of the list of already seen ads. Use different keys for different monitoring jobs.", "default": "default" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxies used for the requests. Apify datacenter proxies are usually enough.", "default": { "useApifyProxy": true } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }