{ "openapi": "3.0.1", "info": { "title": "Google Ads Scraper", "description": "Scrapes the Google Product Listing Ad (PLA) carousel for a list of search terms and filters the products by store name.", "version": "0.3", "x-build-id": "TGdFQ1pMraExfqw95" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/surefind~google-ads-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-surefind-google-ads-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/surefind~google-ads-scraper/runs": { "post": { "operationId": "runs-sync-surefind-google-ads-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/surefind~google-ads-scraper/run-sync": { "post": { "operationId": "run-sync-surefind-google-ads-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", "required": [ "searchQueries" ], "properties": { "searchQueries": { "title": "Search queries", "type": "string", "description": "Comma-separated list of search terms, e.g. `buy dyson v15 vacuum, nespresso vertuo pods`. Each term runs one Google search and its Shopping (Product Listing) ads are scraped. Split on commas; empty/whitespace-only entries are dropped. High commercial-intent terms (\"buy ...\", specific product models) are far more likely to show shopping ads." }, "storeNames": { "title": "Store names to keep", "type": "array", "description": "Keep only products whose store name contains one of these entries (case-insensitive substring match against the store shown on the ad card, e.g. `Best Buy`, `Dyson Official`). Leave empty to return every product in the shopping ads.", "default": [], "items": { "type": "string" } }, "region": { "title": "Region (country code)", "enum": [ "", "us", "gb", "ca", "au", "de", "fr", "es", "it", "nl", "in", "br" ], "type": "string", "description": "Two-letter country code. Drives three things that stay in sync: the Google `gl` search parameter, the proxy country (when a proxy is used), and the `Accept-Language` header. Leave empty to behave like a plain US search with no proxy country pinning." }, "retryLimit": { "title": "Retry limit", "minimum": 0, "type": "integer", "description": "Maximum retry attempts per search query after a block/error. On each retry the browser is fully closed and relaunched with a fresh proxy. Regions with a thin proxy pool may need a higher value.", "default": 3 }, "retryDelayMs": { "title": "Retry delay (ms)", "minimum": 0, "type": "integer", "description": "Delay in milliseconds before each retry attempt.", "default": 1000 }, "minSuccessfulQueries": { "title": "Minimum successful queries", "minimum": 1, "type": "integer", "description": "The Actor keeps cycling through the search queries, repeating them as needed, until this many queries have completed cleanly (a clean run with zero matches still counts). Set low for testing; 100+ for production.", "default": 100 }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Maximum number of products pushed to the dataset. The run stops as soon as this many rows are collected (or once `minSuccessfulQueries` clean queries complete — whichever comes first). This is your cost cap: it bounds the number of billed results before you press Start.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. If omitted, the Actor runs without a proxy (like the original). Google blocks datacenter IPs aggressively — RESIDENTIAL is strongly recommended. When `region` is set and Apify Proxy is used, the proxy is pinned to that country.", "default": { "useApifyProxy": false } } } }, "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 } } }, "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 } } } } } } } } } }