{ "openapi": "3.0.1", "info": { "title": "Google Ads Traffic Forecast", "description": "Estimate Google Ads clicks, average CPC, and campaign cost for up to 1,000 keywords across major countries, languages, bids, match types, and forecast periods.", "version": "1.1", "x-build-id": "NG1bOhejo9PhURyNv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/opspilot.cc~google-ads-traffic-forecast/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-opspilot.cc-google-ads-traffic-forecast", "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/opspilot.cc~google-ads-traffic-forecast/runs": { "post": { "operationId": "runs-sync-opspilot.cc-google-ads-traffic-forecast", "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/opspilot.cc~google-ads-traffic-forecast/run-sync": { "post": { "operationId": "run-sync-opspilot.cc-google-ads-traffic-forecast", "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": [ "keywords", "locations", "language", "bid", "match", "date_interval" ], "properties": { "keywords": { "title": "Keyword", "type": "string", "description": "Enter exactly one keyword or phrase per run. Maximum 80 characters and 10 words.", "default": "seo tools" }, "locations": { "title": "Target Locations", "type": "array", "description": "Select one or more major countries. One forecast task is created per selected country.", "items": { "type": "string", "enum": [ "United States", "United Kingdom", "Germany", "France", "Canada", "Australia", "Japan", "India", "China", "Brazil", "Italy", "Spain", "Netherlands", "South Korea", "Mexico", "Indonesia", "Turkiye", "Switzerland", "Sweden", "Poland", "Belgium", "Austria", "Norway", "Denmark", "Finland", "Ireland", "Singapore", "New Zealand", "Israel", "United Arab Emirates", "Saudi Arabia", "South Africa", "Philippines", "Thailand", "Vietnam", "Malaysia", "Argentina", "Chile", "Colombia" ], "enumTitles": [ "United States", "United Kingdom", "Germany", "France", "Canada", "Australia", "Japan", "India", "China", "Brazil", "Italy", "Spain", "Netherlands", "South Korea", "Mexico", "Indonesia", "Turkiye", "Switzerland", "Sweden", "Poland", "Belgium", "Austria", "Norway", "Denmark", "Finland", "Ireland", "Singapore", "New Zealand", "Israel", "United Arab Emirates", "Saudi Arabia", "South Africa", "Philippines", "Thailand", "Vietnam", "Malaysia", "Argentina", "Chile", "Colombia" ] }, "default": [ "United States" ] }, "language": { "title": "Target Language", "enum": [ "English", "Chinese (Simplified)", "Chinese (Traditional)", "Japanese", "Korean", "Hindi", "Arabic", "Indonesian", "Vietnamese", "Thai", "German", "French", "Spanish", "Portuguese", "Russian", "Italian", "Dutch", "Polish", "Turkish", "Hebrew" ], "type": "string", "description": "Select the target language market. Keywords are not translated automatically.", "default": "English" }, "bid": { "title": "Maximum Bid", "minimum": 1, "type": "integer", "description": "Maximum bid used for the forecast. Higher bids may produce higher projected traffic and cost. Default: 999.", "default": 999 }, "match": { "title": "Keyword Match Type", "enum": [ "exact", "phrase", "broad" ], "type": "string", "description": "Exact targets the entered keywords, phrase includes close phrase variants, and broad estimates wider related demand.", "default": "exact" }, "date_interval": { "title": "Forecast Period", "enum": [ "next_week", "next_month", "next_quarter" ], "type": "string", "description": "Time period covered by estimated clicks and cost.", "default": "next_month" } } }, "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 } } } } } } } } } }