Предупреждение | ||
---|---|---|
| ||
При использовании апи с таблицами с суммарным количеством строк более 50_000 могут наблюдаться задержки в ответе Работоспособность апи с таблицами с суммарным количеством строк более 100_000 не гарантируется. С "большими" (более 50_000 строк) таблицами крайне рекомендуется отказаться от работы через апи гугл таблиц и перейти на работу в crm системе с открытым апи. |
Примечание | ||
---|---|---|
| ||
Для использования api таблица должна быть либо открыта для "всех, у кого есть ссылка", либо если нет такой возможности, то для пользователя twin-gsheets@gspread-restapi.iam.gserviceaccount.com |
...
Параметр | Обязательность | Описание |
---|---|---|
spreadsheet_url | да | Ссылка на гугл таблицу |
worksheet_name | нет | Имя "листа", из которого будут получены данные Если отсутствует, то будет использован первый лист |
filter_headers | нет | Имя заголовков столбцов, по которым будет происходить фильтрация Для передачи нескольких заголовков используется разделитель [///] Например: Хотим использовать заголовки Имя и Телефон Тогда в filter_headers передаем значение Имя[///]Телефон |
filter_values | нет | Значение фильтров по заголовкам Для передачи нескольких заголовков используется разделитель [///] Например: Используя пример с Имя и Телефон, хотим найти Иван с номером 79991234567 Тогда в filter_values передаем значение Иван[///]79991234567 |
Пример запроса (URL)
...
Описание параметров метода
Параметр | Обязательность | Описание |
---|---|---|
spreadsheet_url | да | Ссылка на гугл таблицу |
worksheet_name | нет | Имя "листа", из которого будут получены данные Если отсутствует, то будет использован первый лист |
empty | нет | Выбор режима записи одной строки (если строк несколько - игнорируется):
*Первый режим работает значительно быстрее второго, так как не требует поиска пустой строки |
mode | нет | Выбор режима обработки переданных в таблицу данных:
|
Описание полей тела метода
Поле | Обязательность | Тип | Описание |
---|---|---|---|
data | да | List[List] | Массив строк для записи |
data.X (где X - номер элемента в массиве data) | да | List[int | str] | Массив значений для записи в строку |
data.X.Y (где Y номер элемента в массиве data.X) | да | int | str | Значение для записи |
Пример запроса (cURL)
Блок кода | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
curl --location 'http://intgr.twin24.io:60061/add_rows?spreadsheet_url=https%3A%2F%2Fdocs.google.com%2Fspreadsheets%2Fd%2F1J3SR6E3cH6EJ5Z...3rEx3fX0%2Fedit%23gid%3D0&worksheet_name=%D0%9B%D0%B8%D1%81%D1%821&mode=1' \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "data": [ [ "Test", 1, "Just string" ], [ "Test", 2, "=A1" ] ] }' |
...
Описание полей ответа (Успешного. Код: 200)
Поле | Обязательность | Описание |
---|---|---|
msg | Да | Сообщение об успешном выполнении. В случае ряда ошибок будет содержать текст ошибки |
Удаление строки/строк из таблицы
...
Описание параметров метода
Параметр | Обязательность | Описание |
---|---|---|
spreadsheet_url | да | Ссылка на гугл таблицу |
worksheet_name | нет | Имя "листа", из которого будут получены данные Если отсутствует, то будет использован первый лист |
start | да | Номер строки - начало диапазона для удаления *Если передан только параметр start, то будет удалена одна строка, номер который передан в этом параметре. |
end | нет | Номер строки - конец диапазона для удаления *Если передан только параметр start, то будет удалена одна строка, номер который передан в этом параметре. |
Пример запроса (URL)
...
Описание полей ответа (Успешного. Код: 200)
Поле | Обязательность | Описание |
---|---|---|
msg | Да | Сообщение об успешном выполнении. В случае ряда ошибок будет содержать текст ошибки |
Изменение и запись ячейки/ячеек в таблице
...
Описание параметров метода
Параметр | Обязательность | Описание |
---|---|---|
spreadsheet_url | да | Ссылка на гугл таблицу |
worksheet_name | нет | Имя "листа", из которого будут получены данные Если отсутствует, то будет использован первый лист |
mode | нет | Выбор режима обработки переданных в таблицу данных:
|
Описание полей тела метода
Поле | Обязательность | Тип | Описание |
---|---|---|---|
range | да | str | Номер ячейки или диапазон ячеек для изменения в A1 нотации |
data | да | List[List] | int | str | Массив строк для записи или Значение для записи |
data.X (где X - номер элемента в массиве data) | да | List[int | str] | Массив значений для записи в строку |
data.X.Y (где Y номер элемента в массиве data.X) | да | int | str | Значение для записи |
Пример запроса (cURL)
Запись одного значения
...
Описание полей ответа (Успешного. Код: 200)
Поле | Обязательность | Описание |
---|---|---|
msg | Да | Сообщение об успешном выполнении. В случае ряда ошибок будет содержать текст ошибки |