Odpowiadanie na polecenia po ukośniku jako aplikacja Google Chat

Na tej stronie dowiesz się, jak skonfigurować polecenia po ukośniku w aplikacji Google Chat.

Polecenie po ukośniku to powszechny sposób wywoływania aplikacji do obsługi czatu i wchodzenia z nią w interakcję. Pozwalają też użytkownikom odkrywać i korzystać z kluczowych funkcji tej aplikacji.

Aby użyć polecenia po ukośniku, użytkownicy wpisują ukośnik (/), a następnie krótkie polecenie tekstowe, takie jak /about, aby uzyskać informacje o aplikacji Chat. Użytkownicy mogą odkryć dostępne polecenia po ukośniku, wpisując ukośnik w Google Chat. Spowoduje to wyświetlenie okna z listą dostępnych poleceń w aplikacji Chat:

Okno polecenia po ukośniku
Rysunek 1. Okno wyświetlane po wpisaniu przez użytkownika ukośnika w Google Chat.

Aby zdecydować, czy warto skonfigurować polecenia po ukośniku, i dowiedzieć się, jak projektować interakcje użytkowników, zobaczyć Definiowanie wszystkich ścieżek użytkowników

Polecenia po ukośniku z prywatnymi odpowiedziami

Gdy użytkownik wyśle wiadomość zawierającą polecenie po ukośniku, będzie ona widoczna tylko dla niego i aplikacji Google Chat. Jeśli aplikacja Google Chat została dodana do pokoju z wieloma osobami, możesz odpowiedzieć na polecenie po ukośniku prywatnie, aby zachować prywatność interakcji między użytkownikiem a aplikacją Google Chat.

Aby na przykład dowiedzieć się więcej o aplikacji do obsługi czatu, do odkrywania w pokoju, użytkownicy mogą używać poleceń takich jak /about lub /help. Aby uniknąć powiadamiania wszystkich innych osób w przestrzeni, aplikacja Google Chat może odpowiadać prywatnie, podając informacje o tym, jak korzystać z aplikacji Google Chat i uzyskać pomoc.

Wymagania wstępne

Node.js

Aplikacja Google Chat, w której można korzystać z funkcji interaktywnych. Aby utworzyć interaktywna aplikacja do obsługi czatu przy użyciu usługi HTTP zapoznaj się z tym krótkim wprowadzeniem.

Google Apps Script

Aplikacja Google Chat, w której włączono funkcje interaktywne. Aby utworzyć z interaktywną aplikacją Google Chat w Apps Script, zapoznaj się z tym krótkim wprowadzeniem.

Python

Aplikacja Google Chat, w której można korzystać z funkcji interaktywnych. Aby utworzyć interaktywna aplikacja do obsługi czatu przy użyciu usługi HTTP zapoznaj się z tym krótkim wprowadzeniem.

Java

Aplikacja Google Chat, w której można korzystać z funkcji interaktywnych. Aby utworzyć interaktywna aplikacja do obsługi czatu przy użyciu usługi HTTP zapoznaj się z tym krótkim wprowadzeniem.

Skonfiguruj polecenie po ukośniku

W tej sekcji opisano, jak skonfigurować ukośnik: polecenie:

  1. Utwórz nazwę dla polecenia po ukośniku.
  2. Skonfiguruj polecenie po ukośniku w interfejsie Google Chat API.

Nazwij polecenie po ukośniku

Nazwa polecenia po ukośniku to to, co użytkownicy wpisują w wiadomości w Google Chat, aby wywołać tę aplikację. Pod nazwą pojawia się też krótki opis, który informuje użytkowników, jak używać polecenia:

Nazwa i opis polecenia po ukośniku
Rysunek 2. Nazwa i opis polecenia po ukośniku.

Wybierając nazwę i opis polecenia po ukośniku, weź pod uwagę następujące zalecenia:

  • Aby nadać nazwę poleceniu po ukośniku:

    • Używaj krótkich, opisowych i użytecznych słów lub wyrażeń, aby polecenia były jasne i proste dla użytkownika. Na przykład zamiast /createAReminder użyj /remindMe.
    • Jeśli polecenie składa się z więcej niż jednego słowa, ułatwij użytkownikom jego odczytanie, pisząc pierwsze słowo małymi literami, a pierwszą literę kolejnych słów – wielkimi. Na przykład zamiast /updatecontact użyj /updateContact.
    • Zastanów się, czy w poleceniu użyć unikalnej czy potocznej nazwy. Jeśli opisuje typową interakcję lub funkcję, powszechna nazwa rozpoznawalna i oczekiwana przez użytkowników, taka jak /settingslub /feedback W przeciwnym razie używaj unikalnych nazw poleceń, ponieważ jeśli jest taka sama jak w innych aplikacjach do obsługi czatu, użytkownik musi przefiltruj podobne polecenia, aby znaleźć Twoje.

  • Aby opisać polecenie po ukośniku:

    • Opis powinien być krótki i jasny, aby użytkownicy wiedzieli, czego się spodziewać, gdy wywołają polecenie.
    • Poinformuj użytkowników, czy w przypadku polecenia obowiązują jakieś wymagania dotyczące formatowania. Jeśli na przykład utworzysz polecenie /remindMe, które wymaga argumentu tekst, ustaw opis na około Remind me to do [something] at [time].
    • Poinformuj użytkowników, czy aplikacja Google Chat odpowiada na wszystkim w pokoju lub prywatnie użytkownikowi, który wywołał polecenie. Na przykład polecenie po ukośniku /about możesz opisać tak Learn about this app (Only visible to you)

Skonfiguruj polecenie po ukośniku w interfejsie Google Chat API

Aby utworzyć polecenie z ukośnikiem, musisz podać informacje o tym poleceniu w konfiguracji aplikacji Google Chat dla interfejsu Google Chat API.

Aby skonfigurować polecenie po ukośniku w interfejsie Google Chat API, wykonaj te czynności kroki:

  1. W konsoli Google Cloud kliknij Menu. > Interfejsy API i Usługi > Włączone interfejsy API i Usługi > Google Chat API

    Otwórz stronę interfejsu Google Chat API

  2. Kliknij Konfiguracja.

  3. W sekcji Polecenia po ukośniku kliknij Dodaj polecenie po ukośniku.

  4. Wpisz nazwę, identyfikator polecenia i opis:

    1. Nazwa: wyświetlana nazwa polecenia i tekst, który użytkownicy wpisują, aby wywołać aplikację. Musi zaczynać się ukośnikiem, zawierać tylko tekst i mieć maksymalnie 50 znaków.
    2. Opis: tekst opisujący sposób użycia i formatowania . Opis może mieć maksymalnie 50 znaków.
    3. Identyfikator polecenia: liczba od 1 do 1000, Aplikacja do obsługi czatu rozpoznaje polecenie po ukośniku i zwrócić odpowiedź.

  5. Opcjonalnie: jeśli chcesz, aby aplikacja Google Chat odpowiadała na polecenie za pomocą okna dialogowego, zaznacz pole wyboru Otwórz okno dialogowe.

  6. Kliknij Zapisz.

Polecenie po ukośniku zostało skonfigurowane w aplikacji Google Chat.

Odpowiadanie na polecenie po ukośniku

Gdy użytkownicy utworzą wiadomość w Google Chat zawierającą polecenie po ukośniku, Twoja aplikacja Google Chat odebrała zdarzenie interakcji MESSAGE. Ładunek zdarzenia zawiera element slashCommand i slashCommandMetadata obiektów. Te obiekty zawierają szczegóły polecenia użytego w wiadomości (w tym identyfikator polecenia), dzięki czemu możesz zwrócić odpowiednią odpowiedź.

Prywatna wiadomość dla Cymbal Labs Labs. Komunikat informuje, że Aplikacja do obsługi czatu została utworzona przez Cymbal Labs i udostępnia link do dokumentacji i linku do kontaktu z zespołem pomocy.
Aplikacja Google Chat odpowiada prywatnie na komendę /help, aby wyjaśnić, jak uzyskać pomoc.

Poniżej znajduje się przykładowy kod aplikacji Google Chat. która odpowiada na polecenie po ukośniku /about przez obsługę MESSAGE zdarzenia interakcji i wykrywanie czy wiadomość zawiera odpowiedni identyfikator polecenia. Jeśli wiadomość zawiera ciąg identyfikator polecenia, aplikacja Google Chat zwróci wiadomość prywatną:

Node.js

node/avatar-app/index.js
// Checks for the presence of a slash command in the message.
if (event.message.slashCommand) {
  // Executes the slash command logic based on its ID.
  // Slash command IDs are set in the Google Chat API configuration.
  switch (event.message.slashCommand.commandId) {
    case ABOUT_COMMAND_ID:
      return res.send({
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      });
  }
}

Google Apps Script

apps-script/avatar-app/avatar-app.gs
// Checks for the presence of a slash command in the message.
if (event.message.slashCommand) {
  // Executes the slash command logic based on its ID.
  // Slash command IDs are set in the Google Chat API configuration.
  switch (event.message.slashCommand.commandId) {
    case ABOUT_COMMAND_ID:
      return {
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      };
  }
}

Python

python/avatar-app/main.py
# Checks for the presence of a slash command in the message.
if "slashCommand" in request_json["message"]:
  # Executes the slash command logic based on its ID.
  # Slash command IDs are set in the Google Chat API configuration.
  if request_json["message"]["slashCommand"]["commandId"] == ABOUT_COMMAND_ID:
    return {
      "privateMessageViewer": request_json["user"],
      "text": 'The Avatar app replies to Google Chat messages.'
    }

Java

java/avatar-app/src/main/java/App.java
// Checks for the presence of a slash command in the message.
if (body.getAsJsonObject("message").has("slashCommand")) {
  // Executes the slash command logic based on its ID.
  // Slash command IDs are set in the Google Chat API configuration.
  JsonObject slashCommand = body.getAsJsonObject("message").getAsJsonObject("slashCommand");
  switch (slashCommand.get("commandId").getAsString()) {
    case ABOUT_COMMAND_ID:
    JsonObject aboutMessage = new JsonObject();
    aboutMessage.addProperty("text", "The Avatar app replies to Google Chat messages.");
    aboutMessage.add("privateMessageViewer", body.getAsJsonObject("user"));
      response.getWriter().write(gson.toJson(aboutMessage));
      return;
  }
}

Ustaw ABOUT_COMMAND_ID na identyfikator polecenia określony podczas konfigurowania polecenia po ukośniku w Chat API. Aby przetestować ten kod, zobacz Testowanie funkcji interaktywnych w aplikacjach Google Chat