$integration

Сервис $integration используется для взаимодействия с интеграциями, подключенными к проекту.

подсказка

Перед использованием сервиса подключите нужную интеграцию и получите ее integrationId.

Методы

Google Таблицы

Эта интеграция позволяет сценарию взаимодействовать с таблицами Google: читать данные из таблиц, записывать и удалять их при помощи бота.

Все методы для интеграции с таблицами Google, помимо integrationId, требуют передачи следующих обязательных параметров:

• spreadsheetId — идентификатор таблицы. Скопируйте его из адресной строки.
• sheetName — название листа таблицы, с которым будет взаимодействовать бот.

Метод	Описание
googleSheets.readDataFromCells	Чтение данных из ячеек таблицы.
googleSheets.writeDataToCells	Запись данных в ячейки таблицы.
googleSheets.writeDataToLine	Запись данных в строку таблицы.
googleSheets.deleteRowOrColumn	Удаление данных из строк или столбцов таблицы.
googleSheets.clearCellData	Очистка ячеек таблицы.

Результат вызова данных методов доступен в объекте $context. Если вызов успешен, то поле $context.response.googleSheets.result принимает значение "success", иначе — "error". Подробную информацию о возникающих ошибках вы можете найти на вкладке Логи сервера.

предупреждение

Google Таблицы ограничивают количество запросов к API в минуту. Подробнее об ограничениях

Чтобы настроить интеграцию с Google Таблицами, вы также можете использовать тег действия GoogleSheets. Этот тег позволяет выполнять все те же действия, что и методы из таблицы выше.

Пользовательские запросы

Возможна ситуация, когда встроенных методов сервиса $integration недостаточно для выполнения вашей задачи.

подсказка

Вы можете самостоятельно настроить запрос к любому методу, который поддерживается на стороне API интеграции, подключенной к проекту. Для этого используйте метод $integration.customRequest.

Тестирование

Для сценариев, в которых вызываются методы $integration, вы можете писать автоматические тесты: задавать заглушки для запросов и проверять, что ответы от сервиса совпадают с ожидаемыми.

подсказка

Чтобы тестировать интеграции, используйте в тестах тег <mockService>.