{ "openapi": "3.0.1", "info": { "title": "Google Sheets Import and Export for Apify", "description": "Import tabs from a shared workbook, or export a dataset: append below the last entry, replace a tab, or merge by ID. Needs a service account for writing; public links read freely.", "version": "0.1", "x-build-id": "uRrzgGDpZqp9QeAuV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bepolabs~google-sheets/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bepolabs-google-sheets", "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/bepolabs~google-sheets/runs": { "post": { "operationId": "runs-sync-bepolabs-google-sheets", "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/bepolabs~google-sheets/run-sync": { "post": { "operationId": "run-sync-bepolabs-google-sheets", "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": [ "spreadsheetId" ], "properties": { "mode": { "title": "Mode", "enum": [ "export", "import" ], "type": "string", "description": "Export writes rows into the sheet; import reads a range into this run's dataset.", "default": "export" }, "spreadsheetId": { "title": "Spreadsheet URL or id", "type": "string", "description": "The sheet's URL from the browser (https://docs.google.com/spreadsheets/d//edit) or just the id." }, "sheetName": { "title": "Tab name", "type": "string", "description": "The tab to write to or read from. Export default: Sheet1 (created if missing). Import default: the first tab." }, "serviceAccountJson": { "title": "Service-account key (JSON)", "type": "string", "description": "The JSON key of a Google Cloud service account; share the sheet with its client_email (Editor for export, Viewer for import). Needed for export; import also reads sheets shared as Anyone with the link without it." }, "datasetId": { "title": "Dataset id (export)", "type": "string", "description": "The Apify dataset to export, e.g. the defaultDatasetId of another Actor's run." }, "rows": { "title": "Rows (export)", "type": "array", "description": "Instead of a dataset: a JSON array of objects. Keys become columns." }, "writeMode": { "title": "Write mode (export)", "enum": [ "append", "replace", "upsert" ], "type": "string", "description": "New columns are always added to the right of the header row.", "default": "append" }, "keyColumn": { "title": "Key column (upsert)", "type": "string", "description": "Column whose value identifies a row, e.g. id or url. Required for upsert." }, "createSheet": { "title": "Create the tab if missing (export)", "type": "boolean", "description": "Otherwise a missing tab stops the run with the list of tabs.", "default": true }, "range": { "title": "Range (import)", "type": "string", "description": "A1 range such as A1:F500 or 'My tab'!A:D. Empty: the whole tab." }, "headerRow": { "title": "First row is a header (import)", "type": "boolean", "description": "Use the first row as field names; otherwise fields are column letters (A, B, ...).", "default": true }, "chunkSize": { "title": "Rows per write call", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Large exports are written in chunks of this many rows.", "default": 1000 }, "maxRows": { "title": "Maximum rows", "minimum": 0, "type": "integer", "description": "Maximum number of rows to read from the sheet in import mode; 0 reads every row.", "default": 0 }, "dryRun": { "title": "Dry run (export)", "type": "boolean", "description": "Plan the export and show a preview in OUTPUT without writing or charging rows.", "default": false }, "maxRetries": { "title": "Maximum retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "Retries per call on Google quota (429) and server errors, with exponential backoff.", "default": 5 } } }, "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 } } } } } } } } } }