{ "openapi": "3.0.1", "info": { "title": "Google Ads Transparency Scraper", "description": "Get every ad a brand or website runs on Google Search, YouTube, Maps, Play and Shopping from the Ads Transparency Center: previews, dates and formats, plus optional reach by country and EU impressions.", "version": "0.1", "x-build-id": "tylTzsGTRrSmaoHWB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/agusgueglio14~google-ads-transparency-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-agusgueglio14-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/agusgueglio14~google-ads-transparency-scraper/runs": { "post": { "operationId": "runs-sync-agusgueglio14-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/agusgueglio14~google-ads-transparency-scraper/run-sync": { "post": { "operationId": "run-sync-agusgueglio14-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": { "domains": { "title": "Domains", "type": "array", "description": "Get every ad that points to these websites, from all advertisers, e.g. nike.com.", "items": { "type": "string" } }, "advertiserNames": { "title": "Advertiser names", "type": "array", "description": "Brand or company names, e.g. Coca-Cola. Each name is matched to the advertisers with the most ads (see 'Advertisers per name'). For exact results, use advertiser IDs instead.", "items": { "type": "string" } }, "advertiserIds": { "title": "Advertiser IDs", "type": "array", "description": "Advertiser IDs from the Ads Transparency Center, e.g. AR16735076323512287233 (the part after /advertiser/ in the page URL).", "items": { "type": "string" } }, "startUrls": { "title": "Ads Transparency Center links", "type": "array", "description": "Paste links from adstransparency.google.com: an advertiser page, a domain search or a single ad. Filters in a link (region, platform, format, dates) are applied to that link. Single ads always include reach details.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "region": { "title": "Region", "type": "string", "description": "Only ads shown in this country: a two-letter code such as US, GB, DE, ES or BR. Leave empty for all regions." }, "platform": { "title": "Platform", "enum": [ "ALL", "GOOGLE_SEARCH", "YOUTUBE", "GOOGLE_PLAY", "GOOGLE_MAPS", "GOOGLE_SHOPPING" ], "type": "string", "description": "Only ads shown on this Google platform. Google only tracks the platform for ads shown since September 2023.", "default": "ALL" }, "format": { "title": "Ad format", "enum": [ "ALL", "TEXT", "IMAGE", "VIDEO" ], "type": "string", "description": "Only ads of this format.", "default": "ALL" }, "startDate": { "title": "Shown from", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Only ads shown on or after this date, as YYYY-MM-DD." }, "endDate": { "title": "Shown until", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Only ads shown on or before this date, as YYYY-MM-DD." }, "maxAdsPerSource": { "title": "Max ads per domain or advertiser", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many ads for each domain, advertiser or link. Big brands can have tens of thousands of ads.", "default": 100 }, "includeDetails": { "title": "Include reach details", "type": "boolean", "description": "For each ad, add every country it was shown in with first and last dates, impression ranges (published for the EU and some other regions) by platform, and all ad variations. Charged as an extra event per ad.", "default": false }, "maxAdvertisersPerName": { "title": "Advertisers per name", "minimum": 1, "maximum": 10, "type": "integer", "description": "Big brands advertise through several accounts (e.g. one per country). For each advertiser name, scrape this many matching accounts, starting with the one with the most ads.", "default": 3 }, "onlyNewAds": { "title": "Only new ads (monitoring)", "type": "boolean", "description": "Return only ads that earlier runs with the same input haven't returned yet. Schedule this Actor or a task daily or weekly to track competitors' new ads. The first run returns the current ads and remembers them; after that you only pay for new ads. Each run checks the most recently shown ads, up to 'Max ads per domain or advertiser'.", "default": false }, "monitoringId": { "title": "Monitor name", "pattern": "^[a-zA-Z0-9-]{0,40}$", "type": "string", "description": "Optional. Runs with the same monitor name share their memory of ads already returned. Leave empty to keep one memory per input. Use a new name to start over." }, "maxRetries": { "title": "Max retries per request", "minimum": 0, "maximum": 15, "type": "integer", "description": "How many times to retry on a new IP when Google blocks or rate-limits a request.", "default": 6 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many domains, advertisers or links to process in parallel.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential proxies keep runs reliable when Google rate-limits requests.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }