{ "openapi": "3.0.1", "info": { "title": "Google Shopping Product Reviews Scraper", "description": "Collect public Google Shopping product details, merchant offers, rating summaries, and visible reviews.", "version": "2.1", "x-build-id": "jTkxVoTEzY5ncxcnD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/googleapi~google-shopping-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-googleapi-google-shopping-reviews-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/googleapi~google-shopping-reviews-scraper/runs": { "post": { "operationId": "runs-sync-googleapi-google-shopping-reviews-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/googleapi~google-shopping-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-googleapi-google-shopping-reviews-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": "Shopping queries", "maxItems": 100, "type": "array", "description": "Product search terms. Each query can produce up to maxItems product records across the run.", "items": { "type": "string", "minLength": 1, "maxLength": 300 } }, "query": { "title": "Shopping query", "minLength": 1, "maxLength": 300, "type": "string", "description": "A single product search term. Use queries for multiple terms." }, "productUrls": { "title": "Product URLs", "maxItems": 100, "type": "array", "description": "Public Google Shopping product-page URLs. Google-generated Shopping search links with a #sv= viewer fragment are accepted intact; legacy ID-only pages may be unavailable.", "items": { "type": "string", "maxLength": 16000 } }, "productIds": { "title": "Product IDs", "maxItems": 100, "type": "array", "description": "Google Shopping product identifiers copied from a public product page. IDs are not generated when the page does not expose one.", "items": { "type": "string", "maxLength": 300 } }, "startUrls": { "title": "Google Shopping URLs", "maxItems": 100, "type": "array", "description": "Google Shopping search or product URLs. These are processed before query and product URL inputs; duplicate targets are removed.", "items": { "type": "object", "properties": { "url": { "title": "URL", "type": "string", "description": "Public Google Shopping search or product URL.", "maxLength": 2000 } }, "required": [ "url" ], "additionalProperties": false } }, "countryCode": { "title": "Country code", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Two-letter Google country parameter used for generated search URLs and currency interpretation.", "default": "us" }, "languageCode": { "title": "Language code", "pattern": "^[A-Za-z]{2,3}(-[A-Za-z]{2})?$", "type": "string", "description": "Google language parameter, such as en or en-us.", "default": "en" }, "maxItems": { "title": "Maximum products", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum product business records across all search sources. Review records are additionally limited by maxReviewsPerProduct.", "default": 10 }, "maxReviewsPerProduct": { "title": "Reviews per product", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum public individual review records retained for each product.", "default": 10 }, "page": { "title": "Starting page", "minimum": 1, "maximum": 1, "type": "integer", "description": "Google did not expose a stable page cursor in the inspected Shopping feed. This source currently supports page 1 only.", "default": 1 }, "maxPages": { "title": "Maximum pages", "minimum": 1, "maximum": 1, "type": "integer", "description": "Google did not expose a stable page cursor in the inspected Shopping feed. This source currently supports one page per search target.", "default": 1 }, "renderJavaScript": { "title": "Render Shopping pages", "type": "boolean", "description": "Use ordinary Chromium page rendering to open public product viewers and expand visible reviews. If Google presents an access boundary, the Actor stops that target.", "default": true }, "timeoutMs": { "title": "Request timeout (ms)", "minimum": 5000, "maximum": 120000, "type": "integer", "description": "Maximum time for each direct request or browser navigation.", "default": 30000 }, "browserWaitMs": { "title": "Browser wait (ms)", "minimum": 0, "maximum": 20000, "type": "integer", "description": "Bounded wait for public product details to render after navigation or opening a product viewer.", "default": 1800 }, "maxRetries": { "title": "HTTP retries", "minimum": 0, "maximum": 3, "type": "integer", "description": "Additional direct HTTP attempts for transient failures. Access boundaries are never retried.", "default": 1 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional proxy routing for both HTTP and ordinary Chromium requests. Residential groups may be selected when enabled. GOOGLE_SERP requires renderJavaScript=false and supplies static public pages." } } }, "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 } } } } } } } } } }