{ "openapi": "3.0.1", "info": { "title": "Google Sheets Export & Import — Reliable, Append & Dedupe", "description": "Send any Apify dataset to Google Sheets (replace, append or append without duplicates) or import a sheet into a dataset. Service-account auth that doesn't expire, automatic retries on Google quotas, nested JSON flattened into columns, big datasets in chunks.", "version": "1.0", "x-build-id": "tZsMdJcWKExmKliI0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tidydata~google-sheets-export-import/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tidydata-google-sheets-export-import", "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/tidydata~google-sheets-export-import/runs": { "post": { "operationId": "runs-sync-tidydata-google-sheets-export-import", "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/tidydata~google-sheets-export-import/run-sync": { "post": { "operationId": "run-sync-tidydata-google-sheets-export-import", "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": [ "mode" ], "properties": { "mode": { "title": "What to do", "enum": [ "export", "import" ], "type": "string", "description": "Export: send an Apify dataset to a Google Sheet. Import: read a Google Sheet into this run's dataset.", "default": "export" }, "spreadsheet": { "title": "Spreadsheet URL or ID", "type": "string", "description": "The Google Sheets link (https://docs.google.com/spreadsheets/d/…) or just its ID. Share the spreadsheet as Editor with the email shown in the README. The first Apify account that uses a spreadsheet becomes its owner for this Actor, so nobody else can read or write it through here." }, "sheetName": { "title": "Tab name", "type": "string", "description": "Tab (worksheet) to write to or read from. Created automatically on export if it doesn't exist.", "default": "Apify" }, "datasetId": { "title": "Dataset (export)", "type": "string", "description": "The Apify dataset to export. Pick it from your storages or paste its ID. When this Actor runs as an integration after another Actor, use {{resource.defaultDatasetId}}." }, "writeMode": { "title": "Write mode (export)", "enum": [ "replace", "append", "append_dedupe" ], "type": "string", "description": "Replace: clear the tab and write the dataset. Append: add rows under the existing ones (new columns are added at the end). Append without duplicates: like Append, but skips rows whose key columns already exist in the sheet.", "default": "replace" }, "dedupeKeys": { "title": "Key columns for duplicates", "type": "array", "description": "Columns that identify a row (e.g. url, or id). Only used with 'Append without duplicates'. Use dot names for nested fields, e.g. author.id.", "items": { "type": "string" } }, "columns": { "title": "Columns to keep (optional)", "type": "array", "description": "Only export these columns, in this order. Leave empty to export all columns.", "items": { "type": "string" } }, "flatten": { "title": "Flatten nested JSON", "type": "boolean", "description": "Turn nested objects into columns (address.city, address.zip). Lists of simple values are joined with ', '; lists of objects are kept as JSON text.", "default": true }, "maxRows": { "title": "Max rows", "minimum": 1, "maximum": 2000000, "type": "integer", "description": "Stop after this many rows (protects your budget). Google Sheets holds at most 10 million cells per spreadsheet.", "default": 100000 }, "serviceAccountJson": { "title": "Your own service account key (optional)", "type": "string", "description": "Optional, for advanced users. Leave empty to use ours: just share your spreadsheet with our email. If you prefer your own Google Cloud service account, paste its full JSON key here (stored encrypted) and share the spreadsheet with that account instead." } } }, "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 } } } } } } } } } }