{"openapi":"3.0.0","info":{"description":"Google Sheets","version":[{"name":"-","value":"-"},{"name":"v4","value":"v4"}]},"servers":[{"description":"Google Sheets","url":"https://api.apirails.com/googlesheets"}],"paths":{"/v4/spreadsheets":{"post":{"tags":["Spreadsheet"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/create,\nhttps://developers.google.com/sheets/api/reference/rest/v4/spreadsheets#Spreadsheet","api_endpoint":"https://sheets.googleapis.com/v4/spreadsheets"},"summary":"Create new Googlesheet","description":"Create new Googlesheet, this will create default sheet name Sheet 1","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"properties":{"type":"object","description":"Properties","required":true,"properties":{"title":{"type":"string","description":"Title of the spreadsheet"},"locale":{"type":"string","description":"Locale of the spreadsheet (e.g. en_US)"},"autoRecalc":{"type":"string","description":"Amount of time to wait before volatile functions are recalculated","enum":["ON_CHANGE","MINUTE","FIVE_MINUTES","FIFTEEN_MINUTES","HOUR"]},"timeZone":{"type":"string","description":"Time zone in CLDR format (e.g. America/New_York)"},"defaultFormat":{"type":"object","description":"Default format of all cells in the spreadsheet"},"iterativeCalculationSettings":{"type":"object","description":"Settings for iterative calculation"},"spreadsheetTheme":{"type":"object","description":"Theme applied to the spreadsheet"},"importFunctionsExternalUrlAccessAllowed":{"type":"boolean","description":"Whether to allow external URL access in import functions"}}},"sheets":{"type":"array","description":"Sheets","items":{"type":"object","properties":{"properties":{"type":"object","description":"Sheet properties (title, sheetId, index, etc.)"},"data":{"type":"array","description":"Data in the grid (array of RowData objects)"},"merges":{"type":"array","description":"Ranges that are merged"},"conditionalFormats":{"type":"array","description":"Conditional format rules"},"filterViews":{"type":"array","description":"Filter views in the sheet"},"protectedRanges":{"type":"array","description":"Protected ranges in the sheet"},"basicFilter":{"type":"object","description":"Basic filter on the sheet"},"charts":{"type":"array","description":"Charts in the sheet"},"bandedRanges":{"type":"array","description":"Banded (alternating colors) ranges"},"rowGroups":{"type":"array","description":"Row dimension groups"},"columnGroups":{"type":"array","description":"Column dimension groups"},"slicers":{"type":"array","description":"Slicers in the sheet"},"sortSpecs":{"type":"array","description":"Sort specifications"}}}}}},"example":{"properties":{"locale":"en_US","timeZone":"America/New_York","title":"Sheet via API Rails"},"sheets":[{"properties":{"index":0,"sheetId":0,"title":"Sheet 1"}},{"properties":{"index":1,"sheetId":1,"title":"Sheet 2"}}]}}}}}},"/v4/spreadsheets/{spreadsheetId}/batchUpdate":{"post":{"tags":["Spreadsheet Batch Update"],"parameters":[{"name":"spreadsheetId","in":"path","description":"Spreadsheet Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/batchUpdate","api_endpoint":"https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:batchUpdate"},"summary":"Batch update Googlesheet","description":"Batch update","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"requests":{"type":"array","description":"Batch update payload","required":true,"items":{"type":"object","properties":{}}}}},"example":{"requests":[{"updateSpreadsheetProperties":{}},{"updateSheetProperties":{}},{"addSheet":{}},{"deleteSheet":{}},{"updateCells":{}},{"appendCells":{}},{"duplicateSheet":{}},{"deleteRange":{}},{"deleteDuplicates":{}}]}}}}}},"/v4/spreadsheets/{spreadsheetId}/values/batchGet":{"get":{"tags":["Sheet Range (Batch)"],"parameters":[{"name":"spreadsheetId","in":"path","description":"Spreadsheet Id","required":true,"schema":{"type":"string","example":""}},{"name":"dateTimeRenderOption","in":"query","description":"Date Time Render Option","schema":{"type":"string","example":""}},{"name":"majorDimension","in":"query","description":"Major Dimension","schema":{"type":"string","example":""}},{"name":"range","in":"query","description":"Range","required":true,"schema":{"type":"string","example":""}},{"name":"valueRenderOption","in":"query","description":"Value Render Option","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/batchGet","api_endpoint":"https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchGet"},"summary":"Retruns data from one or more sheets","description":"Retruns data from one or more sheets","security":[{"bearerAuth":[]}]}},"/v4/spreadsheets/{spreadsheetId}/values/{range}":{"get":{"tags":["Sheet Range"],"parameters":[{"name":"range","in":"path","description":"Range","required":true,"schema":{"type":"string","example":""}},{"name":"spreadsheetId","in":"path","description":"Spreadsheet Id","required":true,"schema":{"type":"string","example":""}},{"name":"dateTimeRenderOption","in":"query","description":"Date Time Render Option","schema":{"type":"string","example":""}},{"name":"majorDimension","in":"query","description":"Major Dimension","schema":{"type":"string","example":""}},{"name":"valueRenderOption","in":"query","description":"Value Render Option","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/get","api_endpoint":"https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values/{range}"},"summary":"Retruns the data of specified range","description":"Retruns the data of specified range.","security":[{"bearerAuth":[]}]},"put":{"tags":["Sheet Range"],"parameters":[{"name":"range","in":"path","description":"Range","required":true,"schema":{"type":"string","example":""}},{"name":"spreadsheetId","in":"path","description":"Spreadsheet Id","required":true,"schema":{"type":"string","example":""}},{"name":"includeValuesInResponse","in":"query","schema":{"type":"string","example":""}},{"name":"responseDateTimeRenderOption","in":"query","schema":{"type":"string","example":""}},{"name":"responseValueRenderOption","in":"query","schema":{"type":"string","example":""}},{"name":"valueInputOption","in":"query","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/update","api_endpoint":"https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values/{range}"},"summary":"Updates the data of specified range","description":"Updates the data of specified range","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/spreadsheets/{spreadsheetId}/getByDataFilter":{"post":{"tags":["Spreadsheet"],"parameters":[{"name":"spreadsheetId","in":"path","description":"Googlesheets Spreadsheet ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/getByDataFilter","api_endpoint":"https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:getByDataFilter"},"summary":"Get Googlesheet sheet data using the given filter","description":"Use a1Range or gridRange to filter and fetch the data\n\na1Range must be a range and a string\n\ngridRange is an object with sheetId which is number\nwith additional values\n\n\"sheetId\": 0,\n\"startRowIndex\": 0,\n\"endRowIndex\": 0,\n\"startColumnIndex\": 0,\n\"endColumnIndex\": 0","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"dataFilters":{"type":"array","description":"The DataFilters used to select which ranges to retrieve from the spreadsheet.","items":{"type":"object","properties":{}}},"includeGridData":{"type":"boolean","description":"True if grid data should be returned. This parameter is ignored if a field mask was set in the request."}}},"example":{"dataFilters":[],"includeGridData":""}}}}}},"/v4/spreadsheets/{spreadsheetId}":{"get":{"tags":["Spreadsheet"],"parameters":[{"name":"spreadsheetId","in":"path","description":"Spreadsheet Id","required":true,"schema":{"type":"string","example":""}},{"name":"includeGridData","in":"query","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"ranges","in":"query","description":"Ranges","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/get","api_endpoint":"https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}"},"summary":"Fetch data from Googlesheet","description":"This spreadsheet fetches the list of sheets if no ranges is mentioned, If the ranges are populated it will return those filtered range, set includeGridData to true if you want the data associated with sheet to also be returned.\n\n4 Ways this API can be used,\n\n1. Get all the sheets (ranges), just pass the spreadsheet id\n\n2. Get all the sheets (ranges) along with their data, pass the spreadsheet id and includeGridData as true (Don't use this if sheet has huge data)\n\n3. Get only sheet or sheets specified in the ranges, pass spreadsheet id and ranges, pass ranges as comma seperated\n\n4. Get only sheet or sheets specified in the ranges along with thier data, pass spreadsheet id, includeGridData as true and ranges, pass ranges as comma seperated.","security":[{"bearerAuth":[]}]}},"/v4/spreadsheets/{spreadsheetId}/values/{range}/clear":{"post":{"tags":["Sheet Range"],"parameters":[{"name":"range","in":"path","description":"Range","required":true,"schema":{"type":"string","example":""}},{"name":"spreadsheetId","in":"path","description":"Spreadsheet Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/clear","api_endpoint":"https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values/{range}:clear"},"summary":"Clears the sheet data","description":"Clears the sheet data","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/spreadsheets/{spreadsheetId}/values/batch/clear/range":{"post":{"tags":["Sheet Range (Batch)"],"parameters":[{"name":"spreadsheetId","in":"path","description":"Spreadsheet Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/batchClear","api_endpoint":"https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchClear"},"summary":"Clears the sheet data of one or more ranges","description":"Clears the sheet data of one or more ranges","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ranges":{"type":"array","description":"The ranges to clear (A1 notation strings)","items":{"type":"string"}}}},"example":{"ranges":["Sheet1!A1:B2","Sheet2!C1:D10"]}}}}}},"/v4/spreadsheets/{spreadsheetId}/values/batchClearByDataFilter":{"post":{"tags":["Sheet Range (Batch)"],"parameters":[{"name":"spreadsheetId","in":"path","description":"Spreadsheet Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/batchClearByDataFilter","api_endpoint":"https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter"},"summary":"Clears the ranges matching one or more data filter","description":"Clears the ranges matching one or more data filter","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"dataFilters":{"type":"array","items":{"type":"object","properties":{}}}}},"example":{"dataFilters":[{"criteria":{"condition":{"type":"TEXT_CONTAINS","values":["apple","banana"]}},"range":{"endColumnIndex":5,"endRowIndex":10,"sheetId":123456789,"startColumnIndex":0,"startRowIndex":0}}]}}}}}},"/v4/spreadsheets/{spreadsheetId}/values/{range}/append":{"post":{"tags":["Sheet Range"],"parameters":[{"name":"range","in":"path","description":"Range","required":true,"schema":{"type":"string","example":""}},{"name":"spreadsheetId","in":"path","description":"Spreadsheet Id","required":true,"schema":{"type":"string","example":""}},{"name":"includeValuesInResponse","in":"query","schema":{"type":"string","example":""}},{"name":"insertDataOption","in":"query","schema":{"type":"string","example":""}},{"name":"responseDateTimeRenderOption","in":"query","schema":{"type":"string","example":""}},{"name":"responseValueRenderOption","in":"query","schema":{"type":"string","example":""}},{"name":"valueInputOption","in":"query","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/append","api_endpoint":"https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values/{range}:append"},"summary":"Appends value at the end","description":"Appends value at the end","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}/copyTo":{"post":{"tags":["Other"],"parameters":[{"name":"sheetId","in":"path","description":"Sheet Id","required":true,"schema":{"type":"string","example":""}},{"name":"spreadsheetId","in":"path","description":"Spreadsheet Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.sheets/copyTo","api_endpoint":"https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo"},"summary":"Copies a range from one sheet to another sheet","description":"Copies a range from one sheet to another sheet","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"destinationSpreadsheetId":{"type":"string","description":"Destination Spreadsheet Id","required":true}}},"example":{"destinationSpreadsheetId":""}}}}}},"/v4/spreadsheets/{spreadsheetId}/values/batchGetByDataFilter":{"post":{"tags":["Sheet Range (Batch)"],"parameters":[{"name":"spreadsheetId","in":"path","description":"Spreadsheet Id","required":true,"schema":{"type":"string","example":""}},{"name":"dateTimeRenderOption","in":"query","description":"Date Time Render Option","schema":{"type":"string","example":""}},{"name":"majorDimension","in":"query","description":"Major Dimension","schema":{"type":"string","example":""}},{"name":"range","in":"query","description":"Range","required":true,"schema":{"type":"string","example":""}},{"name":"valueRenderOption","in":"query","description":"Value Render Option","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/batchGetByDataFilter","api_endpoint":"https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter"},"summary":"Retruns data from one or more sheets based on matched condition","description":"Retruns data from one or more sheets based on matched condition","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/spreadsheets/{spreadsheetId}/values/batchUpdate":{"post":{"tags":["Sheet Range (Batch)"],"parameters":[{"name":"spreadsheetId","in":"path","description":"Spreadsheet Id","required":true,"schema":{"type":"string","example":""}},{"name":"includeValuesInResponse","in":"query","schema":{"type":"string","example":""}},{"name":"insertDataOption","in":"query","schema":{"type":"string","example":""}},{"name":"range","in":"query","description":"Range","required":true,"schema":{"type":"string","example":""}},{"name":"responseDateTimeRenderOption","in":"query","schema":{"type":"string","example":""}},{"name":"responseValueRenderOption","in":"query","schema":{"type":"string","example":""}},{"name":"valueInputOption","in":"query","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/batchUpdate","api_endpoint":"https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchUpdate"},"summary":"Updates one more more ranges in the spreadsheet","description":"Updates one more more ranges in the spreadsheet","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}":{"get":{"tags":["Other"],"parameters":[{"name":"metadataId","in":"path","description":"Metadata Id","required":true,"schema":{"type":"string","example":""}},{"name":"spreadsheetId","in":"path","description":"Spreadsheet Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.developerMetadata/get","api_endpoint":"https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}"},"summary":"Fetch developer metadata","description":"Fetch developer metadata","security":[{"bearerAuth":[]}]}},"/v4/spreadsheets/{spreadsheetId}/developerMetadata/search":{"post":{"tags":["Other"],"parameters":[{"name":"spreadsheetId","in":"path","description":"Spreadsheet Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.developerMetadata/search","api_endpoint":"https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/developerMetadata:search"},"summary":"Search developer metadata","description":"Search developer metadata","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"dataFilters":{"type":"array","description":"The data filters describing the criteria used to determine which DeveloperMetadata entries to return.","items":{"type":"object","properties":{}}}}},"example":{"dataFilters":[]}}}}}},"/v4/spreadsheets/{spreadsheetId}/values/batchUpdateByDataFilter":{"post":{"tags":["Sheet Range (Batch)"],"parameters":[{"name":"spreadsheetId","in":"path","description":"Spreadsheet Id","required":true,"schema":{"type":"string","example":""}},{"name":"includeValuesInResponse","in":"query","schema":{"type":"string","example":""}},{"name":"insertDataOption","in":"query","schema":{"type":"string","example":""}},{"name":"range","in":"query","description":"Range","required":true,"schema":{"type":"string","example":""}},{"name":"responseDateTimeRenderOption","in":"query","schema":{"type":"string","example":""}},{"name":"responseValueRenderOption","in":"query","schema":{"type":"string","example":""}},{"name":"valueInputOption","in":"query","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/batchUpdateByDataFilter","api_endpoint":"https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter"},"summary":"Updates one more more ranges in the spreadsheet based on condition","description":"Updates one more more ranges in the spreadsheet based on condition","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}