1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2024-12-16 11:38:11 +02:00
OpenIntegrations/docs/en/md/Google_Sheets/Data-managment/Clear-cells.md
2024-07-10 11:59:55 +03:00

60 lines
1.3 KiB
Markdown

---
sidebar_position: 2
---
# Clear cells
Clears the value in cells
<br/>
*Function ClearCells(Val Token, Val Spreadsheet, Val CellsArray, Val Sheet = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Spreadsheet | --spreadsheet | String | SpreadsheetID |
| CellsArray | --cells | Array of String | Array of cells like A1 to be cleared |
| Sheet | --sheetname | String | Sheet name (first sheet by default) |
Returns: Map Of KeyAndValue - serialized JSON response from Google
```bsl title="Code example"
CellsArray = New Array;
CellsArray.Add("B2");
CellsArray.Add("A3");
CellsArray.Add("B4");
Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Sheet = "Sheet2";
Response = OPI_GoogleSheets.ClearCells(Token, Spreadsheet, CellsArray, Sheet); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint gsheets ClearCells --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --cells %cells% --sheetname "Sheet2"
```
```json title="Result"
{
"spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc",
"clearedRanges": [
"'Sheet2'!B2",
"'Sheet2'!A3",
"'Sheet2'!B4"
]
}
```