Чтобы переводить контент на ваш предпочитаемый язык, Google использует технологии на основе искусственного интеллекта. Переводы от ИИ могут содержать ошибки.

Как создать приложение Google Chat на основе HTTP

На этой странице рассказывается, как создать приложение Google Chat с поддержкой HTTP, используя сервисы Google Cloud. Чтобы создать приложение Chat, напишите и разверните функцию Cloud Run, которую приложение Chat будет использовать для ответа на сообщения пользователей.

При использовании архитектуры HTTP вы настраиваете интеграцию Chat с Google Cloud или локальным сервером с помощью HTTP, как показано на следующей схеме:

Архитектура приложения Chat, использующего веб-сервис на локальном сервере.

На приведенной выше схеме показано, как пользователь взаимодействует с приложением HTTP Chat. Информация передается следующим образом:

Пользователь отправляет сообщение в Chat приложению Chat в прямой переписке или чат-группе.
HTTP-запрос отправляется на веб-сервер, который представляет собой облачную или локальную систему, содержащую логику приложения Chat.
При необходимости логику приложения Chat можно интегрировать с сервисами Google Workspace (например, Календарем и Таблицами), другими сервисами Google (например, Картами, YouTube и Vertex AI) или другими веб-сервисами (например, системой управления проектами или инструментом для создания заявок).
Веб-сервер отправляет HTTP-ответ обратно в сервис приложения Chat в Chat.
Ответ будет отправлен пользователю.
При необходимости приложение Chat может вызывать Chat API для асинхронной отправки сообщений или выполнения других операций.

Такая архитектура позволяет использовать библиотеки и компоненты, которые уже есть в вашей системе, поскольку приложения Chat можно разрабатывать на разных языках программирования.

Цели

Настройте среду.
Создайте и разверните функцию Cloud Run.
Настройте приложение Chat.
Протестируйте приложение.

Требования

Аккаунт Google Workspace версии Business или Enterprise с доступом к Google Chat.
Проект Google Cloud с включенной оплатой. Чтобы проверить, включены ли платежные функции для существующего проекта, следуйте инструкциям в разделе Как проверить статус платежей для проектов. Чтобы создать проект и настроить оплату, ознакомьтесь со статьей Как создать проект Google Cloud.

Как настроить среду

Прежде чем использовать API Google, их нужно включить в облачном проекте Google Cloud. В одном облачном проекте Google Cloud можно включить один или несколько API.

В Google API Console включите Google Chat API, Cloud Build API, Cloud Functions API, Cloud Pub/Sub API, Cloud Logging API, Artifact Registry API и Cloud Run API.

Как включить API

Как создать и развернуть функцию Cloud Run

Создайте и разверните функцию Cloud Run, которая генерирует карточку Chat с отображаемым именем отправителя и изображением аватара. Когда приложение Chat получает сообщение, оно запускает функцию и отвечает карточкой.

Чтобы создать и развернуть функцию для приложения Chat, выполните следующие действия:

Node.js

В Google API Console перейдите на страницу Cloud Run:

Перейти в Cloud Run

Убедитесь, что выбран проект для приложения Chat.
Нажмите Написать функцию.
На странице Создать сервис настройте функцию:
1. В поле Название сервиса введите addonchatapp.
2. В списке Регион выберите регион.
3. В списке Среда выполнения выберите последнюю версию Node.js.
4. В разделе Аутентификация выберите Требовать аутентификацию.
5. Нажмите Создать и подождите, пока Cloud Run создаст сервис. Консоль перенаправит вас на вкладку Источник.

На вкладке Источник:

В поле Точка входа удалите текст по умолчанию и введите avatarApp.
Замените содержимое index.js следующим кодом:

node/chat/avatar-app/index.js

Посмотреть на GitHub

import { http } from '@google-cloud/functions-framework';

// The ID of the slash command "/about".
// You must use the same ID in the Google Chat API configuration.
const ABOUT_COMMAND_ID = 1;

/**
 * Handle requests from Google Workspace add on
 *
 * @param {Object} req Request sent by Google Chat
 * @param {Object} res Response to be sent back to Google Chat
 */
http('avatarApp', (req, res) => {
  const chatEvent = req.body.chat;
  let message;
  if (chatEvent.appCommandPayload) {
    message = handleAppCommand(chatEvent);
  } else {
    message = handleMessage(chatEvent);
  }
  res.send({ hostAppDataAction: { chatDataAction: { createMessageAction: {
    message: message
  }}}});
});

/**
 * Responds to an APP_COMMAND event in Google Chat.
 *
 * @param {Object} event the event object from Google Chat
 * @return the response message object.
 */
function handleAppCommand(event) {
  switch (event.appCommandPayload.appCommandMetadata.appCommandId) {
    case ABOUT_COMMAND_ID:
      return {
        text: 'The Avatar app replies to Google Chat messages.'
      };
  }
}

/**
 * Responds to a MESSAGE event in Google Chat.
 *
 * @param {Object} event the event object from Google Chat
 * @return the response message object.
 */
function handleMessage(event) {
  // Stores the Google Chat user as a variable.
  const chatUser = event.messagePayload.message.sender;
  const displayName = chatUser.displayName;
  const avatarUrl = chatUser.avatarUrl;
  return {
    text: 'Here\'s your avatar',
    cardsV2: [{
      cardId: 'avatarCard',
      card: {
        name: 'Avatar Card',
        header: {
          title: `Hello ${displayName}!`,
        },
        sections: [{ widgets: [{
          textParagraph: { text: 'Your avatar picture: ' }
        }, {
          image: { imageUrl: avatarUrl }
        }]}]
      }
    }]
  };
}

Нажмите Сохранить и повторно развернуть.

Python

В Google API Console перейдите на страницу Cloud Run:

Перейти в Cloud Run

Убедитесь, что выбран проект для приложения Chat.
Нажмите Написать функцию.
На странице Создать сервис настройте функцию:
1. В поле Название сервиса введите addonchatapp.
2. В списке Регион выберите регион.
3. В списке Среда выполнения выберите последнюю версию Python.
4. В разделе Аутентификация выберите Требовать аутентификацию.
5. Нажмите Создать и подождите, пока Cloud Run создаст сервис. Консоль перенаправит вас на вкладку Источник.

На вкладке Источник:

В поле Точка входа удалите текст по умолчанию и введите avatar_app.
Замените содержимое main.py следующим кодом:

python/chat/avatar-app/main.py

Посмотреть на GitHub

from typing import Any, Mapping

import flask
import functions_framework

# The ID of the slash command "/about".
# You must use the same ID in the Google Chat API configuration.
ABOUT_COMMAND_ID = 1

@functions_framework.http
def avatar_app(req: flask.Request) -> Mapping[str, Any]:
  """Handle requests from Google Workspace add on

  Args:
    flask.Request req: the request sent by Google Chat

  Returns:
    Mapping[str, Any]: the response to be sent back to Google Chat
  """
  chat_event = req.get_json(silent=True)["chat"]
  if chat_event and "appCommandPayload" in chat_event:
    message = handle_app_command(chat_event)
  else:
    message = handle_message(chat_event)
  return { "hostAppDataAction": { "chatDataAction": { "createMessageAction": {
      "message": message
  }}}}

def handle_app_command(event: Mapping[str, Any]) -> Mapping[str, Any]:
  """Responds to an APP_COMMAND event in Google Chat.

  Args:
    Mapping[str, Any] event: the event object from Google Chat

  Returns:
    Mapping[str, Any]: the response message object.
  """
  if event["appCommandPayload"]["appCommandMetadata"]["appCommandId"] == ABOUT_COMMAND_ID:
    return {
      "text": "The Avatar app replies to Google Chat messages.",
    }
  return {}

def handle_message(event: Mapping[str, Any]) -> Mapping[str, Any]:
  """Responds to a MESSAGE event in Google Chat.

  Args:
    Mapping[str, Any] event: the event object from Google Chat

  Returns:
    Mapping[str, Any]: the response message object.
  """
  # Stores the Google Chat user as a variable.
  chat_user = event["messagePayload"]["message"]["sender"]
  display_name = chat_user.get("displayName", "")
  avatar_url = chat_user.get("avatarUrl", "")
  return {
    "text": "Here's your avatar",
    "cardsV2": [{
      "cardId": "avatarCard",
      "card": {
        "name": "Avatar Card",
        "header": {
          "title": f"Hello {display_name}!"
        },
        "sections": [{ "widgets": [
          { "textParagraph": { "text": "Your avatar picture:" }},
          { "image": { "imageUrl": avatar_url }},
        ]}]
      }
    }]
  }

Нажмите Сохранить и повторно развернуть.

Java

В Google API Console перейдите на страницу Cloud Run:

Перейти в Cloud Run

Убедитесь, что выбран проект для приложения Chat.
Нажмите Написать функцию.
На странице Создать сервис настройте функцию:
1. В поле Название сервиса введите addonchatapp.
2. В списке Регион выберите регион.
3. В списке Среда выполнения выберите последнюю версию Java.
4. В разделе Аутентификация выберите Требовать аутентификацию.
5. Нажмите Создать и подождите, пока Cloud Run создаст сервис. Консоль перенаправит вас на вкладку Источник.

На вкладке Источник:

В поле Точка входа удалите текст по умолчанию и введите App.
Переименуйте файл Java по умолчанию в src/main/java/com/google/chat/avatar/App.java.
Замените содержимое App.java следующим кодом:

java/chat/avatar-app/src/main/java/com/google/chat/avatar/App.java

Посмотреть на GitHub

package com.google.chat.avatar;

import com.google.api.services.chat.v1.model.CardWithId;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1Card;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1CardHeader;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1Image;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1Section;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1TextParagraph;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1Widget;
import com.google.api.services.chat.v1.model.Message;
import com.google.cloud.functions.HttpFunction;
import com.google.cloud.functions.HttpRequest;
import com.google.cloud.functions.HttpResponse;
import com.google.gson.Gson;
import com.google.gson.JsonObject;
import java.util.List;

public class App implements HttpFunction {
  // The ID of the slash command "/about".
  // You must use the same ID in the Google Chat API configuration.
  private static final int ABOUT_COMMAND_ID = 1;

  private static final Gson gson = new Gson();

  /**
   * Handle requests from Google Workspace add on
   * 
   * @param request the request sent by Google Chat
   * @param response the response to be sent back to Google Chat
   */
  @Override
  public void service(HttpRequest request, HttpResponse response) throws Exception {
    JsonObject event = gson.fromJson(request.getReader(), JsonObject.class);
    JsonObject chatEvent = event.getAsJsonObject("chat");
    Message message;
    if (chatEvent.has("appCommandPayload")) {
      message = handleAppCommand(chatEvent);
    } else {
      message = handleMessage(chatEvent);
    }
    JsonObject createMessageAction = new JsonObject();
    createMessageAction.add("message", gson.fromJson(gson.toJson(message), JsonObject.class));
    JsonObject chatDataAction = new JsonObject();
    chatDataAction.add("createMessageAction", createMessageAction);
    JsonObject hostAppDataAction = new JsonObject();
    hostAppDataAction.add("chatDataAction", chatDataAction);
    JsonObject dataActions = new JsonObject();
    dataActions.add("hostAppDataAction", hostAppDataAction);
    response.getWriter().write(gson.toJson(dataActions));
  }

  /**
   * Handles an APP_COMMAND event in Google Chat.
   *
   * @param event the event object from Google Chat
   * @return the response message object.
   */
  private Message handleAppCommand(JsonObject event) throws Exception {
    switch (event.getAsJsonObject("appCommandPayload")
      .getAsJsonObject("appCommandMetadata").get("appCommandId").getAsInt()) {
      case ABOUT_COMMAND_ID:
        return new Message()
          .setText("The Avatar app replies to Google Chat messages.");
      default:
        return null;
    }
  }

  /**
   * Handles a MESSAGE event in Google Chat.
   *
   * @param event the event object from Google Chat
   * @return the response message object.
   */
  private Message handleMessage(JsonObject event) throws Exception {
    // Stores the Google Chat user as a variable.
    JsonObject chatUser = event.getAsJsonObject("messagePayload").getAsJsonObject("message").getAsJsonObject("sender");
    String displayName = chatUser.has("displayName") ? chatUser.get("displayName").getAsString() : "";
    String avatarUrl = chatUser.has("avatarUrl") ? chatUser.get("avatarUrl").getAsString() : "";
    return new Message()
      .setText("Here's your avatar")
      .setCardsV2(List.of(new CardWithId()
        .setCardId("avatarCard")
        .setCard(new GoogleAppsCardV1Card()
          .setName("Avatar Card")
          .setHeader(new GoogleAppsCardV1CardHeader()
            .setTitle(String.format("Hello %s!", displayName)))
          .setSections(List.of(new GoogleAppsCardV1Section().setWidgets(List.of(
            new GoogleAppsCardV1Widget().setTextParagraph(new GoogleAppsCardV1TextParagraph()
              .setText("Your avatar picture:")),
            new GoogleAppsCardV1Widget()
              .setImage(new GoogleAppsCardV1Image().setImageUrl(avatarUrl)))))))));
  }
}

Замените содержимое pom.xml следующим кодом:

java/chat/avatar-app/pom.xml

Посмотреть на GitHub

<project xmlns="http://maven.apache.org/POM/4.0.0"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.google.chat</groupId>
  <artifactId>avatar-app</artifactId>
  <version>1.0-SNAPSHOT</version>

  <properties>
    <maven.compiler.target>17</maven.compiler.target>
    <maven.compiler.source>17</maven.compiler.source>
  </properties>

  <dependencies>
    <dependency>
      <groupId>com.google.cloud.functions</groupId>
      <artifactId>functions-framework-api</artifactId>
      <version>1.1.4</version>
    </dependency>
    <dependency>
      <groupId>com.google.code.gson</groupId>
      <artifactId>gson</artifactId>
      <version>2.9.1</version>
    </dependency>
    <dependency>
      <groupId>com.google.apis</groupId>
      <artifactId>google-api-services-chat</artifactId>
      <version>v1-rev20230115-2.0.0</version>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.8.1</version>
        <configuration>
        <excludes>
          <exclude>.google/</exclude>
        </excludes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

Нажмите Сохранить и повторно развернуть.

Откроется страница сведений о сервисе Cloud Run. Дождитесь развертывания функции.

Как настроить приложение Chat

После того как функция Cloud Run будет развернута, выполните следующие действия, чтобы настроить и развернуть приложение Google Chat:

В Google API Console перейдите на страницу Cloud Run:

Перейти в Cloud Run

Убедитесь, что выбран проект, для которого вы включили Cloud Run.
В списке функций нажмите addonchatapp.
На странице Сведения о сервисе скопируйте URL функции. URL заканчивается на run.app.
В строке поиска Google Cloud введите "Google Chat API", нажмите Google Chat API и выберите Управление.

Перейти к Chat API
Нажмите Конфигурация и настройте приложение Google Chat:
1. В поле Название приложения введите Quickstart App.
2. В поле URL аватара введите https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png.
3. В поле Описание введите Quickstart app.
4. В разделе Функциональность выберите Присоединяться к чат-группам и групповым чатам.
5. В разделе Настройки подключения выберите URL конечной точки HTTP.
6. В разделе Триггеры выберите Использовать общий URL конечной точки HTTP для всех триггеров и вставьте URL триггера функции Cloud Run в поле.
7. В разделе Видимость выберите Сделать это приложение Google Chat доступным для определенных пользователей и групп в вашем домене и введите свой адрес электронной почты.
8. В разделе Журналы выберите Регистрировать ошибки в Logging.
Нажмите Сохранить.
В разделе Настройки подключения скопируйте адрес электронной почты сервисного аккаунта. Этот адрес электронной почты понадобится вам, когда вы будете предоставлять приложению Chat разрешение вызывать вашу функцию.

Затем предоставьте приложению Chat разрешение на вызов функции Cloud Run.

Как разрешить Google Chat вызывать вашу функцию

Чтобы разрешить Google Chat вызывать вашу функцию, добавьте сервисный аккаунт приложения Chat с ролью Вызывающий Cloud Run.

В Google API Console перейдите на страницу Cloud Run:

Перейти в Cloud Run
В списке сервисов Cloud Run установите флажок рядом с функцией получения. (не нажимайте на саму функцию).
Нажмите Разрешения. Откроется панель Разрешения.
Нажмите Добавить субъекта.
В поле Новые субъекты введите адрес электронной почты сервисного аккаунта, связанного с приложением Chat.

Адрес электронной почты сервисного аккаунта указан на странице конфигурации Chat API в разделе Настройки подключения > URL конечной точки HTTP > Адрес электронной почты сервисного аккаунта:

Перейти к настройке Chat API
В поле Выберите роль выберите Cloud Run > Вызывающий Cloud Run.
Нажмите Сохранить.

Приложение Chat готово получать сообщения и отвечать на них.

Как протестировать приложение Chat

Чтобы протестировать приложение Chat, откройте прямую переписку с ним и отправьте сообщение:

Откройте Google Chat, используя аккаунт Google Workspace, который вы указали, когда добавляли себя в качестве доверенного тестировщика.

Перейти в Google Chat
Нажмите Новый чат.
В поле Добавьте одного или нескольких пользователей введите название приложения Chat.
Выберите приложение Chat в результатах поиска. Откроется прямая переписка.

Примечание. Если вы не видите приложение Chat в списке результатов, убедитесь, что ваш аккаунт Google Workspace включен в настройках Видимости на странице Конфигурация API Chat в Google API Console.
В новой прямой переписке с приложением введите Hello и нажмите enter.

Сообщение приложения Chat содержит карточку с именем и аватаром отправителя, как показано на изображении ниже.

Чат-приложение отвечает карточкой с отображаемым названием и изображением аватара отправителя

Чтобы добавить доверенных тестировщиков и узнать больше о тестировании интерактивных функций, ознакомьтесь со статьей Как тестировать интерактивные функции приложений для Google Chat.

Устранение неполадок

Если приложение Google Chat или карточка возвращает ошибку, в интерфейсе Chat появляется сообщение "Что-то пошло не так". или "Не удалось обработать запрос". Иногда в интерфейсе Chat не показывается сообщение об ошибке, но приложение Chat или карточка выдает неожиданный результат, например не появляется сообщение на карточке.

Хотя в интерфейсе Chat может не показываться сообщение об ошибке, при включенном ведении журнала ошибок для приложений Chat вам будут доступны подробные сообщения об ошибках и данные журнала, которые помогут устранить неполадки. Чтобы узнать, как просматривать, отлаживать и исправлять ошибки, ознакомьтесь с разделом Устранение неполадок в Google Chat.

Организовать

Чтобы избежать списания средств с аккаунта Google Cloud за ресурсы, использованные в этом руководстве, рекомендуем удалить облачный проект.

Внимание! Удаление проекта приведет к следующим последствиям:

Все данные в проекте будут удалены. Если вы использовали существующий проект, то при его удалении также будут удалены все другие данные, которые вы добавили в этот проект.
Пользовательские идентификаторы проектов будут утеряны. При создании этого проекта вы могли задать собственный идентификатор проекта, который хотите использовать в дальнейшем. Чтобы сохранить URL, в которых используется идентификатор проекта, например URL на сайте appspot.com, удалите выбранные ресурсы внутри проекта, а не весь проект.

Если вы планируете изучить несколько руководств и кратких руководств, повторное использование проектов поможет вам не превысить лимиты на количество проектов.

В Google API Console перейдите на страницу Управление ресурсами. Нажмите Меню > IAM и администрирование > Управление ресурсами.
Перейти в Менеджер ресурсов
В списке проектов выберите проект, который хотите удалить, и нажмите Удалить .
В диалоговом окне введите идентификатор проекта и нажмите Закрыть, чтобы удалить проект.

Статьи по теме

Чтобы добавить в приложение Chat дополнительные функции, ознакомьтесь со следующими статьями:
Как выбрать архитектуру приложения Chat
Как проверить запросы от Google Chat

Приложения Chat, не являющиеся дополнениями: создание HTTP-приложения Google Chat

Чтобы создать приложение Chat, которое не является дополнением Google Workspace, выполните следующие действия, чтобы развернуть функцию Cloud Run, предоставить разрешения на вызов и настроить приложение Chat, которое не является дополнением.

Как создать и развернуть функцию Cloud Run для приложения Chat, которое не является дополнением

Node.js

В Google API Console перейдите на страницу Cloud Run:

Перейти в Cloud Run

Убедитесь, что выбран проект для приложения Chat.
Нажмите Написать функцию.
На странице Создать сервис настройте функцию:
1. В поле Название сервиса введите quickstartchatapp.
2. В списке Регион выберите регион.
3. В списке Среда выполнения выберите последнюю версию Node.js.
4. В разделе Аутентификация выберите Требовать аутентификацию.
5. Нажмите Создать и подождите, пока Cloud Run создаст сервис. Консоль перенаправит вас на вкладку Источник.

На вкладке Источник:

В поле Точка входа удалите текст по умолчанию и введите avatarApp.

Замените содержимое index.js следующим кодом:

node/avatar-app/index.js

Посмотреть на GitHub

const functions = require('@google-cloud/functions-framework');

// Command IDs (configure these in Google Chat API)
const ABOUT_COMMAND_ID = 1; // ID for the "/about" slash command
const HELP_COMMAND_ID = 2; // ID for the "Help" quick command

/**
 * Google Cloud Function that handles HTTP requests from Google Chat.
 *
 * @param {Object} req - The HTTP request object sent from Google Chat.
 * @param {Object} res - The HTTP response object.
 */
functions.http('avatarApp', (req, res) => {
  const event = req.body;

  if (event.appCommandMetadata) {
    handleAppCommands(event, res);
  } else {
    handleRegularMessage(event, res);
  }
});

/**
 * Handles slash and quick commands.
 *
 * @param {Object} event - The Google Chat event.
 * @param {Object} res - The HTTP response object.
 */
function handleAppCommands(event, res) {
  const {appCommandId, appCommandType} = event.appCommandMetadata;

  switch (appCommandId) {
    case ABOUT_COMMAND_ID:
      return res.send({
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      });
    case HELP_COMMAND_ID:
      return res.send({
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      });
  }
}

/**
 * Handles regular messages (not commands).
 *
 * @param {Object} event - The Google Chat event.
 * @param {Object} res - The HTTP response object.
 */
function handleRegularMessage(event, res) {
  const messageData = createMessage(event.user);
  res.send(messageData);
}

/**
 * Creates a card message with the user's avatar.
 *
 * @param {Object} user - The user who sent the message.
 * @param {string} user.displayName - The user's display name.
 * @param {string} user.avatarUrl - The URL of the user's avatar.
 * @return {Object} - The card message object.
 */
function createMessage({displayName, avatarUrl}) {
  return {
    text: 'Here\'s your avatar',
    cardsV2: [{
      cardId: 'avatarCard',
      card: {
        name: 'Avatar Card',
        header: {
          title: `Hello ${displayName}!`,
        },
        sections: [{
          widgets: [
            {textParagraph: {text: 'Your avatar picture:'}},
            {image: {imageUrl: avatarUrl}},
          ],
        }],
      },
    }],
  };
}

Нажмите Сохранить и повторно развернуть.

Python

В Google API Console перейдите на страницу Cloud Run:

Перейти в Cloud Run

Убедитесь, что выбран проект для приложения Chat.
Нажмите Написать функцию.
На странице Создать сервис настройте функцию:
1. В поле Название сервиса введите quickstartchatapp.
2. В списке Регион выберите регион.
3. В списке Среда выполнения выберите последнюю версию Python.
4. В разделе Аутентификация выберите Требовать аутентификацию.
5. Нажмите Создать и подождите, пока Cloud Run создаст сервис. Консоль перенаправит вас на вкладку Источник.

На вкладке Источник:

В поле Точка входа удалите текст по умолчанию и введите avatar_app.

Замените содержимое main.py следующим кодом:

python/avatar-app/main.py

Посмотреть на GitHub

from typing import Any, Mapping

import flask
import functions_framework

# Command IDs (configure these in Google Chat API)
ABOUT_COMMAND_ID = 1  # ID for the "/about" slash command
HELP_COMMAND_ID = 2  # ID for the "Help" quick command


@functions_framework.http
def avatar_app(req: flask.Request) -> Mapping[str, Any]:
    """Google Cloud Function that handles HTTP requests from Google Chat.

    Args:
        flask.Request: the request

    Returns:
        Mapping[str, Any]: the response
    """
    event = req.get_json(silent=True)

    if event and "appCommandMetadata" in event:
        return handle_app_commands(event)
    else:
        return handle_regular_message(event)


def handle_app_commands(event: Mapping[str, Any]) -> Mapping[str, Any]:
    """Handles slash and quick commands.

    Args:
        Mapping[str, Any] event: The Google Chat event.

    Returns:
        Mapping[str, Any]: the response
    """
    app_command_id = event["appCommandMetadata"]["appCommandId"]

    if app_command_id == ABOUT_COMMAND_ID:
        return {
            "privateMessageViewer": event["user"],
            "text": "The Avatar app replies to Google Chat messages.",
        }
    elif app_command_id == HELP_COMMAND_ID:
        return {
            "privateMessageViewer": event["user"],
            "text": "The Avatar app replies to Google Chat messages.",
        }
    return {}




def handle_regular_message(event: Mapping[str, Any]) -> Mapping[str, Any]:
    """Handles regular messages (not commands).

    Args:
        Mapping[str, Any] event: The Google Chat event.

    Returns:
        Mapping[str, Any]: the response
    """

    if not event or "user" not in event:
        return "Invalid request."

    message_data = create_message(event["user"])
    return message_data


def create_message(user: Mapping[str, Any]) -> Mapping[str, Any]:
    """Creates a card message with the user's avatar.

    Args:
        Mapping[str, Any] user: The user who sent the message.

    Returns:
        Mapping[str, Any]: a card with the user's avatar.
    """
    display_name = user.get("displayName", "")
    avatar_url = user.get("avatarUrl", "")

    return {
        "text": "Here's your avatar",
        "cardsV2": [
            {
                "cardId": "avatarCard",
                "card": {
                    "name": "Avatar Card",
                    "header": {"title": f"Hello {display_name}!"},
                    "sections": [
                        {
                            "widgets": [
                                {"textParagraph": {"text": "Your avatar picture:"}},
                                {"image": {"imageUrl": avatar_url}},
                            ]
                        }
                    ],
                },
            }
        ],
    }

Нажмите Сохранить и повторно развернуть.

Java

В Google API Console перейдите на страницу Cloud Run:

Перейти в Cloud Run

Убедитесь, что выбран проект для приложения Chat.
Нажмите Написать функцию.
На странице Создать сервис настройте функцию:
1. В поле Название сервиса введите quickstartchatapp.
2. В списке Регион выберите регион.
3. В списке Среда выполнения выберите последнюю версию Java.
4. В разделе Аутентификация выберите Требовать аутентификацию.
5. Нажмите Создать и подождите, пока Cloud Run создаст сервис. Консоль перенаправит вас на вкладку Источник.

На вкладке Источник:

В поле Точка входа удалите текст по умолчанию и введите App.
Переименуйте src/main/java/com/example/Example.java в src/main/java/AvatarApp.java.

Замените содержимое AvatarApp.java следующим кодом:

java/avatar-app/src/main/java/AvatarApp.java

Посмотреть на GitHub

import com.google.api.services.chat.v1.model.CardWithId;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1Card;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1CardHeader;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1Image;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1Section;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1TextParagraph;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1Widget;
import com.google.api.services.chat.v1.model.Message;
import com.google.api.services.chat.v1.model.User;
import com.google.cloud.functions.HttpFunction;
import com.google.cloud.functions.HttpRequest;
import com.google.cloud.functions.HttpResponse;
import com.google.gson.Gson;
import com.google.gson.JsonObject;
import java.util.List;

public class AvatarApp implements HttpFunction {
  private static final Gson gson = new Gson();

  // Command IDs (configure these in Google Chat API)
  private static final int ABOUT_COMMAND_ID = 1; // ID for the "/about" slash command
  private static final int HELP_COMMAND_ID = 2; // ID for the "Help" quick command

  @Override
  public void service(HttpRequest request, HttpResponse response) throws Exception {
    JsonObject event = gson.fromJson(request.getReader(), JsonObject.class);

    if (event.has("appCommandMetadata")) {
      handleAppCommands(event, response);
    } else {
      handleRegularMessage(event, response);
    }
  }

  /**
   * Handles slash and quick commands.
   *
   * @param event    The Google Chat event.
   * @param response The HTTP response object.
   */
  private void handleAppCommands(JsonObject event, HttpResponse response) throws Exception {
    int appCommandId = event.getAsJsonObject("appCommandMetadata").get("appCommandId").getAsInt();

    switch (appCommandId) {
      case ABOUT_COMMAND_ID:
        Message aboutMessage = new Message();
        aboutMessage.setText("The Avatar app replies to Google Chat messages.");
        aboutMessage.setPrivateMessageViewer(new User()
            .setName(event.getAsJsonObject("user").get("name").getAsString()));
        response.getWriter().write(gson.toJson(aboutMessage));
        return;
      case HELP_COMMAND_ID:
        Message helpMessage = new Message();
        helpMessage.setText("The Avatar app replies to Google Chat messages.");
        helpMessage.setPrivateMessageViewer(new User()
            .setName(event.getAsJsonObject("user").get("name").getAsString()));
        response.getWriter().write(gson.toJson(helpMessage));
        return;
    }
  }

  /**
   * Handles regular messages (not commands).
   *
   * @param event    The Google Chat event.
   * @param response The HTTP response object.
   */
  private void handleRegularMessage(JsonObject event, HttpResponse response) throws Exception {

    if (!event.has("user")) {
      response.getWriter().write("Invalid request.");
      return;
    }

    JsonObject user = event.getAsJsonObject("user");
    String displayName = user.has("displayName") ? user.get("displayName").getAsString() : "";
    String avatarUrl = user.has("avatarUrl") ? user.get("avatarUrl").getAsString() : "";
    Message message = createMessage(displayName, avatarUrl);
    response.getWriter().write(gson.toJson(message));
  }

  /**
   * Creates a card message with the user's avatar.
   *
   * @param displayName The user's display name.
   * @param avatarUrl   The URL of the user's avatar.
   * @return The card message object.
   */
  private Message createMessage(String displayName, String avatarUrl) {
    return new Message()
        .setText("Here's your avatar")
        .setCardsV2(List.of(new CardWithId()
            .setCardId("avatarCard")
            .setCard(new GoogleAppsCardV1Card()
                .setName("Avatar Card")
                .setHeader(new GoogleAppsCardV1CardHeader()
                    .setTitle(String.format("Hello %s!", displayName)))
                .setSections(List.of(new GoogleAppsCardV1Section().setWidgets(List.of(
                    new GoogleAppsCardV1Widget()
                        .setTextParagraph(new GoogleAppsCardV1TextParagraph()
                            .setText("Your avatar picture:")),
                    new GoogleAppsCardV1Widget()
                        .setImage(new GoogleAppsCardV1Image().setImageUrl(avatarUrl)))))))));
  }
}

Замените содержимое pom.xml следующим кодом:

java/avatar-app/pom.xml

Посмотреть на GitHub

<project xmlns="http://maven.apache.org/POM/4.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>gcfv2</groupId>
  <artifactId>avatar-app</artifactId>
  <version>0.0.1</version>
  <name>Avatar App</name>

  <properties>
    <maven.compiler.release>21</maven.compiler.release>
  </properties>

  <dependencies>
    <dependency>
      <groupId>com.google.cloud.functions</groupId>
      <artifactId>functions-framework-api</artifactId>
      <version>1.1.4</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/com.google.code.gson/gson -->
    <dependency>
      <groupId>com.google.code.gson</groupId>
      <artifactId>gson</artifactId>
      <version>2.12.1</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/com.google.apis/google-api-services-chat -->
    <dependency>
      <groupId>com.google.apis</groupId>
      <artifactId>google-api-services-chat</artifactId>
      <version>v1-rev20250116-2.0.0</version>
    </dependency>

  </dependencies>

</project>

Нажмите Сохранить и повторно развернуть.

Как разрешить Google Chat вызывать вашу функцию

Чтобы разрешить Google Chat вызывать вашу функцию, добавьте сервисный аккаунт Google Chat с ролью Вызывающий Cloud Run:

В Google API Console перейдите на страницу Cloud Run:

Перейти в Cloud Run
В списке сервисов Cloud Run установите флажок рядом с функцией получения. (не нажимайте на саму функцию).
Нажмите Разрешения. Откроется панель Разрешения.
Нажмите Добавить субъекта.
В поле Новые субъекты введите chat@system.gserviceaccount.com.
В поле Выберите роль выберите Cloud Run > Вызывающий Cloud Run.
Нажмите Сохранить.

Как настроить приложение Chat, которое не является дополнением

После того как функция Cloud Run будет развернута, выполните следующие действия, чтобы превратить ее в приложение Chat, которое не является дополнением:

В Google API Console перейдите на страницу Cloud Run:

Перейти в Cloud Run

Убедитесь, что выбран проект, для которого вы включили Cloud Run.
В списке сервисов нажмите quickstartchatapp.
На странице Сведения о сервисе скопируйте URL функции.
Найдите "Google Chat API", нажмите Google Chat API и выберите Управление.

Перейти к Chat API
Нажмите Настройки и настройте приложение Chat, которое не является дополнением:
1. Снимите флажок Создать это приложение Chat как дополнение Google Workspace. Откроется диалоговое окно с запросом на подтверждение. В диалоговом окне нажмите Отключить.
2. В поле Название приложения введите Quickstart App.
3. В поле URL аватара введите https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png.
4. В поле Описание введите Quickstart app.
5. В разделе Функциональность выберите Присоединяться к чат-группам и групповым чатам.
6. В разделе Настройки подключения выберите URL конечной точки HTTP.
7. В разделе Триггеры выберите Использовать общий URL конечной точки HTTP для всех триггеров и вставьте URL триггера функции Cloud Run в поле.
8. В разделе Видимость выберите Сделать это приложение Chat доступным для определенных пользователей и групп в вашем домене и введите свой адрес электронной почты.
9. В разделе Журналы выберите Регистрировать ошибки в Logging.
Нажмите Сохранить.

Как создать приложение Google Chat на основе HTTP Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

Цели

Требования

Как настроить среду

Как создать и развернуть функцию Cloud Run

Node.js

Python

Java

Как настроить приложение Chat

Как разрешить Google Chat вызывать вашу функцию

Как протестировать приложение Chat

Устранение неполадок

Организовать

Статьи по теме

Приложения Chat, не являющиеся дополнениями: создание HTTP-приложения Google Chat

Как создать и развернуть функцию Cloud Run для приложения Chat, которое не является дополнением

Node.js

Python

Java

Как разрешить Google Chat вызывать вашу функцию

Как настроить приложение Chat, которое не является дополнением

Как создать приложение Google Chat на основе HTTP