{ "openapi": "3.0.1", "info": { "title": "Google Sheets Sync - Reliable Export, Append & Upsert", "description": "Send Apify datasets, JSON or CSV to Google Sheets without failed runs: true append (no full-sheet rewrite), upsert by key, auto-flatten nested data, quota-aware retries. Also reads sheets into a dataset.", "version": "1.0", "x-build-id": "LjUe7Z2YdipHXosIZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/donrulezz~google-sheets-sync/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-donrulezz-google-sheets-sync", "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/donrulezz~google-sheets-sync/runs": { "post": { "operationId": "runs-sync-donrulezz-google-sheets-sync", "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/donrulezz~google-sheets-sync/run-sync": { "post": { "operationId": "run-sync-donrulezz-google-sheets-sync", "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": { "spreadsheet": { "title": "Spreadsheet URL or ID", "pattern": "^(https://docs\\.google\\.com/spreadsheets/d/[A-Za-z0-9_-]{20,}.*|[A-Za-z0-9_-]{20,})$", "type": "string", "description": "Paste the Google Sheets URL (or just its ID). Share the spreadsheet with your service account email as Editor. Without a spreadsheet and key the run is a free preview: it shows the rows it would write and writes nothing." }, "sheetName": { "title": "Sheet (tab) name", "type": "string", "description": "Tab to write to or read from. Created automatically if it doesn't exist.", "default": "Sheet1" }, "mode": { "title": "Mode", "enum": [ "append", "replace", "upsert", "read" ], "type": "string", "description": "append: add rows below existing data (existing rows and columns never move). replace: clear the tab and write fresh. upsert: update rows whose key matches, append the rest. read: load the tab into this run's dataset.", "default": "append" }, "serviceAccountJson": { "title": "Google service account key (JSON)", "type": "string", "description": "Paste the full JSON key of a Google Cloud service account with the Sheets API enabled. Stored encrypted. 5-minute setup in the README." }, "datasetId": { "title": "Apify dataset ID", "type": "string", "description": "Rows to send. In an integration after another Actor, use {{resource.defaultDatasetId}}." }, "jsonData": { "title": "JSON data", "type": "array", "description": "Alternatively, paste an array of objects." }, "dataUrl": { "title": "JSON or CSV URL", "pattern": "^https?://.+", "type": "string", "description": "Alternatively, a public URL returning a JSON array or a CSV file." }, "matchColumn": { "title": "Match column (upsert)", "type": "string", "description": "Column that identifies a row, e.g. 'url' or 'id'. Rows with a value already in the sheet are updated in place." }, "columns": { "title": "Column order", "type": "array", "description": "Optional: columns to place first, in this order. Other fields follow unless 'Only these columns' is on.", "items": { "type": "string" } }, "onlySelectedColumns": { "title": "Only these columns", "type": "boolean", "description": "Write only the columns listed above and drop other fields.", "default": false }, "flattenMode": { "title": "Nested data", "enum": [ "dot", "json" ], "type": "string", "description": "How nested objects and arrays become cells.", "default": "dot" }, "parseValues": { "title": "Parse values like Google Sheets does", "type": "boolean", "description": "On: numbers, dates and formulas are interpreted (USER_ENTERED). Off: everything is stored exactly as text/values (RAW).", "default": true } } }, "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 } } } } } } } } } }