Trả lời các lệnh dấu gạch chéo trong ứng dụng Google Chat

Trang này giải thích cách thiết lập và phản hồi lệnh dấu gạch chéo cho Ứng dụng Google Chat.

Lệnh gạch chéo là một cách phổ biến mà người dùng gọi và tương tác với Ứng dụng Chat. Lệnh dấu gạch chéo cũng giúp người dùng khám phá và sử dụng các tính năng chính của ứng dụng Chat.

Để sử dụng lệnh dấu gạch chéo, người dùng nhập dấu gạch chéo (/) rồi nhập một lệnh văn bản ngắn, chẳng hạn như /about để nhận thông tin về ứng dụng Chat. Người dùng có thể khám phá các lệnh dấu gạch chéo hiện có bằng cách nhập dấu gạch chéo vào Google Chat. Thao tác này sẽ hiển thị một cửa sổ liệt kê các lệnh hiện có cho ứng dụng Chat:

Để quyết định xem bạn có nên thiết lập lệnh dấu gạch chéo hay không và để biết cách thiết kế tương tác người dùng, xem Xác định tất cả hành trình của người dùng.

Lệnh dấu gạch chéo có phản hồi riêng tư

Khi người dùng gửi thông báo có chứa lệnh dấu gạch chéo, thông báo đó sẽ chỉ mà người dùng và ứng dụng Chat nhìn thấy. Nếu bạn đã thiết lập để ứng dụng Chat thêm vào không gian với nhiều người, bạn có thể cân nhắc phản hồi lệnh dấu gạch chéo tính riêng tư, để đảm bảo tính riêng tư cho hoạt động tương tác giữa người dùng và Ứng dụng Chat.

Ví dụ: để tìm hiểu về một ứng dụng Chat mà họ khám phá trong một không gian, người dùng có thể sử dụng các lệnh như /about hoặc /help. Để tránh thông báo cho mọi người khác trong không gian, ứng dụng Chat có thể phản hồi riêng tư bằng thông tin về cách sử dụng ứng dụng Chat và cách yêu cầu hỗ trợ.

Điều kiện tiên quyết

Thiết lập lệnh dấu gạch chéo

Phần này giải thích cách hoàn thành các bước sau để thiết lập dấu gạch chéo :

1. Tạo tên cho lệnh dấu gạch chéo.
2. Định cấu hình lệnh gạch chéo trong API Google Chat.

Đặt tên cho lệnh dấu gạch chéo

Tên của lệnh dấu gạch chéo là tên mà người dùng nhập trong tin nhắn trong Chat để gọi ứng dụng Chat. Thêm một đoạn mô tả ngắn xuất hiện bên dưới tên để nhắc người dùng thêm về cách sử dụng lệnh:

Khi chọn tên và nội dung mô tả cho lệnh gạch chéo, hãy cân nhắc các đề xuất sau:

• Cách đặt tên cho lệnh dấu gạch chéo:

  • Sử dụng các từ hoặc cụm từ ngắn gọn, mô tả và có thể hành động để giúp người dùng hiểu rõ và đơn giản về các lệnh. Ví dụ: thay vì nói /createAReminder, hãy sử dụng /remindMe.
  • Nếu lệnh của bạn chứa nhiều từ, hãy giúp người dùng đọc lệnh đó bằng cách sử dụng toàn bộ chữ thường cho từ đầu tiên, sau đó viết hoa chữ cái đầu tiên chữ cái của từ bổ sung. Ví dụ: thay vì /updatecontact, hãy sử dụng /updateContact.
  • Cân nhắc việc sử dụng tên riêng biệt hay tên phổ biến cho lệnh của bạn. Nếu lệnh của bạn mô tả một hoạt động tương tác hoặc tính năng thông thường, bạn có thể sử dụng tên phổ biến mà người dùng nhận ra và mong đợi, chẳng hạn như /settings hoặc /feedback. Nếu không, hãy cố gắng sử dụng tên lệnh riêng biệt, vì nếu tên lệnh của bạn giống với các ứng dụng Chat khác, người dùng phải lọc qua các lệnh tương tự để tìm và sử dụng lệnh của bạn.

• Cách mô tả lệnh dấu gạch chéo:

  • Hãy giữ cho nội dung mô tả ngắn gọn và rõ ràng để người dùng biết điều gì sẽ xảy ra khi họ gọi lệnh.
  • Thông báo cho người dùng biết nếu có yêu cầu định dạng nào đối với lệnh. Ví dụ: nếu bạn tạo một lệnh /remindMe yêu cầu đối số văn bản, hãy đặt nội dung mô tả thành Remind me to do [something] at [time].
  • Cho người dùng biết liệu ứng dụng Chat có trả lời tất cả mọi người trong không gian hay chỉ trả lời riêng cho người dùng gọi lệnh. Ví dụ: đối với lệnh dấu gạch chéo /about, bạn có thể mô tả lệnh này là Learn about this app (Only visible to you).

Định cấu hình lệnh gạch chéo trong API Google Chat

Để tạo lệnh gạch chéo, bạn cần chỉ định thông tin về lệnh đó trong cấu hình của ứng dụng Chat cho API Google Chat.

Để định cấu hình lệnh gạch chéo trong API Google Chat, hãy hoàn tất các bước sau:

1. Trong Google Cloud Console, hãy nhấp vào biểu tượng Trình đơn menu > API và Dịch vụ > API và Dịch vụ đã bật > Google Chat API

   Chuyển đến trang API Google Chat

2. Nhấp vào Cấu hình.

3. Trong phần Lệnh dấu gạch chéo, hãy nhấp vào Thêm lệnh dấu gạch chéo.

4. Nhập tên, mã lệnh và nội dung mô tả cho lệnh:

   1. Tên: tên hiển thị cho lệnh và nội dung người dùng nhập để gọi ứng dụng của bạn. Phải bắt đầu bằng dấu gạch chéo, chỉ chứa văn bản và có thể tối đa 50 ký tự.
   2. Mô tả: văn bản mô tả cách sử dụng và định dạng lệnh. Nội dung mô tả có thể chứa tối đa 50 ký tự.
   3. Command ID: một số từ 1 đến 1000 mà bạn Ứng dụng Chat dùng để nhận dạng lệnh dấu gạch chéo và trả về phản hồi.

5. Không bắt buộc: Nếu bạn muốn ứng dụng Chat phản hồi lệnh có hộp thoại, hãy chọn Mở hộp thoại.

6. Nhấp vào Lưu.

Lệnh dấu gạch chéo hiện đã được định cấu hình cho ứng dụng Chat.

Phản hồi lệnh dấu gạch chéo

Khi người dùng tạo một tin nhắn Chat chứa lệnh dấu gạch chéo, ứng dụng Chat của bạn sẽ nhận được một sự kiện tương tác MESSAGE. Trọng tải sự kiện chứa các đối tượng slashCommand và slashCommandMetadata. Các đối tượng này chứa thông tin chi tiết về lệnh được sử dụng trong thông báo (bao gồm cả mã lệnh) để bạn có thể trả về phản hồi thích hợp.

Đoạn mã sau đây là ví dụ về một ứng dụng Chat phản hồi lệnh dấu gạch chéo /about bằng cách xử lý MESSAGE sự kiện tương tác và phát hiện xem thông báo có chứa mã nhận dạng lệnh trùng khớp hay không. Nếu thông báo chứa mã lệnh, thì ứng dụng Chat sẽ trả về một thông báo riêng tư:

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

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

# 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.'
    }

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

Đặt ABOUT_COMMAND_ID bằng mã lệnh mà bạn đã chỉ định khi định cấu hình lệnh gạch chéo trong Chat API. Để kiểm tra mã này, hãy xem Kiểm thử các tính năng có tính tương tác cho các ứng dụng của Google Chat.

Chủ đề có liên quan

• Xem các mẫu ứng dụng trong Chat có dùng lệnh dấu gạch chéo
• Gửi tin nhắn
• Gửi tin nhắn riêng tư
• Mở hộp thoại tương tác