{ "openapi": "3.0.1", "info": { "title": "Google Sheets Io", "description": "Import Apify datasets into Google Sheets, or read sheets back into a dataset - authenticated with a Google service account, so the connection never expires and scheduled pipelines never break. Append, replace or read. Flattens nested objects, stable headers, auto 429 backoff. Free.", "version": "0.1", "x-build-id": "atyKBxlpbvTIjDKeN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/devon_gtme~google-sheets-io/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-devon_gtme-google-sheets-io", "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/devon_gtme~google-sheets-io/runs": { "post": { "operationId": "runs-sync-devon_gtme-google-sheets-io", "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/devon_gtme~google-sheets-io/run-sync": { "post": { "operationId": "run-sync-devon_gtme-google-sheets-io", "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": [ "serviceAccountKey", "spreadsheetId" ], "properties": { "serviceAccountKey": { "title": "Service Account JSON Key", "type": "string", "description": "Paste the FULL contents of your Google service-account JSON key file (starts with {\"type\": \"service_account\", ...}). It is stored encrypted. One-time setup (~5 min, see README): create a Google Cloud project → enable the Google Sheets API → create a service account → download its JSON key → share your spreadsheet with the service account's email address (Editor)." }, "mode": { "title": "Mode", "enum": [ "append", "replace", "read" ], "type": "string", "description": "append = add rows below existing data (headers stay stable, new columns are added on the right). replace = clear the sheet and write fresh (header row + data). read = read the sheet into the run's dataset (first row is treated as headers).", "default": "append" }, "spreadsheetId": { "title": "Spreadsheet ID or URL", "type": "string", "description": "The target spreadsheet — either the bare ID (e.g. 1AbC...xyz) or the full URL copied from your browser (https://docs.google.com/spreadsheets/d/1AbC...xyz/edit). Remember to share this spreadsheet with your service account's email address." }, "sheetName": { "title": "Sheet (Tab) Name", "type": "string", "description": "The tab to write to / read from. Defaults to the first tab. In write modes, the tab is created automatically if it doesn't exist." }, "datasetId": { "title": "Apify Dataset ID", "type": "string", "description": "Dataset whose items to write to the sheet (append/replace modes). Leave empty when this actor runs as an integration on another actor — the triggering run's dataset is detected automatically. Ignored in read mode." }, "rawData": { "title": "Raw JSON Data", "type": "array", "description": "Alternative to a dataset: a JSON array of objects to write, e.g. [{\"name\": \"Acme\", \"contact\": {\"email\": \"a@b.com\"}}]. Nested objects become dot-notation columns (contact.email)." }, "range": { "title": "Range (read mode)", "type": "string", "description": "Optional A1 range to read, e.g. A1:D50. Defaults to the whole sheet. Read mode only." }, "payload": { "title": "Integration payload (automatic)", "type": "object", "description": "Filled automatically when this actor is triggered as an integration/webhook from another actor's run — used to auto-detect the dataset. Leave empty otherwise." } } }, "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 } } } } } } } } } }