{ "openapi": "3.0.1", "info": { "title": "Apify to Google Sheets API – Export to Google Sheets, No OAuth", "description": "Send any Apify dataset to Google Sheets in one step: append, replace or upsert by key column. No Google Cloud project, no OAuth pop-up and no tokens that expire — just share the sheet with one bot email. Rows that did not change are never charged.", "version": "0.1", "x-build-id": "sD3ENgy9MLgMePcbd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tidyrun~google-sheets-export/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tidyrun-google-sheets-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/tidyrun~google-sheets-export/runs": { "post": { "operationId": "runs-sync-tidyrun-google-sheets-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/tidyrun~google-sheets-export/run-sync": { "post": { "operationId": "run-sync-tidyrun-google-sheets-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", "properties": { "spreadsheetId": { "title": "Google Sheet URL", "type": "string", "description": "Step 1: in your sheet click Share and add sheets-sync-bot@sheets-sync-prod-511105.iam.gserviceaccount.com as Editor. Step 2: paste the sheet URL here (or just its ID)." }, "datasetId": { "title": "Dataset to export", "type": "string", "description": "Apify dataset to export, e.g. the default dataset of your scraper's run. When connected as an integration, use {{resource.defaultDatasetId}}. Use this or Rows." }, "mode": { "title": "Mode", "enum": [ "append", "replace", "upsert" ], "type": "string", "description": "Append: add rows at the bottom. Replace: clear the tab and write fresh (a backup is kept until it succeeds). Upsert: update rows whose key columns match and add the rest.", "default": "append" }, "keyColumns": { "title": "Key columns (for upsert)", "type": "array", "description": "Column names that identify a row, e.g. [\"url\"] or [\"sku\", \"store\"]. Required for upsert.", "items": { "type": "string" } }, "sheetName": { "title": "Sheet (tab) name", "type": "string", "description": "Created automatically if it does not exist.", "default": "Sheet1" }, "dryRun": { "title": "Dry run (writes nothing)", "type": "boolean", "description": "Check access, tab, columns and how many rows would be appended, updated or skipped. Writes nothing and charges nothing.", "default": false }, "rows": { "title": "Rows", "type": "array", "description": "JSON array of objects to write. Use this or Dataset ID." }, "columns": { "title": "Columns to write", "type": "array", "description": "Optional. Only these columns, in this order. Leave empty to write every field.", "items": { "type": "string" } }, "maxRows": { "title": "Max rows", "minimum": 1, "type": "integer", "description": "Optional cap on rows written in this run." }, "normalizeKeys": { "title": "Match keys ignoring case and spaces", "type": "boolean", "description": "Upsert treats \" ABC-1 \" and \"abc-1\" as the same key. The sheet keeps its original text.", "default": true }, "flattenNested": { "title": "Flatten nested objects", "type": "boolean", "description": "Turn {\"price\": {\"amount\": 5}} into a \"price.amount\" column.", "default": true }, "parseValues": { "title": "Parse values like a user typing", "type": "boolean", "description": "Off (recommended): values are stored as-is, so text starting with = is never run as a formula. On: Sheets parses dates, numbers and formulas.", "default": false }, "keepBackup": { "title": "Keep backup tab after replace", "type": "boolean", "description": "Replace always copies the tab first, so nothing is lost if a run fails. Turn on to keep the copy after a successful run too.", "default": false }, "serviceAccountKey": { "title": "Your own service account key (optional)", "type": "string", "description": "Leave empty to use our shared bot: just share your spreadsheet with the bot email shown in the README. Or paste your own Google service-account JSON key for a dedicated quota. Stored encrypted." } } }, "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 } } } } } } } } } }