Вы просматриваете старую версию данной страницы. Смотрите текущую версию.

Сравнить с текущим просмотр истории страницы

« Предыдущий Версия 2 Следующий »

ВАЖНО

Для использования api таблица должна быть либо открыта для "всех, у кого есть ссылка", либо если нет такой возможности, то для пользователя twin-gsheets@gspread-restapi.iam.gserviceaccount.com

Описание

Новая реализация api для работы с гугл таблицами. 

Находится в разработке. На текущий момент реализован метод чтения из таблицы. 

Документация

Ссылка на swagger-документацию: http://intgr.twin24.io:60061/docs

Чтение данных из таблицы

Ссылка на документацию по методу

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

Пример запроса

http://intgr.twin24.io:60061/get_data?spreadsheet_url=https://docs.google.com/spreadsheets/d/1J3SR6E3cH6EJ5Zva4kMW9b1n8HJ2ojK815Y3rEx3fX0/edit?usp=sharing&worksheet_name=Лист1&filter_headers=Группа[///]Дата&filter_values=1[///]22.01.2022

Пример ответа

Ответ в формате Json 
{
  "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"


  • Нет меток