{ "openapi": "3.0.1", "info": { "title": "Google Sheets Import & Export", "description": "Read a Google Sheet into a dataset (public sheets need no key) and write datasets or JSON back - append, replace, or upsert - using a service account, with no interactive OAuth and automatic rate-limit retries.", "version": "0.1", "x-build-id": "jP6UTweHGwtE0VtPc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cypherstone~google-sheets-import-export/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cypherstone-google-sheets-import-export", "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/cypherstone~google-sheets-import-export/runs": { "post": { "operationId": "runs-sync-cypherstone-google-sheets-import-export", "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/cypherstone~google-sheets-import-export/run-sync": { "post": { "operationId": "run-sync-cypherstone-google-sheets-import-export", "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": [ "spreadsheet" ], "properties": { "mode": { "title": "Mode", "enum": [ "read", "append", "replace", "upsert" ], "type": "string", "description": "read = sheet → dataset. append/replace/upsert = data → sheet (need a service-account key).", "default": "read" }, "spreadsheet": { "title": "Spreadsheet URL or ID", "type": "string", "description": "The Google Sheets link (or just its ID). To read without a key, the sheet must be shared 'Anyone with the link → Viewer'." }, "headerRow": { "title": "First row is a header (read)", "type": "boolean", "description": "Use the first row as column names when reading. Turn off to get col1, col2, …", "default": true }, "range": { "title": "Range (read, private sheets)", "type": "string", "description": "Optional A1 range, e.g. 'Sheet1!A1:D100'. Only used when reading a private sheet with a key." }, "tab": { "title": "Tab name (write)", "type": "string", "description": "The tab to write to, e.g. Sheet1.", "default": "Sheet1" }, "data": { "title": "Inline data (write)", "type": "array", "description": "Rows to write, as an array of JSON objects. Leave empty to use a dataset instead." }, "datasetId": { "title": "Source dataset ID (write)", "type": "string", "description": "Write the rows from this Apify dataset. Leave empty to use inline data or the run's default dataset." }, "useDefaultDataset": { "title": "Use this run's default dataset (write)", "type": "boolean", "description": "When chained after a scraper, write that run's default dataset.", "default": false }, "keyColumn": { "title": "Key column (upsert)", "type": "string", "description": "Column name used to skip rows already present in the sheet." }, "includeHeader": { "title": "Write a header row (replace)", "type": "boolean", "description": "Write column names as the first row when replacing a sheet.", "default": true }, "flattenDelimiter": { "title": "Nested-key delimiter (write)", "type": "string", "description": "Nested JSON is flattened to columns like address/city using this separator.", "default": "/" }, "serviceAccount": { "title": "Service-account key JSON (write / private read)", "type": "object", "description": "Paste a Google service-account key (the whole JSON). Share the sheet with its client_email as Editor. Not needed to read a link-shared sheet." } } }, "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 } } } } } } } } } }