{ "openapi": "3.0.1", "info": { "title": "Google Play Keywords Discovery Tool", "description": "Discover Google Play autocomplete suggestions and optionally enrich them with bounded public app profiles.", "version": "1.1", "x-build-id": "retbihif2I98Yxv12" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/googleapi~google-play-keyword-discovery-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-googleapi-google-play-keyword-discovery-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-play-keyword-discovery-scraper/runs": { "post": { "operationId": "runs-sync-googleapi-google-play-keyword-discovery-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-play-keyword-discovery-scraper/run-sync": { "post": { "operationId": "run-sync-googleapi-google-play-keyword-discovery-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": { "keywords": { "title": "Seed keywords", "minItems": 1, "maxItems": 20, "type": "array", "description": "One to twenty phrases to expand using Google Play autocomplete.", "items": { "type": "string", "minLength": 1, "maxLength": 100 } }, "keyword": { "title": "Single seed keyword (legacy alias)", "minLength": 1, "maxLength": 100, "type": "string", "description": "Compatibility alias used only when keywords is omitted." }, "country": { "title": "Country", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Two-letter country code sent as Google's gl parameter.", "default": "us" }, "language": { "title": "Language", "pattern": "^[a-z]{2,3}(?:-[A-Z]{2})?$", "type": "string", "description": "Google suggestion language code sent as hl.", "default": "en" }, "expandAlphabet": { "title": "Expand with characters", "type": "boolean", "description": "Request each seed followed by the configured expansion characters.", "default": true }, "expansionChars": { "title": "Expansion characters", "maxLength": 40, "type": "string", "description": "At most 40 letters or digits appended after each seed.", "default": "abcdefghijklmnopqrstuvwxyz0123456789" }, "customSuffixes": { "title": "Custom suffixes", "maxItems": 50, "type": "array", "description": "Optional words or short phrases appended to each seed.", "items": { "type": "string", "minLength": 1, "maxLength": 40 }, "default": [] }, "maxQueries": { "title": "Maximum suggestion requests", "minimum": 1, "maximum": 250, "type": "integer", "description": "Maximum generated seed and expansion requests; this is the source request budget, not page pagination.", "default": 100 }, "maxItems": { "title": "Maximum keyword records", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum number of unique suggestion records to save. Defaults to 200.", "default": 200 }, "includeAppResults": { "title": "Enrich with Google Play app results", "type": "boolean", "description": "When enabled, open each selected suggestion's Google Play search page and fetch bounded public app detail pages. Disabled by default; this adds requests and run time.", "default": false }, "maxAppSearches": { "title": "Maximum linked app-search pages", "minimum": 1, "maximum": 25, "type": "integer", "description": "Global cap on Google Play search pages opened for suggestion records when app-result enrichment is enabled.", "default": 5 }, "maxAppResults": { "title": "Maximum app results per suggestion", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum number of public app cards retained under each enriched suggestion. App cards beyond this cap are ignored.", "default": 5 }, "maxAppDetailPages": { "title": "Maximum app detail pages", "minimum": 0, "maximum": 50, "type": "integer", "description": "Global cap on Google Play app detail pages fetched across the run. Set to 0 to keep search-card fields only.", "default": 10 }, "page": { "title": "Starting page", "minimum": 1, "maximum": 1, "type": "integer", "description": "Fixed at 1 because Google Play returns one autocomplete response per generated term rather than numbered pages.", "default": 1 }, "maxPages": { "title": "Maximum pages", "minimum": 1, "maximum": 1, "type": "integer", "description": "Fixed at 1; this source has no paginated result pages. Use maxQueries to bound autocomplete requests.", "default": 1 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional active Apify Proxy configuration for Google suggestion requests." }, "requestDelayMs": { "title": "Delay between requests (milliseconds)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Pause between generated suggestion requests. Use 0 only for small runs.", "default": 250 }, "maxRequestRetries": { "title": "Maximum request retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Finite retries for timeouts, rate limits, and server/network failures.", "default": 2 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 3, "maximum": 60, "type": "integer", "description": "Maximum time allowed for each suggestion request attempt.", "default": 20 } } }, "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 } } } } } } } } } }