Примечание | ||
---|---|---|
| ||
Для использования api таблица должна быть либо открыта для "всех, у кого есть ссылка", либо если нет такой возможности, то для пользователя twin-gsheets@gspread-restapi.iam.gserviceaccount.com |
Оглавление | ||||
---|---|---|---|---|
|
...
http://intgr.twin24.io:60061/docs#/Get%20Data/Get_data_from_spreadsheet_get_data_get
Метод, URL и авторизация
Метод: GET
Authorization: No Auth
URL: http://intgr.twin24.io:60061/get_data
Описание параметров метода
Параметр | Обязательность | Описание |
---|---|---|
spreadsheet_url | да | Ссылка на гугл таблицу |
worksheet_name | нет | Имя "листа", из которого будут получены данные Если отсутствует, то будет использован первый лист |
filter_headers | нет | Имя заголовков столбцов, по которым будет происходить фильтрация Для передачи нескольких заголовков используется разделитель [///] Например: Хотим использовать заголовки Имя и Телефон Тогда в filter_headers передаем значение Имя[///]Телефон |
filter_values | нет | Значение фильтров по заголовкам Для передачи нескольких заголовков используется разделитель [///] Например: Используя пример с Имя и Телефон, хотим найти Иван с номером 79991234567 Тогда в filter_values передаем значение Иван[///]79991234567 |
Пример запроса
Пример ответа
Блок кода | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
{ "count": 2, "data": [ { "Идентификатор": "7f2e8a0c-4d6f-4d9d-8c2f-7f1c9e7a1c8a", "Группа": 1, "Фамилия": "Кузнецова", "Имя": "Анна", "Отчество": "Ивановна", "Дата": "22.01.2022", "Row": 2 }, { "Идентификатор": "3f6d4b21-8e4a-4f5d-9b7d-1c3d0f6e9c5b", "Группа": 1, "Фамилия": "Лебедев", "Имя": "Артем", "Отчество": "Александрович", "Дата": "22.01.2022", "Row": 3 } ], "filter_used": true, "filter_headers": [ "Группа", "Дата" ], "filter_values": [ "1", "22.01.2022" ], "msg": "Ok" } |
Описание полей ответа (Успешного. Код: 200)
Поле | Обязательность | Описание |
---|---|---|
count | Да | Число элементов массива data – количество строк (не считая заголовка), полученных из таблицы |
data | Да | Массив данных (строк) – полученных из таблицы |
Идентификатор/Группа и тд | нет | Значения в соответствующих заголовках таблицы в строке Row |
Row | нет | Номер строки в таблице |
filter_used | нет | Был ли применен фильтр |
filter_headers | нет | Заголовки, по которым была фильтрация |
filter_values | нет | Значения для фильтрации |
msg | Да | Сообщение об успешном завершении "Ok" |