Masz 5 minut? Pomóż nam ulepszać dokumentację Google Chat dla deweloperów, wypełniając krótką ankietę.

Tworzenie aplikacji Google Chat za pomocą Google Cloud Functions

Z tego artykułu dowiesz się, jak utworzyć aplikację w Google Chat i korzystać z niej za pomocą Google Cloud Functions.

Aby utworzyć aplikację do obsługi czatu, napisz i wdróż funkcję w Cloud Functions, za pomocą której aplikacja do obsługi czatu odpowiada na wiadomość użytkownika. Odpowiedź aplikacji do obsługi czatu zawiera wiadomość z kartą zawierającą imię i nazwisko nadawcy oraz obraz awatara, jak na tym obrazie:

Aplikacja do obsługi czatu odpowiada, wysyłając kartę z wyświetlaną nazwą nadawcy i obrazem awatara

Cele

  • skonfigurować środowisko,
  • tworzenie i wdrażanie funkcji w Cloud Functions.
  • Opublikuj aplikację w Google Chat.
  • przetestować aplikację,

Wymagania wstępne

  • Konto Google Workspace z dostępem do Google Chat w organizacji Google Workspace, które zezwala na nieuwierzytelnione wywołania funkcji Google Cloud Functions.

Konfigurowanie środowiska

Zanim zaczniesz korzystać z interfejsów API Google, musisz włączyć je w projekcie Google Cloud. Możesz włączyć 1 lub więcej interfejsów API w pojedynczym projekcie Google Cloud.
  • W konsoli Google Cloud włącz interfejsy Google Chat API, Cloud Build API, Cloud Functions API, Cloud Pub/Sub API oraz Cloud Logging API.

    Włączanie interfejsów API

Tworzenie i wdrażanie funkcji w Cloud Functions

utworzyć i wdrożyć funkcję w Cloud Functions, która generuje kartę czatu z wyświetlaną nazwą nadawcy i obrazem awatara; Gdy aplikacja Google Chat otrzyma wiadomość, uruchamia funkcję i odpowiada za pomocą karty.

Aby utworzyć i wdrożyć funkcję dla aplikacji do obsługi czatu, wykonaj te czynności:

Node.js

  1. W konsoli Google Cloud otwórz stronę Cloud Functions:

    Otwórz Cloud Functions

    Wybierz projekt aplikacji do obsługi czatu.

  2. Kliknij Utwórz funkcję.

  3. Na stronie Utwórz funkcję skonfiguruj funkcję:

    1. W polu Nazwa funkcji wpisz „QuickStartChatApp”.
    2. W sekcji Typ reguły kliknij HTTP.
    3. W sekcji Uwierzytelnianie wybierz Zezwalaj na nieuwierzytelnione wywołania.

      Więcej informacji o uwierzytelnianiu w Google Workspace znajdziesz w artykule Uwierzytelnianie i autoryzowanie aplikacji do obsługi czatu oraz żądań do interfejsu API.

    4. Kliknij Zapisz.

    5. Kliknij Dalej.

  4. W sekcji Środowisko wykonawcze wybierz Node.js 10.

  5. W sekcji Kod źródłowy wybierz Edytor wbudowany.

  6. W sekcji Punkt wejścia usuń domyślny tekst i wpisz helloChat.

  7. Zamień zawartość pliku index.js na ten kod:

    węzeł/awatar-app/index.js
    /**
     * Google Cloud Function that responds to messages sent from a
     * Google Chat room.
     *
     * @param {Object} req Request sent from Google Chat room
     * @param {Object} res Response to send back
     */
    exports.helloChat = function helloChat(req, res) {
      if (req.method === 'GET' || !req.body.message) {
        res.send('Hello! This function is meant to be used in a Google Chat ' +
          'Room.');
      }
    
      const sender = req.body.message.sender.displayName;
      const image = req.body.message.sender.avatarUrl;
    
      const data = createMessage(sender, image);
    
      res.send(data);
    };
    
    /**
     * Creates a card with two widgets.
     * @param {string} displayName the sender's display name
     * @param {string} imageUrl the URL for the sender's avatar
     * @return {Object} a card with the user's avatar.
     */
    function createMessage(displayName, imageUrl) {
      const cardHeader = {
        title: `Hello ${displayName}!`,
      };
    
      const avatarWidget = {
        textParagraph: {text: 'Your avatar picture: '},
      };
    
      const avatarImageWidget = {
        image: {imageUrl},
      };
    
      const avatarSection = {
        widgets: [
          avatarWidget,
          avatarImageWidget,
        ],
      };
    
      return {
        cardsV2: [{
          cardId: 'avatarCard',
          card: {
            name: 'Avatar Card',
            header: cardHeader,
            sections: [avatarSection],
          }
        }],
      };
    }

  8. Kliknij Wdróż.

Python

  1. W konsoli Google Cloud otwórz stronę Cloud Functions:

    Otwórz Cloud Functions

    Wybierz projekt aplikacji do obsługi czatu.

  2. Kliknij Utwórz funkcję.

  3. Na stronie Utwórz funkcję skonfiguruj funkcję:

    1. W polu Nazwa funkcji wpisz „QuickStartChatApp”.
    2. W sekcji Typ reguły kliknij HTTP.
    3. W sekcji Uwierzytelnianie wybierz Zezwalaj na nieuwierzytelnione wywołania.

      Więcej informacji o uwierzytelnianiu w Google Workspace znajdziesz w artykule Uwierzytelnianie i autoryzowanie aplikacji do obsługi czatu oraz żądań do interfejsu API.

    4. Kliknij Zapisz.

    5. Kliknij Dalej.

  4. W sekcji Środowisko wykonawcze wybierz Python 3.10.

  5. W sekcji Kod źródłowy wybierz Edytor wbudowany.

  6. W sekcji Punkt wejścia usuń domyślny tekst i wpisz hello_chat.

  7. Zamień zawartość pliku main.py na ten kod:

    python/awatar-app/main.py
    from typing import Any, Mapping
    
    import flask
    import functions_framework
    
    
    # Google Cloud Function that responds to messages sent in
    # Google Chat.
    #
    # @param {Object} req Request sent from Google Chat.
    # @param {Object} res Response to send back.
    @functions_framework.http
    def hello_chat(req: flask.Request) -> Mapping[str, Any]:
      if req.method == "GET":
        return "Hello! This function must be called from Google Chat."
    
      request_json = req.get_json(silent=True)
    
      display_name = request_json["message"]["sender"]["displayName"]
      avatar = request_json["message"]["sender"]["avatarUrl"]
    
      response = create_message(name=display_name, image_url=avatar)
    
      return response
    
    
    # Creates a card with two widgets.
    # @param {string} name the sender's display name.
    # @param {string} image_url the URL for the sender's avatar.
    # @return {Object} a card with the user's avatar.
    def create_message(name: str, image_url: str) -> Mapping[str, Any]:
      avatar_image_widget = {"image": {"imageUrl": image_url}}
      avatar_text_widget = {"textParagraph": {"text": "Your avatar picture:"}}
      avatar_section = {"widgets": [avatar_text_widget, avatar_image_widget]}
    
      header = {"title": f"Hello {name}!"}
    
      cards = {
          "cardsV2": [
              {
                  "cardId": "avatarCard",
                  "card": {
                      "name": "Avatar Card",
                      "header": header,
                      "sections": [avatar_section],
                  },
              }
          ]
      }
    
      return cards
    
    

  8. Kliknij Wdróż.

Java

  1. W konsoli Google Cloud otwórz stronę Cloud Functions:

    Otwórz Cloud Functions

    Wybierz projekt aplikacji do obsługi czatu.

  2. Kliknij Utwórz funkcję.

  3. Na stronie Utwórz funkcję skonfiguruj funkcję:

    1. W polu Nazwa funkcji wpisz „QuickStartChatApp”.
    2. W sekcji Typ reguły kliknij HTTP.
    3. W sekcji Uwierzytelnianie wybierz Zezwalaj na nieuwierzytelnione wywołania.

      Więcej informacji o uwierzytelnianiu w Google Workspace znajdziesz w artykule Uwierzytelnianie i autoryzowanie żądań aplikacji do obsługi czatu oraz żądań do interfejsu API.

    4. Kliknij Zapisz.

    5. Kliknij Dalej.

  4. W sekcji Środowisko wykonawcze wybierz Java 11.

  5. W sekcji Kod źródłowy wybierz Edytor wbudowany.

  6. W sekcji Punkt wejścia usuń domyślny tekst i wpisz HelloChat.

  7. Zmień nazwę src/main/java/com/example/Example.java na src/main/java/HelloChat.java.

  8. Zamień zawartość pliku HelloChat.java na ten kod:

    java/avatar-app/src/main/java/HelloChat.java.
    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 HelloChat implements HttpFunction {
      private static final Gson gson = new Gson();
    
      @Override
      public void service(HttpRequest request, HttpResponse response) throws Exception {
        JsonObject body = gson.fromJson(request.getReader(), JsonObject.class);
    
        if (request.getMethod().equals("GET") || !body.has("message")) {
          response.getWriter().write("Hello! This function must be called from Google Chat.");
          return;
        }
    
        JsonObject sender = body.getAsJsonObject("message").getAsJsonObject("sender");
        String displayName = sender.has("displayName") ? sender.get("displayName").getAsString() : "";
        String avatarUrl = sender.has("avatarUrl") ? sender.get("avatarUrl").getAsString() : "";
        Message message = createMessage(displayName, avatarUrl);
    
        response.getWriter().write(gson.toJson(message));
      }
    
      Message createMessage(String displayName, String avatarUrl) {
        GoogleAppsCardV1CardHeader cardHeader = new GoogleAppsCardV1CardHeader();
        cardHeader.setTitle(String.format("Hello %s!", displayName));
    
        GoogleAppsCardV1TextParagraph textParagraph = new GoogleAppsCardV1TextParagraph();
        textParagraph.setText("Your avatar picture: ");
    
        GoogleAppsCardV1Widget avatarWidget = new GoogleAppsCardV1Widget();
        avatarWidget.setTextParagraph(textParagraph);
    
        GoogleAppsCardV1Image image = new GoogleAppsCardV1Image();
        image.setImageUrl(avatarUrl);
    
        GoogleAppsCardV1Widget avatarImageWidget = new GoogleAppsCardV1Widget();
        avatarImageWidget.setImage(image);
    
        GoogleAppsCardV1Section section = new GoogleAppsCardV1Section();
        section.setWidgets(List.of(avatarWidget, avatarImageWidget));
    
        GoogleAppsCardV1Card card = new GoogleAppsCardV1Card();
        card.setName("Avatar Card");
        card.setHeader(cardHeader);
        card.setSections(List.of(section));
    
        CardWithId cardWithId = new CardWithId();
        cardWithId.setCardId("previewLink");
        cardWithId.setCard(card);
    
        Message message = new Message();
        message.setCardsV2(List.of(cardWithId));
    
        return message;
      }
    }

  9. Zamień zawartość pliku pom.xml na ten kod:

    java/avatar-app/pom.xml
    <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>cloudfunctions</groupId>
      <artifactId>http-function</artifactId>
      <version>1.0-SNAPSHOT</version>
    
      <properties>
        <maven.compiler.target>11</maven.compiler.target>
        <maven.compiler.source>11</maven.compiler.source>
      </properties>
    
      <dependencies>
        <dependency>
          <groupId>com.google.cloud.functions</groupId>
          <artifactId>functions-framework-api</artifactId>
          <version>1.0.1</version>
        </dependency>
    
        <!-- https://mvnrepository.com/artifact/com.google.code.gson/gson -->
        <dependency>
            <groupId>com.google.code.gson</groupId>
            <artifactId>gson</artifactId>
            <version>2.9.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-rev20230115-2.0.0</version>
        </dependency>
      </dependencies>
    
      <!-- Required for Java 11 functions in the inline editor -->
      <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>

  10. Kliknij Wdróż.

Otworzy się strona Cloud Functions, a obok jej nazwy pojawi się wskaźnik postępu wdrożenia. Gdy wskaźnik postępu zniknie i pojawi się znacznik wyboru, funkcja zostanie wdrożona.

Publikowanie aplikacji w Google Chat

Po wdrożeniu funkcji w Cloud Functions wykonaj te czynności, aby przekształcić ją w aplikację Google Chat:

  1. W konsoli Google Cloud kliknij Menu > Cloud Functions.

    Otwórz Cloud Functions

    Sprawdź, czy wybrany jest projekt, w którym włączono Cloud Functions.

  2. Na liście funkcji kliknij QuickStartChatApp.

  3. Na stronie Szczegóły funkcji kliknij Wyzwalacz.

  4. W sekcji URL reguły skopiuj adres URL.

  5. Wyszukaj „Google Chat API” i kliknij Google Chat API, a następnie kliknij Zarządzaj.

    Otwórz interfejs Chat API

  6. Kliknij Konfiguracja i skonfiguruj aplikację Google Chat:

    1. W polu Nazwa aplikacji wpisz Quickstart App.
    2. W polu Awatar URL wpisz https://developers.google.com/chat/images/quickstart-app-avatar.png.
    3. W polu Opis wpisz Quickstart app.
    4. W sekcji Funkcje wybierz Odbieraj wiadomości 1:1, Dołączaj do pokoi i rozmów grupowych i Rejestruj błędy w Cloud Logging.
    5. W sekcji Ustawienia połączenia wybierz URL aplikacji i wklej w polu adres URL aktywatora funkcji w Cloud Functions.
    6. W sekcji Uprawnienia wybierz Określone osoby i grupy w Twojej domenie i wpisz swój adres e-mail.
  7. Kliknij Zapisz.

Aplikacja jest gotowa do odbierania wiadomości w Google Chat i odpowiadania na nie.

Testowanie aplikacji do obsługi czatu

Aby przetestować aplikację Google Chat, wyślij do niej wiadomość na czacie:

  1. Otwórz Google Chat.
  2. Aby wysłać wiadomość na czacie do aplikacji, kliknij Rozpocznij czat , a następnie w wyświetlonym oknie kliknij Znajdź aplikacje.
  3. W oknie Znajdź aplikacje wyszukaj „Aplikacja Quickstart”.
  4. Aby otworzyć czat z aplikacją, znajdź aplikację z krótkim wprowadzeniem i kliknij Dodaj > Czat.
  5. Na czacie wpisz Hello i naciśnij enter.

Aplikacja wyświetli kartę z Twoją wyświetlaną nazwą i zdjęciem awatara.

Rozwiązywanie problemów

Aby dowiedzieć się, jak rozwiązywać problemy z aplikacją Google Chat i je debugować, przeczytaj artykuł Rozwiązywanie problemów z aplikacją Google Chat i jej naprawianie.

Aby dodać więcej funkcji do aplikacji do obsługi czatu, zapoznaj się z tymi przewodnikami:

  • Twórz karty interaktywne – wiadomości kart mogą mieć zdefiniowany układ, interaktywne elementy interfejsu (np. przyciski) i multimedia (np. obrazy). Komunikaty kart służą do prezentowania szczegółowych informacji, zbierania informacji od użytkowników i zachęcania ich do wykonania kolejnych kroków.
  • Obsługa poleceń rozpoczynających się ukośnikiem – polecenia po ukośniku pozwalają rejestrować i reklamować konkretne polecenia, które użytkownicy mogą wydać aplikacji, wpisując polecenie rozpoczynające się od ukośnika (/), np. /help.
  • Okna uruchamiania – są to okna oparte na kartach, które aplikacja może otworzyć, aby wchodzić w interakcję z użytkownikiem. Możesz układać kilka kart obok siebie, co ułatwia użytkownikom wykonywanie wieloetapowych procesów, takich jak wypełnianie danych w formularzu.

Więcej informacji o Google Chat API znajdziesz w dokumentacji referencyjnej.