{ "openapi": "3.0.1", "info": { "title": "Dataset to Google Sheets - Reliable Writer (Validate, Upsert)", "description": "Write Apify datasets or JSON rows to Google Sheets with fewer failed runs: preflight validation catches bad input before any charge, batching respects Google quotas, append/replace/upsert modes, readable errors, free dry run.", "version": "0.1", "x-build-id": "op48hmAb3Qdzht55x" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/amazing_wizdom~sheets-sync-guardrails/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-amazing_wizdom-sheets-sync-guardrails", "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/amazing_wizdom~sheets-sync-guardrails/runs": { "post": { "operationId": "runs-sync-amazing_wizdom-sheets-sync-guardrails", "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/amazing_wizdom~sheets-sync-guardrails/run-sync": { "post": { "operationId": "run-sync-amazing_wizdom-sheets-sync-guardrails", "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": { "spreadsheet": { "title": "Spreadsheet URL or ID", "type": "string", "description": "Full Google Sheets URL (https://docs.google.com/spreadsheets/d/...) or the bare spreadsheet ID." }, "sheetName": { "title": "Sheet (tab) name", "type": "string", "description": "Tab to write into. Defaults to the first sheet. Created automatically if missing (see option below)." }, "mode": { "title": "Sync mode", "enum": [ "append", "replace", "upsert" ], "type": "string", "description": "append = add rows after existing data; replace = clear the sheet and write headers + rows; upsert = update rows matching key columns, append the rest.", "default": "append" }, "keyColumns": { "title": "Key columns (for upsert)", "type": "array", "description": "Column names that uniquely identify a row. Required when mode = upsert.", "items": { "type": "string" } }, "datasetId": { "title": "Source dataset ID", "type": "string", "description": "Apify dataset to read rows from. If omitted, the actor reads inline `rows` below, or the run's default dataset." }, "rows": { "title": "Inline rows (JSON)", "type": "array", "description": "Array of JSON objects to write, e.g. [{\"name\":\"Alice\",\"score\":42}]. Alternative to datasetId." }, "createSheetIfMissing": { "title": "Create sheet tab if missing", "type": "boolean", "description": "If the named sheet tab does not exist, create it automatically. When false, a missing tab is a hard error.", "default": true }, "valueInputOption": { "title": "Value interpretation", "enum": [ "RAW", "USER_ENTERED" ], "type": "string", "description": "RAW stores values as-is; USER_ENTERED parses them like typed input (dates, formulas).", "default": "RAW" }, "dryRun": { "title": "Dry run (validate only, free)", "type": "boolean", "description": "Run the full preflight validation and produce the write plan without touching the spreadsheet and without charges. Prefilled ON so your first run succeeds for free — turn it OFF (and add your service account key) to actually write.", "default": false }, "googleServiceAccountKey": { "title": "Google service account key (JSON)", "type": "object", "description": "Service account credentials JSON. Share the target spreadsheet with the service account email (Editor role). Not required for dry runs." } } }, "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 } } } } } } } } } }