이 페이지는 Cloud Translation API를 통해 번역되었습니다.

Google Chat 앱 명령어에 응답

이 페이지에서는 Google Chat 앱으로 명령어를 설정하고 응답하는 방법을 설명합니다.

명령어는 사용자가 Chat 앱의 주요 기능을 찾고 사용하는 데 도움이 됩니다. Chat 앱만 명령어의 콘텐츠를 볼 수 있습니다. 예를 들어 사용자가 슬래시 명령어와 함께 메시지를 보내면 메시지는 사용자와 Chat 앱에만 표시됩니다.

명령어를 빌드해야 하는지 결정하고 사용자 상호작용을 설계하는 방법을 알아보려면 모든 사용자 여정 정의를 참고하세요.

Chat 앱 명령어 유형

Chat 앱 명령어를 슬래시 명령어 또는 빠른 명령어로 빌드할 수 있습니다. 각 유형의 명령어를 찾아서 사용하려면 다음 단계를 따르세요.

슬래시 명령어: 사용자가 슬래시(/)와 사전 정의된 텍스트(예: /about)를 입력하여 명령어를 메시지로 전송합니다. 채팅 앱에서 슬래시 명령어의 인수 텍스트가 필요할 수도 있습니다. 예를 들어 슬래시 명령어 /search에는 검색어에 사용되는 인수 텍스트가 필요할 수 있습니다.
빠른 명령어: 사용자는 Chat 메시지의 답장 영역에서 메뉴를 열어 명령어를 사용합니다. 명령어를 사용하려면 추가 를 클릭하고 메뉴에서 명령어를 선택합니다.

다음 이미지는 사용자가 슬래시 명령어 및 빠른 명령어 메뉴를 찾는 방법을 보여줍니다.

그림 1. 사용자는 답장 영역에 슬래시 /를 입력한 후 명령어 이름을 입력하여 슬래시 명령어를 찾고 사용합니다.
그림 2. 사용자는 Chat 메시지의 답장 영역에서 메뉴를 찾아 빠른 명령어를 사용합니다.

기본 요건

Node.jsApps ScriptPython자바

대화형 기능이 사용 설정된 Google Chat 앱 HTTP 서비스를 사용하여 대화형 Chat 앱을 만들려면 이 빠른 시작을 완료하세요.

대화형 기능이 사용 설정된 Google Chat 앱 Apps Script에서 양방향 Chat 앱을 만들려면 이 빠른 시작을 완료하세요.

대화형 기능이 사용 설정된 Google Chat 앱 HTTP 서비스를 사용하여 대화형 Chat 앱을 만들려면 이 빠른 시작을 완료하세요.

명령어 설정

이 섹션에서는 다음 단계를 완료하여 명령어를 설정하는 방법을 설명합니다.

명령어의 이름과 설명을 만듭니다.
Google Cloud 콘솔에서 명령어를 구성합니다.

명령어 이름 지정 및 설명

명령어 이름은 사용자가 Chat 앱을 호출하기 위해 입력하거나 선택하는 이름입니다. 이름 아래에는 명령어 사용 방법을 사용자에게 자세히 안내하는 짧은 설명도 표시됩니다.

슬래시 명령어 이름 및 설명 — **그림 3**: 슬래시 명령어의 이름 및 설명입니다.

명령어의 이름과 설명을 선택할 때는 다음 권장사항을 고려하세요.

명령어에 이름을 지정하려면 다음 단계를 따르세요.

짧고 설명적이고 실행 가능한 단어 또는 문구를 사용하여 명령어를 사용자에게 명확하게 전달합니다. 예를 들어 Create a reminder 이름 대신 Remind me을 사용합니다.
명령어에 고유한 이름이나 일반적인 이름을 사용하는 것이 좋습니다. 명령어가 일반적인 상호작용이나 기능을 설명하는 경우 사용자가 인식하고 예상하는 일반적인 이름(예: Settings 또는 Feedback)을 사용할 수 있습니다. 그렇지 않은 경우 고유한 명령어 이름을 사용하세요. 다른 Chat 앱에서 명령어 이름이 동일하면 사용자가 유사한 명령어를 필터링하여 내 명령어를 찾아야 하기 때문입니다.

명령어를 설명하려면 다음 단계를 따르세요.

사용자가 명령어를 사용할 때 어떤 결과를 얻을 수 있는지 알 수 있도록 설명을 짧고 명확하게 작성합니다.
명령어에 형식 지정 요구사항이 있는지 사용자에게 알립니다. 예를 들어 인수 텍스트가 필요한 슬래시 명령어를 만드는 경우 설명을 Remind me to do [something] at [time]과 같이 설정합니다.
Chat 앱이 스페이스의 모든 사용자에게 답장하는지 아니면 명령어를 호출한 사용자에게 비공개로 답장하는지 사용자에게 알립니다. 예를 들어 빠른 명령어 About는 Learn about this app (Only visible to you)로 설명할 수 있습니다.

Google Cloud 콘솔에서 명령어 구성

슬래시 또는 빠른 명령어를 만들려면 Google Chat API용 Chat 앱 구성에서 명령어에 관한 정보를 지정합니다.

Google Chat API에서 명령어를 구성하려면 다음 단계를 완료하세요.

Google Cloud 콘솔에서 메뉴 > API 및 서비스 > 사용 설정된 API 및 서비스 > Google Chat API를 클릭합니다.

Google Chat API 페이지로 이동
구성을 클릭합니다.
명령어에서 명령어 추가를 클릭합니다.
명령어의 명령어 ID, 이름, 설명, 명령어 유형을 입력합니다.
- 명령어 ID: Chat 앱에서 명령어를 인식하고 응답을 반환하는 데 사용하는 1~1,000 사이의 숫자입니다.
- 이름: 명령어의 표시 이름입니다. 이름은 최대 50자(영문 기준)까지 지정할 수 있으며 특수문자를 포함할 수 있습니다.
- 설명: 명령어의 기능을 설명하는 텍스트입니다. 설명은 최대 50자(영문 기준)까지 입력할 수 있으며 특수문자를 포함할 수 있습니다.
- 명령어 유형: 빠른 명령어 또는 슬래시 명령어를 선택합니다.
- 슬래시 명령어를 구성하는 경우 슬래시 명령어 이름 필드에 값을 입력하여 사용자가 명령어를 호출할 때 입력할 문자를 지정합니다. 슬래시로 시작해야 하며 텍스트만 포함할 수 있고 최대 50자(영문 기준)여야 합니다. 예를 들면 다음과 같습니다. /remindMe
선택사항: 채팅 앱이 대화상자로 명령어에 응답하도록 하려면 대화상자 열기 체크박스를 선택합니다.
저장을 클릭합니다.

이제 명령어가 Chat 앱에 맞게 구성되었습니다.

명령어에 응답

사용자가 명령어를 사용하면 Chat 앱은 상호작용 이벤트를 수신합니다. 이벤트 페이로드에는 적절한 응답을 반환할 수 있도록 호출된 명령어에 관한 세부정보 (명령어 ID 및 명령어 유형 포함)가 포함된 메타데이터가 포함됩니다.

Cymbal Labs Chat 앱을 위한 비공개 메시지입니다. 이 메시지에는 Chat 앱이 Cymbal Labs에서 만들었다고 안내하고 문서 링크와 지원팀에 문의할 수 있는 링크를 공유합니다. — Chat 앱이 슬래시 명령어 `/help`에 비공개로 응답하여 지원을 받는 방법을 설명합니다.

각 유형의 명령어에 응답하려면 이벤트 페이로드에서 다양한 이벤트 유형과 메타데이터 객체를 처리해야 합니다.

명령어 유형	이벤트 유형	명령어 메타데이터
슬래시 명령어	`MESSAGE`	`message.slashCommand` 또는 `message.annotation.slashCommand`
빠른 명령어	`APP_COMMAND`	`appCommandMetadata`

메시지로 명령어에 응답하는 방법을 알아보려면 다음 섹션을 참고하세요.

슬래시 명령어에 응답

다음 코드는 슬래시 명령어 /about에 응답하는 Chat 앱의 예를 보여줍니다. Chat 앱은 MESSAGE 상호작용 이벤트를 처리하고, 상호작용 이벤트에 일치하는 명령어 ID가 포함되어 있는지 감지하고, 비공개 메시지를 반환합니다.

Node.js Apps Script Python 자바

node/avatar-app/index.js

GitHub에서 보기

/**
 * 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.'
      });
  }
}

apps-script/avatar-app/avatar-app.gs

GitHub에서 보기

// 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/avatar-app/main.py

GitHub에서 보기

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 {}

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

GitHub에서 보기

/**
 * 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;
  }
}

ABOUT_COMMAND_ID를 Google Cloud 콘솔에서 명령어를 구성할 때 지정한 명령어 ID로 바꿉니다.

빠른 명령어에 응답

다음 코드는 빠른 명령어 도움말에 응답하는 Chat 앱의 예를 보여줍니다. Chat 앱은 APP_COMMAND 상호작용 이벤트를 처리하고, 상호작용 이벤트에 일치하는 명령어 ID가 포함되어 있는지 감지하고, 비공개 메시지를 반환합니다.

Node.js Apps Script Python 자바

node/avatar-app/index.js

GitHub에서 보기

/**
 * 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.'
      });
  }
}

apps-script/avatar-app/avatar-app.gs

GitHub에서 보기

// 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/avatar-app/main.py

GitHub에서 보기

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 {}

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

GitHub에서 보기

/**
 * 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;
  }
}

HELP_COMMAND_ID를 Google Cloud 콘솔에서 명령어를 구성할 때 지정한 명령어 ID로 바꿉니다.

명령어 테스트

명령어와 코드를 테스트하려면 Google Chat 앱의 양방향 기능 테스트를 참고하세요.

Chat UI에서 명령어를 테스트하고 사용하는 방법을 알아보려면 Google Chat 도움말 문서의 Google Chat에서 앱 사용하기를 참고하세요.

Google Chat 앱 명령어에 응답

Chat 앱 명령어 유형

기본 요건

명령어 설정

명령어 이름 지정 및 설명

명령어에 이름을 지정하려면 다음 단계를 따르세요.

명령어를 설명하려면 다음 단계를 따르세요.

Google Cloud 콘솔에서 명령어 구성

명령어에 응답

슬래시 명령어에 응답

빠른 명령어에 응답

명령어 테스트

관련 주제