- Стандартный шаг — отправка веб-хука.
- URL-адрес фиксирован; переменные можно размещать в теле документа.
- Ответ остается доступным для дальнейших шагов.
- Для выполнения этой функции требуется разрешение администратора.
Для выполнения рабочего процесса в Google Workspace Studio могут потребоваться данные извне Gmail, Drive или Chat: статус заказа, число из базы данных или ответ от внутреннего инструмента. Чтобы получить эти данные или отправить информацию в другой сервис, можно добавить соответствующий шаг. Отправить веб-хукЭто отправит HTTP-запрос по указанному вами адресу API.
Для выполнения этого запроса не требуется настраивать вызов функции Gemini. В Workspace Studio поток выполняет шаг веб-перехватчика и получает ответ. Затем, если он окажется полезным, вы можете передать этот ответ на другой шаг для его обобщения, извлечения данных или передачи результата.
Что вам понадобится перед подключением к API
Первый шаг — убедиться, что ваша организация может использовать веб-хуки. Эта функция находится в... ограниченный предварительный просмотр Эта функция отключена по умолчанию. Для её использования необходимо войти в систему администратору. Приложения > Google Workspace > Workspace Studio > Настройки веб-перехватчика и включить его для соответствующего организационного подразделения.
В некоторых версиях администратор также может ограничить количество подключений одним устройством. список разрешенных доменов и URL-адресовЕсли шаг отображается в Studio, но не взаимодействует с вашим API, убедитесь, что целевой адрес авторизован. Кроме того, по умолчанию действия, связанные с веб-хуками, требуют от пользователя проверки и подтверждения шага перед его выполнением.
От внешнего сервиса вам необходимо знать его URL-адрес, поддерживаемые им HTTP-методы и ожидаемый формат данных. Также проверьте, как он осуществляет аутентификацию: публичный API только для чтения предъявляет иные требования, чем частный API, требующий токенов или специальных заголовков.
Как вызвать API из Workspace Studio: пошаговая инструкция
Входить studio.workspace.google.com и создайте рабочий процесс с необходимым триггером. Например, вы можете запускать его при получении электронного письма, соответствующего определенным условиям. Затем выполните следующие шаги:
- Нажимать Добавить шаг и выберите Отправить веб-хук.
- Войдите в Полный URL API, включая префикс
https://Адрес необходимо указать корректно: это поле не поддерживает переменные потока. - Выберите метод HTTP. ПОЛУЧАТЬ Он используется для запроса данных; ПОЧТАдля отправки или создания записи. Они также доступны. ВСТАВИТЬ, ИСПРАВИТЬ и УДАЛИТЬ.
- Если API требует наличия тела запроса, укажите его в поле содержимого или полезная нагрузкаGoogle рекомендует использовать JSON, если принимающий сервис ожидает именно его.
- Сделайте выполнение тестаПроверьте результат и активируйте процесс после того, как убедитесь, что он работает.
Имейте в виду, что тест выполнить действиеЕсли вы настраиваете POST-запрос для создания записи или DELETE-запрос для ее удаления, сначала используйте тестовую среду или данные, которые вы можете изменять без проблем.
Пример: отправка уведомления внешнему инструменту.
Представьте, что у вашей команды есть API, который создает оповещения. https://api.ejemplo.com/v1/avisosЭтот адрес иллюстративныйВам потребуется заменить его на тот, что используется в вашем сервисе. Если в документации указано, что он принимает POST-запросы и JSON-тело запроса, вы можете настроить этот шаг с таким содержимым, как: {"tipo":"nuevo_correo","origen":"Workspace Studio"}.
Вы также можете вставить переменный поток Например, в теле письма можно указать тему электронного письма, которое его вызвало. Сделайте это с помощью селектора переменных в Studio и проверьте результат: если вставленный текст содержит кавычки или другие специальные символы, это может привести к некорректному форматированию JSON. Переменные можно использовать в содержимом, но не в поле URL.
Если вам нужно получить данные, выберите GET и введите фиксированный URL-адрес, который уже содержит необходимые параметры. Workspace Studio проигнорирует любое содержимое, которое вы указали в теле GET-запроса.
Что делать с ответом API?
Этап веб-перехватчика завершается... ответ службы в текстовом формате Это переменная, доступная для последующих шагов. Вы можете использовать её для отправки уведомления, написания сводки или для запроса к шагу ИИ на извлечение определённых данных.
Например, если API возвращает статус заказа, следующий шаг может сообщить этот статус команде. Явно выберите переменную, содержащую ответ: последующие шаги не получают автоматически все данные, полученные ранее в процессе. Рекомендуется протестировать возвращаемое содержимое, прежде чем писать инструкции, зависящие от него.
Если API требует аутентификации или более сложной логики
Документированная базовая конфигурация для Отправить веб-хук Он включает URL-адрес, метод и необязательное тело запроса. Если вашей интеграции необходимо получить токен OAuth, сформировать URL-адрес с переменными параметрами, добавить определенные заголовки или преобразовать ответ перед продолжением, проверьте, соответствует ли этот шаг этим требованиям.
Если этого недостаточно, одним из вариантов является разработка Пользовательский шаг для Workspace Studio через плагин. В реализации Google Apps Script сервис UrlFetchApp Это позволяет отправлять запросы к внешним API и обрабатывать JSON-ответы. Для этого решения требуется разработка и правильная настройка разрешений; оно не требуется для простых запросов, которые уже может обработать встроенный механизм.
Избегайте вставки закрытых ключей в видимые поля процесса или встраивания их в общую ссылку. Перед отправкой данных из Gmail, чата или календаря проверьте, какую информацию получит внешний сервис и имеет ли он право ее обрабатывать.
Как обнаружить ошибки в веб-хуке
Если соединение не устанавливается, откройте вкладку. Активность В этом разделе вы можете просмотреть полную ошибку и ответ, отправленный целевым сервером. Эта информация помогает отличить проблему с конфигурацией Studio от запроса, отклоненного API.
- Этот шаг не отображается: Уточните у администратора, включены ли веб-перехватчики для вашего подразделения.
- URL-адрес заблокирован: Проверьте список разрешенных адресов, если в вашей версии используется такое ограничение.
- Ошибка 400: Проверьте формат тела запроса и поля, необходимые для работы API.
- Ошибка 401 или 403: Проверьте необходимые для работы сервиса разрешения и метод аутентификации.
- Ошибка 429: Проверьте, не превысили ли вы лимит запросов для целевого API.
- Ошибка 500: Проверьте статус и записи службы, получившей запрос.
Также следует учитывать общие ограничения Workspace Studio: в настоящее время он поддерживает до 25 потоков на пользователя y 20 шагов на потокКроме того, существует общий лимит выполнения, который сбрасывается каждые 24 часа. Если несколько потоков перестают выполняться, проверьте их активность, прежде чем связывать сбой с API.
Для большинства простых HTTP-соединений процесс довольно прост: включить веб-перехватчик, настроить фиксированный URL-адрес и правильный метод, протестировать запрос и использовать ответ на последующих этапах. Если интеграция требует расширенной аутентификации или преобразования данных с помощью кода, то имеет смысл подготовить собственный шаг.
Я энтузиаст технологий, который превратил свои «компьютерные» интересы в профессию. Я провел более 10 лет своей жизни, используя передовые технологии и возясь со всевозможными программами из чистого любопытства. Сейчас я специализируюсь на компьютерных технологиях и видеоиграх. Это потому, что более 5 лет я пишу статьи для различных сайтов, посвященных технологиям и видеоиграм, создавая статьи, которые стремятся дать вам необходимую информацию на понятном каждому языке.
Если у вас есть какие-либо вопросы, мои знания варьируются от всего, что связано с операционной системой Windows, а также Android для мобильных телефонов. И я предан вам, я всегда готов потратить несколько минут и помочь вам решить любые вопросы, которые могут у вас возникнуть в этом мире Интернета.