1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-11-23 22:05:15 +02:00

Создание MD файлов документации

This commit is contained in:
Vitaly the Alpaca
2024-06-07 21:40:04 +00:00
committed by Vitaly the Alpaca (bot)
parent 260c0d6689
commit dd0f222cd1
28 changed files with 1022 additions and 92 deletions

View File

@@ -2,17 +2,17 @@
sidebar_position: 1
---
# CreateBook
Creates a new book
# Create spreadsheet
Creates a new spreadsheet
*Function CreateBook(Val Token, Val Name, Val ArrayOfSheetNames) Export*
*Function CreateSpreadsheet(Val Token, Val Name, Val ArrayOfSheetNames) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Name | --title | String | Name |
| ArrayOfSheetNames | --sheets | Array of String | Array of names to add new sheets to the book |
| ArrayOfSheetNames | --sheets | Array of String | Array of names to add new sheets to the spreadsheet |
Returns: Map Of KeyAndValue - serialized JSON response from Google
@@ -26,7 +26,7 @@ sidebar_position: 1
Name = "TestTable";
Response = OPI_GoogleSheets.CreateBook(Token, Name, ArrayOfSheetNames); //Map
Response = OPI_GoogleSheets.CreateSpreadsheet(Token, Name, ArrayOfSheetNames); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
@@ -35,7 +35,7 @@ sidebar_position: 1
```sh title="CLI command example"
oint gsheets CreateBook --token %token% --title "TestTable" --sheets %sheets%
oint gsheets CreateSpreadsheet --token %token% --title "TestTable" --sheets %sheets%
```

View File

@@ -2,16 +2,16 @@
sidebar_position: 3
---
# ChangeBookName
Changes the name of the existing book
# Change spreadsheet name
Changes the name of the existing spreadsheet
*Function EditBookTitle(Val Token, Val Book, Val Name) Export*
*Function EditSpreadsheetTitle(Val Token, Val Spreadsheet, Val Name) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Book | --spreadsheet | String | BookID |
| Spreadsheet | --spreadsheet | String | SpreadsheetID |
| Name | --title | String | New name |
@@ -20,10 +20,10 @@ sidebar_position: 3
```bsl title="Code example"
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Name = "Test table (change.)";
Response = OPI_GoogleSheets.EditBookTitle(Token, Book, Name); //Map
Response = OPI_GoogleSheets.EditSpreadsheetTitle(Token, Spreadsheet, Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
@@ -32,7 +32,7 @@ sidebar_position: 3
```sh title="CLI command example"
oint gsheets EditBookTitle --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "Test table (change.)"
oint gsheets EditSpreadsheetTitle --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "Test table (change.)"
```

View File

@@ -2,16 +2,16 @@
sidebar_position: 2
---
# GetBook
Gets information about the book by ID
# Get spreadsheet
Gets information about the spreadsheet by ID
*Function GetBook(Val Token, Val Identifier) Export*
*Function GetSpreadsheet(Val Token, Val Identifier) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Identifier | --spreadsheet | String | BookIdentifier |
| Identifier | --spreadsheet | String | Spreadsheet identifier |
Returns: Map Of KeyAndValue - serialized JSON response from Google
@@ -21,7 +21,7 @@ sidebar_position: 2
Identifier = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Response = OPI_GoogleSheets.GetBook(Token, Identifier); //Map
Response = OPI_GoogleSheets.GetSpreadsheet(Token, Identifier); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
@@ -30,7 +30,7 @@ sidebar_position: 2
```sh title="CLI command example"
oint gsheets GetBook --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"
oint gsheets GetSpreadsheet --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"
```

View File

@@ -1,4 +1,4 @@
{
"label": "Books managment",
"label": "Spreadsheets managment",
"position": "2"
}

View File

@@ -2,17 +2,17 @@
sidebar_position: 1
---
# CreateBook
Creates a new book
# Create spreadsheet
Creates a new spreadsheet
*Function CreateBook(Val Token, Val Name, Val ArrayOfSheetNames) Export*
*Function CreateSpreadsheet(Val Token, Val Name, Val ArrayOfSheetNames) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Name | --title | String | Name |
| ArrayOfSheetNames | --sheets | Array of String | Array of names to add new sheets to the book |
| ArrayOfSheetNames | --sheets | Array of String | Array of names to add new sheets to the spreadsheet |
Returns: Map Of KeyAndValue - serialized JSON response from Google
@@ -26,7 +26,7 @@ sidebar_position: 1
Name = "TestTable";
Response = OPI_GoogleSheets.CreateBook(Token, Name, ArrayOfSheetNames); //Map
Response = OPI_GoogleSheets.CreateSpreadsheet(Token, Name, ArrayOfSheetNames); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
@@ -35,7 +35,7 @@ sidebar_position: 1
```sh title="CLI command example"
oint gsheets CreateBook --token %token% --title "TestTable" --sheets %sheets%
oint gsheets CreateSpreadsheet --token %token% --title "TestTable" --sheets %sheets%
```

View File

@@ -2,16 +2,16 @@
sidebar_position: 3
---
# ChangeBookName
Changes the name of the existing book
# Change spreadsheet name
Changes the name of the existing spreadsheet
*Function EditBookTitle(Val Token, Val Book, Val Name) Export*
*Function EditSpreadsheetTitle(Val Token, Val Spreadsheet, Val Name) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Book | --spreadsheet | String | BookID |
| Spreadsheet | --spreadsheet | String | SpreadsheetID |
| Name | --title | String | New name |
@@ -20,10 +20,10 @@ sidebar_position: 3
```bsl title="Code example"
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Name = "Test table (change.)";
Response = OPI_GoogleSheets.EditBookTitle(Token, Book, Name); //Map
Response = OPI_GoogleSheets.EditSpreadsheetTitle(Token, Spreadsheet, Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
@@ -32,7 +32,7 @@ sidebar_position: 3
```sh title="CLI command example"
oint gsheets EditBookTitle --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "Test table (change.)"
oint gsheets EditSpreadsheetTitle --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "Test table (change.)"
```

View File

@@ -2,16 +2,16 @@
sidebar_position: 2
---
# GetBook
Gets information about the book by ID
# Get spreadsheet
Gets information about the spreadsheet by ID
*Function GetBook(Val Token, Val Identifier) Export*
*Function GetSpreadsheet(Val Token, Val Identifier) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Identifier | --spreadsheet | String | BookIdentifier |
| Identifier | --spreadsheet | String | Spreadsheet identifier |
Returns: Map Of KeyAndValue - serialized JSON response from Google
@@ -21,7 +21,7 @@ sidebar_position: 2
Identifier = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Response = OPI_GoogleSheets.GetBook(Token, Identifier); //Map
Response = OPI_GoogleSheets.GetSpreadsheet(Token, Identifier); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
@@ -30,7 +30,7 @@ sidebar_position: 2
```sh title="CLI command example"
oint gsheets GetBook --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"
oint gsheets GetSpreadsheet --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"
```

View File

@@ -1,4 +1,4 @@
{
"label": "Books managment",
"label": "Spreadsheets managment",
"position": "2"
}

View File

@@ -6,12 +6,12 @@ sidebar_position: 2
Clears the value in cells
*Function ClearCells(Val Token, Val Book, Val CellsArray, Val Sheet = "") Export*
*Function ClearCells(Val Token, Val Spreadsheet, Val CellsArray, Val Sheet = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Book | --spreadsheet | String | BookID |
| 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) |
@@ -26,10 +26,10 @@ sidebar_position: 2
CellsArray.Add("A3");
CellsArray.Add("B4");
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Sheet = "Sheet2";
Response = OPI_GoogleSheets.ClearCells(Token, Book, CellsArray, Sheet); //Map
Response = OPI_GoogleSheets.ClearCells(Token, Spreadsheet, CellsArray, Sheet); //Map
Response = OPI_Tools.JSONString(Response); //JSON string

View File

@@ -6,13 +6,13 @@ sidebar_position: 3
Gets cell values of the table
*Function GetCellValues(Val Token, Val Book, Val CellsArray = "", Val Sheet = "") Export*
*Function GetCellValues(Val Token, Val Spreadsheet, Val CellsArray = "", Val Sheet = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Book | --spreadsheet | String | BookID |
| CellsArray | --cells | Array of String | Array of A1-type cells to get (whole sheet if not filled) |
| Spreadsheet | --spreadsheet | String | SpreadsheetID |
| CellsArray | --cells | Array of String | Array of A1 type cells to get (whole sheet if not filled) |
| Sheet | --sheetname | String | Sheet name (first sheet by default) |
@@ -26,10 +26,10 @@ sidebar_position: 3
CellsArray.Add("A3");
CellsArray.Add("B4");
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Sheet = "Sheet2";
Response = OPI_GoogleSheets.GetCellValues(Token, Book, CellsArray, Sheet); //Map
Response = OPI_GoogleSheets.GetCellValues(Token, Spreadsheet, CellsArray, Sheet); //Map
Response = OPI_Tools.JSONString(Response); //JSON string

View File

@@ -6,12 +6,12 @@ sidebar_position: 1
Sets sheet cell values
*Function SetCellValues(Val Token, Val Book, Val ValueMapping, Val Sheet = "", Val MajorDimension = "COLUMNS") Export*
*Function SetCellValues(Val Token, Val Spreadsheet, Val ValueMapping, Val Sheet = "", Val MajorDimension = "COLUMNS") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Book | --spreadsheet | String | BookID |
| Spreadsheet | --spreadsheet | String | SpreadsheetID |
| ValueMapping | --data | Map Of KeyAndValue | Fill data where the key is the cell name like A1 |
| Sheet | --sheetname | String | Sheet name (first sheet by default) |
| MajorDimension | --dim | String | Main dimension when filling the array range |
@@ -32,10 +32,10 @@ sidebar_position: 1
ValueMapping.Insert("B1", "ThisIsB1");
ValueMapping.Insert("B4", "ThisIsB4");
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Sheet = "Sheet2";
Response = OPI_GoogleSheets.SetCellValues(Token, Book, ValueMapping, Sheet); //Map
Response = OPI_GoogleSheets.SetCellValues(Token, Spreadsheet, ValueMapping, Sheet); //Map
Response = OPI_Tools.JSONString(Response); //JSON string

View File

@@ -6,12 +6,12 @@ sidebar_position: 2
Clears the value in cells
*Function ClearCells(Val Token, Val Book, Val CellsArray, Val Sheet = "") Export*
*Function ClearCells(Val Token, Val Spreadsheet, Val CellsArray, Val Sheet = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Book | --spreadsheet | String | BookID |
| 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) |
@@ -26,10 +26,10 @@ sidebar_position: 2
CellsArray.Add("A3");
CellsArray.Add("B4");
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Sheet = "Sheet2";
Response = OPI_GoogleSheets.ClearCells(Token, Book, CellsArray, Sheet); //Map
Response = OPI_GoogleSheets.ClearCells(Token, Spreadsheet, CellsArray, Sheet); //Map
Response = OPI_Tools.JSONString(Response); //JSON string

View File

@@ -6,13 +6,13 @@ sidebar_position: 3
Gets cell values of the table
*Function GetCellValues(Val Token, Val Book, Val CellsArray = "", Val Sheet = "") Export*
*Function GetCellValues(Val Token, Val Spreadsheet, Val CellsArray = "", Val Sheet = "") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Book | --spreadsheet | String | BookID |
| CellsArray | --cells | Array of String | Array of A1-type cells to get (whole sheet if not filled) |
| Spreadsheet | --spreadsheet | String | SpreadsheetID |
| CellsArray | --cells | Array of String | Array of A1 type cells to get (whole sheet if not filled) |
| Sheet | --sheetname | String | Sheet name (first sheet by default) |
@@ -26,10 +26,10 @@ sidebar_position: 3
CellsArray.Add("A3");
CellsArray.Add("B4");
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Sheet = "Sheet2";
Response = OPI_GoogleSheets.GetCellValues(Token, Book, CellsArray, Sheet); //Map
Response = OPI_GoogleSheets.GetCellValues(Token, Spreadsheet, CellsArray, Sheet); //Map
Response = OPI_Tools.JSONString(Response); //JSON string

View File

@@ -6,12 +6,12 @@ sidebar_position: 1
Sets sheet cell values
*Function SetCellValues(Val Token, Val Book, Val ValueMapping, Val Sheet = "", Val MajorDimension = "COLUMNS") Export*
*Function SetCellValues(Val Token, Val Spreadsheet, Val ValueMapping, Val Sheet = "", Val MajorDimension = "COLUMNS") Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Book | --spreadsheet | String | BookID |
| Spreadsheet | --spreadsheet | String | SpreadsheetID |
| ValueMapping | --data | Map Of KeyAndValue | Fill data where the key is the cell name like A1 |
| Sheet | --sheetname | String | Sheet name (first sheet by default) |
| MajorDimension | --dim | String | Main dimension when filling the array range |
@@ -32,10 +32,10 @@ sidebar_position: 1
ValueMapping.Insert("B1", "ThisIsB1");
ValueMapping.Insert("B4", "ThisIsB4");
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Sheet = "Sheet2";
Response = OPI_GoogleSheets.SetCellValues(Token, Book, ValueMapping, Sheet); //Map
Response = OPI_GoogleSheets.SetCellValues(Token, Spreadsheet, ValueMapping, Sheet); //Map
Response = OPI_Tools.JSONString(Response); //JSON string

View File

@@ -3,15 +3,15 @@ sidebar_position: 1
---
# AddSheet
Adds a new sheet to the book
Adds a new sheet to the spreadsheet
*Function AddSheet(Val Token, Val Book, Val Name) Export*
*Function AddSheet(Val Token, Val Spreadsheet, Val Name) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Book | --spreadsheet | String | BookIdentifier |
| Spreadsheet | --spreadsheet | String | Spreadsheet identifier |
| Name | --title | String | NewSheetName |
@@ -20,10 +20,10 @@ sidebar_position: 1
```bsl title="Code example"
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Name = "TestSheet";
Response = OPI_GoogleSheets.AddSheet(Token, Book, Name); //Map
Response = OPI_GoogleSheets.AddSheet(Token, Spreadsheet, Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string

View File

@@ -3,7 +3,7 @@ sidebar_position: 3
---
# CopySheet
Copies a sheet from one book to another
Copies a sheet from one spreadsheet to another
*Function CopySheet(Val Token, Val From, Val Target, Val Sheet) Export*
@@ -11,8 +11,8 @@ sidebar_position: 3
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| From | --from | String | SourceBookID |
| Target | --to | String | DestinationBookID |
| From | --from | String | Source spreadsheet ID |
| Target | --to | String | Destination spreadsheet ID |
| Sheet | --sheet | String | CopiedSheetID |

View File

@@ -3,15 +3,15 @@ sidebar_position: 2
---
# DeleteSheet
Deletes a sheet from the book
Deletes a sheet from the spreadsheet
*Function DeleteSheet(Val Token, Val Book, Val Sheet) Export*
*Function DeleteSheet(Val Token, Val Spreadsheet, Val Sheet) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Book | --spreadsheet | String | BookIdentifier |
| Spreadsheet | --spreadsheet | String | Spreadsheet identifier |
| Sheet | --sheet | String | IdentifierOfSheetToDelete |
@@ -20,10 +20,10 @@ sidebar_position: 2
```bsl title="Code example"
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Sheet = "1790807910";
Response = OPI_GoogleSheets.DeleteSheet(Token, Book, Sheet); //Map
Response = OPI_GoogleSheets.DeleteSheet(Token, Spreadsheet, Sheet); //Map
Response = OPI_Tools.JSONString(Response); //JSON string

View File

@@ -0,0 +1,208 @@
---
sidebar_position: 1
---
# Create spreadsheet
Creates a new spreadsheet
*Function CreateSpreadsheet(Val Token, Val Name, Val ArrayOfSheetNames) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Name | --title | String | Name |
| ArrayOfSheetNames | --sheets | Array of String | Array of names to add new sheets to the spreadsheet |
Returns: Map Of KeyAndValue - serialized JSON response from Google
```bsl title="Code example"
ArrayOfSheetNames = New Array;
ArrayOfSheetNames.Add("Sheet1");
ArrayOfSheetNames.Add("Sheet2");
Name = "TestTable";
Response = OPI_GoogleSheets.CreateSpreadsheet(Token, Name, ArrayOfSheetNames); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint gsheets CreateSpreadsheet --token %token% --title "TestTable" --sheets %sheets%
```
```json title="Result"
{
"spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc",
"properties": {
"title": "TestTable",
"locale": "ru_RU",
"autoRecalc": "ON_CHANGE",
"timeZone": "Etc/GMT",
"defaultFormat": {
"backgroundColor": {
"red": 1,
"green": 1,
"blue": 1
},
"padding": {
"top": 2,
"right": 3,
"bottom": 2,
"left": 3
},
"verticalAlignment": "BOTTOM",
"wrapStrategy": "OVERFLOW_CELL",
"textFormat": {
"foregroundColor": {},
"fontFamily": "arial,sans,sans-serif",
"fontSize": 10,
"bold": false,
"italic": false,
"strikethrough": false,
"underline": false,
"foregroundColorStyle": {
"rgbColor": {}
}
},
"backgroundColorStyle": {
"rgbColor": {
"red": 1,
"green": 1,
"blue": 1
}
}
},
"spreadsheetTheme": {
"primaryFontFamily": "Arial",
"themeColors": [
{
"colorType": "TEXT",
"color": {
"rgbColor": {}
}
},
{
"colorType": "BACKGROUND",
"color": {
"rgbColor": {
"red": 1,
"green": 1,
"blue": 1
}
}
},
{
"colorType": "ACCENT1",
"color": {
"rgbColor": {
"red": 0.25882354,
"green": 0.52156866,
"blue": 0.95686275
}
}
},
{
"colorType": "ACCENT2",
"color": {
"rgbColor": {
"red": 0.91764706,
"green": 0.2627451,
"blue": 0.20784314
}
}
},
{
"colorType": "ACCENT3",
"color": {
"rgbColor": {
"red": 0.9843137,
"green": 0.7372549,
"blue": 0.015686275
}
}
},
{
"colorType": "ACCENT4",
"color": {
"rgbColor": {
"red": 0.20392157,
"green": 0.65882355,
"blue": 0.3254902
}
}
},
{
"colorType": "ACCENT5",
"color": {
"rgbColor": {
"red": 1,
"green": 0.42745098,
"blue": 0.003921569
}
}
},
{
"colorType": "ACCENT6",
"color": {
"rgbColor": {
"red": 0.27450982,
"green": 0.7411765,
"blue": 0.7764706
}
}
},
{
"colorType": "LINK",
"color": {
"rgbColor": {
"red": 0.06666667,
"green": 0.33333334,
"blue": 0.8
}
}
}
]
}
},
"sheets": [
{
"properties": {
"sheetId": 1999766427,
"title": "Sheet1",
"index": 0,
"sheetType": "GRID",
"gridProperties": {
"rowCount": 1000,
"columnCount": 26
}
}
},
{
"properties": {
"sheetId": 225184494,
"title": "Sheet2",
"index": 1,
"sheetType": "GRID",
"gridProperties": {
"rowCount": 1000,
"columnCount": 26
}
}
}
],
"spreadsheetUrl": "https://docs.google.com/spreadsheets/d/1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc/edit"
}
```

View File

@@ -0,0 +1,50 @@
---
sidebar_position: 3
---
# Change spreadsheet name
Changes the name of the existing spreadsheet
*Function EditSpreadsheetTitle(Val Token, Val Spreadsheet, Val Name) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Spreadsheet | --spreadsheet | String | SpreadsheetID |
| Name | --title | String | New name |
Returns: Map Of KeyAndValue - serialized JSON response from Google
```bsl title="Code example"
Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Name = "Test table (change.)";
Response = OPI_GoogleSheets.EditSpreadsheetTitle(Token, Spreadsheet, Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint gsheets EditSpreadsheetTitle --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc" --title "Test table (change.)"
```
```json title="Result"
{
"spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc",
"replies": [
{}
]
}
```

View File

@@ -0,0 +1,203 @@
---
sidebar_position: 2
---
# Get spreadsheet
Gets information about the spreadsheet by ID
*Function GetSpreadsheet(Val Token, Val Identifier) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Identifier | --spreadsheet | String | Spreadsheet identifier |
Returns: Map Of KeyAndValue - serialized JSON response from Google
```bsl title="Code example"
Identifier = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Response = OPI_GoogleSheets.GetSpreadsheet(Token, Identifier); //Map
Response = OPI_Tools.JSONString(Response); //JSON string
```
```sh title="CLI command example"
oint gsheets GetSpreadsheet --token %token% --spreadsheet "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc"
```
```json title="Result"
{
"spreadsheetId": "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc",
"properties": {
"title": "Test table (change.)",
"locale": "ru_RU",
"autoRecalc": "ON_CHANGE",
"timeZone": "Etc/GMT",
"defaultFormat": {
"backgroundColor": {
"red": 1,
"green": 1,
"blue": 1
},
"padding": {
"top": 2,
"right": 3,
"bottom": 2,
"left": 3
},
"verticalAlignment": "BOTTOM",
"wrapStrategy": "OVERFLOW_CELL",
"textFormat": {
"foregroundColor": {},
"fontFamily": "arial,sans,sans-serif",
"fontSize": 10,
"bold": false,
"italic": false,
"strikethrough": false,
"underline": false,
"foregroundColorStyle": {
"rgbColor": {}
}
},
"backgroundColorStyle": {
"rgbColor": {
"red": 1,
"green": 1,
"blue": 1
}
}
},
"spreadsheetTheme": {
"primaryFontFamily": "Arial",
"themeColors": [
{
"colorType": "TEXT",
"color": {
"rgbColor": {}
}
},
{
"colorType": "BACKGROUND",
"color": {
"rgbColor": {
"red": 1,
"green": 1,
"blue": 1
}
}
},
{
"colorType": "ACCENT1",
"color": {
"rgbColor": {
"red": 0.25882354,
"green": 0.52156866,
"blue": 0.95686275
}
}
},
{
"colorType": "ACCENT2",
"color": {
"rgbColor": {
"red": 0.91764706,
"green": 0.2627451,
"blue": 0.20784314
}
}
},
{
"colorType": "ACCENT3",
"color": {
"rgbColor": {
"red": 0.9843137,
"green": 0.7372549,
"blue": 0.015686275
}
}
},
{
"colorType": "ACCENT4",
"color": {
"rgbColor": {
"red": 0.20392157,
"green": 0.65882355,
"blue": 0.3254902
}
}
},
{
"colorType": "ACCENT5",
"color": {
"rgbColor": {
"red": 1,
"green": 0.42745098,
"blue": 0.003921569
}
}
},
{
"colorType": "ACCENT6",
"color": {
"rgbColor": {
"red": 0.27450982,
"green": 0.7411765,
"blue": 0.7764706
}
}
},
{
"colorType": "LINK",
"color": {
"rgbColor": {
"red": 0.06666667,
"green": 0.33333334,
"blue": 0.8
}
}
}
]
}
},
"sheets": [
{
"properties": {
"sheetId": 1999766427,
"title": "Sheet1",
"index": 0,
"sheetType": "GRID",
"gridProperties": {
"rowCount": 1000,
"columnCount": 26
}
}
},
{
"properties": {
"sheetId": 225184494,
"title": "Sheet2",
"index": 1,
"sheetType": "GRID",
"gridProperties": {
"rowCount": 1000,
"columnCount": 26
}
}
}
],
"spreadsheetUrl": "https://docs.google.com/spreadsheets/d/1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc/edit"
}
```

View File

@@ -0,0 +1,4 @@
{
"label": "Spreadsheets managment",
"position": "2"
}

View File

@@ -3,15 +3,15 @@ sidebar_position: 1
---
# AddSheet
Adds a new sheet to the book
Adds a new sheet to the spreadsheet
*Function AddSheet(Val Token, Val Book, Val Name) Export*
*Function AddSheet(Val Token, Val Spreadsheet, Val Name) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Book | --spreadsheet | String | BookIdentifier |
| Spreadsheet | --spreadsheet | String | Spreadsheet identifier |
| Name | --title | String | NewSheetName |
@@ -20,10 +20,10 @@ sidebar_position: 1
```bsl title="Code example"
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Name = "TestSheet";
Response = OPI_GoogleSheets.AddSheet(Token, Book, Name); //Map
Response = OPI_GoogleSheets.AddSheet(Token, Spreadsheet, Name); //Map
Response = OPI_Tools.JSONString(Response); //JSON string

View File

@@ -3,7 +3,7 @@ sidebar_position: 3
---
# CopySheet
Copies a sheet from one book to another
Copies a sheet from one spreadsheet to another
*Function CopySheet(Val Token, Val From, Val Target, Val Sheet) Export*
@@ -11,8 +11,8 @@ sidebar_position: 3
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| From | --from | String | SourceBookID |
| Target | --to | String | DestinationBookID |
| From | --from | String | Source spreadsheet ID |
| Target | --to | String | Destination spreadsheet ID |
| Sheet | --sheet | String | CopiedSheetID |

View File

@@ -3,15 +3,15 @@ sidebar_position: 2
---
# DeleteSheet
Deletes a sheet from the book
Deletes a sheet from the spreadsheet
*Function DeleteSheet(Val Token, Val Book, Val Sheet) Export*
*Function DeleteSheet(Val Token, Val Spreadsheet, Val Sheet) Export*
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Token |
| Book | --spreadsheet | String | BookIdentifier |
| Spreadsheet | --spreadsheet | String | Spreadsheet identifier |
| Sheet | --sheet | String | IdentifierOfSheetToDelete |
@@ -20,10 +20,10 @@ sidebar_position: 2
```bsl title="Code example"
Book = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Spreadsheet = "1Pu07Y5UiGVfW4fqfP7tcSQtdSX_2wdm2Ih23zlxJJwc";
Sheet = "1790807910";
Response = OPI_GoogleSheets.DeleteSheet(Token, Book, Sheet); //Map
Response = OPI_GoogleSheets.DeleteSheet(Token, Spreadsheet, Sheet); //Map
Response = OPI_Tools.JSONString(Response); //JSON string