To download the app, visit: [connectors](https://tulip.co/library/<span translate=)/microsoft-excel-connector/">Library
Коннектор Microsoft Excel
Интеграция с API Microsoft O365 Worksheet V1.0
Введение
API рабочих листов Microsoft Excel позволяет пользователям создавать, читать и редактировать листы Microsoft Excel при наличии соответствующих прав доступа к их учетным записям Office 365. Цель данного коннектора — интегрировать Tulip с Microsoft с помощью Graph API (v1.0) через HTTP-коннекторы и предоставить нашим клиентам готовый к использованию коннектор, который можно импортировать в их экземпляр.
Цель
В данном документе будут освещены различные функции коннектора, которые можно реализовать посредством HTTP-вызовов к API Microsoft Graph (v1.0) для взаимодействия с таблицами Excel в M365, а также продемонстрированы различные действия по чтению и записи в таблицах, которые можно использовать в различных сценариях применения.
Документация по API
Документация по Microsoft Graph API
Предварительные условия
- Создайте учетную запись в Microsoft O365 и настройте учетные данные OAuth 2.0 в Microsoft Entra ID.
- Зарегистрируйте API с необходимыми областями доступа на портале Microsoft. Azure — Entra ID
Видео по настройке коннектора:
Детали подключения к Tulip
Следующую информацию необходимо настроить в разделе
коннекторах Tulip.
- Работает на: хосте облачного соединителя
- Хост: graph.microsoft.com
- Порт: 443
- TLS: Да
OAuth 2: для получения токена доступа для взаимодействия с API Microsoft Graph
Функции коннектора
1) Получить сведения об одном диске
Назначение
Этот коннектор загрузит все элементы с одного диска.
Конечная точка
HTTP-запрос GET к конечной точке —https://graph.micrsoft.com:443/v1.0/me/drive/root/children
Требуемые входные данные
Входные данные не требуются
Требуемый экстрактор выходных данных
- SheetID: уникальный идентификатор рабочей книги, который будет использоваться для выполнения других задач.
- CreatedAt: Дата и время создания рабочей книги.
- LastModified: Дата и время последнего изменения рабочей книги.
- SheetName: Имя рабочей книги.
- SpreadSheetURL: URL-адрес рабочей книги.
2) Получить все листы в рабочей книге
Цель
Этот коннектор загрузит все рабочие листы рабочей книги по идентификатору workbookID.
Конечная точка
HTTP GET к конечной точке —https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets
Обязательные параметры
Ниже приведены параметры URL, которые необходимо передать
- Идентификатор рабочей книги
Требуемый выходной экстрактор
- sheetId: уникальный идентификатор рабочего листа, который будет использоваться для выполнения других задач.
- sheetName: отображаемое имя рабочего листа.
- sheetPosition: позиция рабочего листа в рабочей книге, начиная с нуля.
- sheetVisibility: видимость рабочего листа. Возможные значения: Visible, Hidden, VeryHidden.
3) Получение метаданных рабочего листа
Цель
Этот коннектор будет извлекать данные по WorkbookID и имени рабочего листа.
Конечная точка
HTTP-запрос GET к конечной точке https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/
Обязательные параметры
Ниже приведены URL-параметры, которые необходимо передать
- Идентификатор рабочей книги
- Имя рабочего листа
Требуемый экстрактор результатов
- sheetId: уникальный идентификатор электронной таблицы, который будет использоваться для выполнения остальных задач.
- sheetName: отображаемое имя рабочего листа.
- sheetPosition: Позиция рабочего листа в рабочей книге, начиная с нуля.
- sheetVisibility: видимость рабочего листа. Возможные значения: Visible, Hidden, VeryHidden.
4) Создание нового рабочего листа
Цель
- Пользователи могут передать в качестве входных данных идентификатор рабочей книги и имя рабочего листа, после чего Tulip создаст новый рабочий лист с указанным именем. В ответе API будут содержаться метаданные и различные свойства рабочего листа. Эти данные можно в дальнейшем использовать для извлечения и обновления данных из рабочих листов.
- Информация извлекается из API Microsoft Graph V1.0 и затем может использоваться как в приложениях Tulip, так и в таблицах Tulip или переменных Tulip, которые будут передаваться в другие функции коннектора.
Конечная точка
HTTP-запрос POST на конечную точку https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/add
Обязательные параметры
Ниже перечислены параметры, отправляемые в теле запроса
- Идентификатор рабочей книги — идентификатор рабочей книги
- Название рабочего листа — заголовок рабочего листа
Необходимый экстрактор выходных данных
- WorksheetId: уникальный идентификатор таблицы, который будет использоваться для выполнения других задач.
- spreadsheetURL: URL-адрес вновь созданной таблицы.
- Дополнительные параметры, возвращаемые вместе с ответом, могут быть включены в состав выходных параметров.
5) Обновление свойств рабочего листа
Цель
Пользователи могут передать в качестве входных данных идентификатор рабочей книги, старое имя рабочего листа, позицию рабочего листа и новое имя рабочего листа, и Tulip обновит рабочий лист с указанным именем. Ответ API будет содержать метаданные и различные свойства рабочего листа. Это можно в дальнейшем использовать для извлечения и обновления данных из таблиц.
Конечная точка
HTTP-вызов метода PATCH к конечной точке —https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}
Обязательные параметры
Ниже перечислены параметры, которые отправляются в теле запроса
- Идентификатор книги — идентификатор книги
- Имя рабочего листа — название рабочего листа
- Позиция рабочего листа — позиция рабочего листа в рабочей книге, начиная с нуля
- Имя новой рабочей таблицы — название новой рабочей таблицы
Обязательный экстрактор выходных данных
- sheetID: уникальный идентификатор рабочей книги, который будет использоваться для выполнения других задач
- sheetName: отображаемое имя рабочего листа.
- sheetPosition: позиция рабочего листа в рабочей книге, начиная с нуля.
6) Получить данные из конкретной ячейки
Цель
Этот коннектор будет извлекать данные из листов рабочей книги на основе предоставленных в качестве входных данных WorkbookID, названия листа, индекса строки и индекса столбца. Ответ API будет содержать значение указанной ячейки.
Конечная точка
HTTP-запрос GET к конечной точке—https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/cell(row={row index},column={column index})
Обязательные параметры
Ниже перечислены параметры URL, которые необходимо передать
- Идентификатор рабочей книги — ID рабочей книги
- Название рабочего листа — заголовок рабочего листа
- Индекс строки — номер строки ячейки, которую нужно получить
- Индекс столбца — номер столбца ячейки, которую необходимо извлечь
Необходимый экстрактор выходных данных
Этот коннектор возвращает значение ячейки с указанными индексами строки и столбца.
7) Получить данные диапазона рабочего листа
Назначение
Этот коннектор извлекает данные из листов рабочей книги на основе указанных в качестве входных данных WorkbookID, названия листа, начального и конечного диапазонов. Ответом API будут данные указанного диапазона.
Конечная точка
HTTP-запрос GET к конечной точке—https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/range(address=’{start range}:{end range}’)
Обязательные параметры
Ниже перечислены параметры URL, которые необходимо передать
- Идентификатор рабочей книги — ID рабочей книги
- Название рабочего листа — заголовок рабочего листа
- Начальный диапазон — начальный диапазон
- Конечный диапазон — конечный диапазон
Требуемый экстрактор выходных данных
Этот коннектор возвращает все значения ячеек в указанном диапазоне.
8) Обновление значений по диапазону
Назначение
Пользователи могут передать в качестве входных данных идентификатор рабочей книги, имя рабочего листа, начальный диапазон, конечный диапазон и значения для обновления, и Tulip обновит значения диапазона в соответствии с указанными параметрами. Ответ API будет содержать обновленные значения диапазона.
Конечная точка
HTTP-вызов метода PATCH к конечной точке—https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/range(address=’{start range}:{end range}’)
Обязательные параметры
Ниже приведены параметры URL, которые необходимо передать
- Идентификатор рабочей книги — ID рабочей книги
- Название рабочего листа — заголовок рабочего листа
- Начальный диапазон — начальный диапазон
- Конечный диапазон — конечный диапазон
- Значения каждой ячейки в указанном диапазоне
Требуемый экстрактор выходных данных
Нам не требуется никакой экстрактор выходных данных.
9) Создайте таблицу в рабочем листе
Цель
- Пользователи могут передать в качестве входных данных идентификатор рабочей книги, название рабочего листа, адрес рабочего листа и флаг «Имеет заголовки», после чего Tulip создаст новую таблицу с указанным именем. Ответ API будет содержать метаданные и различные свойства таблицы.
- Эту информацию можно в дальнейшем использовать для извлечения и обновления данных из электронных таблиц.
- Информация извлекается из API Microsoft Graph V1.0 и затем может использоваться либо в приложениях Tulip, либо в таблицах Tulip, либо в переменных Tulip, которые будут передаваться в другие функции коннекторов.
Конечная точка
HTTP-вызов POST к конечной точке https://graph.microsoft.com:443/v1.0/me/drive/items/{itemID}/workbook/worksheets/add
Обязательные параметры
Ниже перечислены параметры, которые отправляются в теле запроса
- Идентификатор рабочей книги — идентификатор рабочей книги
- Название рабочего листа — заголовок рабочего листа
- Address — адрес или имя объекта диапазона, представляющего источник данных. Если адрес не содержит названия листа, используется текущий активный лист.
- hasHeaders — логическое значение, указывающее, содержат ли импортируемые данные названия столбцов. Если источник не содержит заголовков (т. е. когда это свойство установлено в значение «false»), Excel автоматически сгенерирует заголовок, сдвинув данные на одну строку вниз
Обязательный экстрактор выходных данных
Этот метод возвращает значения метаданных вновь созданной таблицы.
10) Добавление новой строки в таблицу
Цель
Пользователи могут передать в качестве входных данных идентификатор рабочей книги, имя таблицы и значения строк, после чего Tulip создаст новую строку с указанными значениями. Ответ API будет содержать значения созданной строки в таблице.
Конечная точка
HTTP-запрос методом POST к конечной точке https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/tables/{tablename}/rows/add
Обязательные параметры
Ниже перечислены параметры, которые отправляются в теле запроса
- Идентификатор рабочей книги — идентификатор рабочей книги
- Название рабочего листа — заголовок рабочего листа
- Значения строк
Экстрактор обязательных выходных данных
Возвращает значения ячеек вновь созданной строки.
11) Очистить данные рабочего листа
Цель
Пользователи могут передать в качестве входных данных идентификатор рабочей книги, имя рабочего листа, начальный и конечный диапазоны, и Tulip очистит значения ячеек в указанном диапазоне.
Конечная точка
HTTP-запрос POST к конечной точке https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheet/{worksheetName}/range(address=’{start range}:{end range}’)/clear
Обязательные параметры
Ниже перечислены параметры, которые отправляются в теле запроса
- Идентификатор книги — идентификатор книги
- Имя рабочего листа — заголовок рабочего листа
- Начальный диапазон
- Конечный диапазон
Дополнительная информация
Узнайте больше о коннекторах Microsoft