Trả lời lệnh của ứng dụng Google Chat

Trang này giải thích cách thiết lập và phản hồi các lệnh dưới dạng một ứng dụng Google Chat.

Lệnh giúp người dùng khám phá và sử dụng các tính năng chính của một ứng dụng Chat. Chỉ ứng dụng Chat mới có thể xem nội dung của một lệnh. Ví dụ: nếu người dùng gửi tin nhắn có lệnh dấu gạch chéo, thì chỉ người dùng và ứng dụng Chat mới thấy được tin nhắn đó.

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

Các loại lệnh của ứng dụng Chat

Bạn có thể tạo lệnh cho ứng dụng Chat dưới dạng lệnh dấu gạch chéo hoặc lệnh nhanh. Để khám phá và sử dụng từng loại lệnh, người dùng thực hiện những thao tác sau:
  1. Lệnh dấu gạch chéo: Người dùng gửi lệnh dưới dạng tin nhắn bằng cách nhập dấu gạch chéo (/) rồi nhập văn bản được xác định trước, chẳng hạn như /about. Các ứng dụng trò chuyện cũng có thể yêu cầu văn bản đối số cho lệnh gạch chéo. Ví dụ: lệnh gạch chéo /search có thể yêu cầu văn bản đối số được dùng cho cụm từ tìm kiếm.
  2. Lệnh nhanh: Người dùng sử dụng lệnh bằng cách mở trình đơn trong phần trả lời của một tin nhắn trên Chat. Để sử dụng một lệnh, họ nhấp vào Thêm rồi chọn một lệnh trong trình đơn.
Những hình ảnh sau đây cho thấy cách người dùng khám phá trình đơn gồm các lệnh dấu gạch chéo và lệnh nhanh:
  • Người dùng khám phá các lệnh dấu gạch chéo.
    Hình 1. Người dùng khám phá và sử dụng lệnh dấu gạch chéo bằng cách nhập dấu gạch chéo / trong phần trả lời, sau đó nhập tên của lệnh.
  • Người dùng xem các lệnh nhanh trong trình đơn.
    Hình 2. Người dùng có thể khám phá và sử dụng các lệnh nhanh trong trình đơn ở phần trả lời của một tin nhắn trên Chat.

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

HTTP

Một tiện ích bổ sung của Google Workspace giúp mở rộng Google Chat. Để tạo một ứng dụng, hãy hoàn tất hướng dẫn nhanh về HTTP.

Apps Script

Một tiện ích bổ sung của Google Workspace giúp mở rộng Google Chat. Để tạo một tiện ích bổ sung, hãy hoàn tất hướng dẫn bắt đầu nhanh với Apps Script.

Thiết lập lệnh

Phần này giải thích cách hoàn tất các bước sau để thiết lập một lệnh:

  1. Tạo tên và nội dung mô tả cho lệnh.
  2. Định cấu hình lệnh trong Google Cloud Console.

Đặt tên và mô tả lệnh

Tên của một lệnh là nội dung mà người dùng nhập hoặc chọn để gọi ứng dụng Chat. Nội dung mô tả ngắn cũng 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:

Tên và nội dung mô tả của lệnh dấu gạch chéo
Hình 3: Tên và nội dung mô tả của một lệnh dấu gạch chéo.

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

Cách đặt tên cho một lệnh:

  • Sử dụng các từ hoặc cụm từ ngắn gọn, mang tính mô tả và có thể hành động để người dùng hiểu rõ các lệnh. Ví dụ: thay vì tên Create a reminder, hãy sử dụng Remind me.
  • Hãy cân nhắc sử dụng một tên riêng biệt hoặc tên phổ biến cho lệnh của bạn. Nếu lệnh của bạn mô tả một tính năng hoặc hoạt động tương tác thông thường, bạn có thể sử dụng một 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 tên lệnh của các ứng dụng Chat khác, thì 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ả một lệnh:

  • Hãy viết nội dung mô tả ngắn gọn và rõ ràng để người dùng biết được những gì họ có thể mong đợi khi sử dụng lệnh.
  • Thông báo cho người dùng biết nếu có yêu cầu nào về định dạng đối với lệnh. Ví dụ: nếu bạn tạo một lệnh gạch chéo yêu cầu văn bản đối số, hãy đặt nội dung mô tả thành một nội dung nào đó 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 trả lời riêng tư cho người dùng gọi lệnh. Ví dụ: đối với lệnh nhanh 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 trong bảng điều khiển Google Cloud

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

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

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

    Truy cập vào trang API Google Chat

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

  3. Trong phần Cài đặt kết nối, hãy chuyển đến phần Triggers (Trình kích hoạt) rồi chỉ định thông tin chi tiết về điểm cuối. Bạn phải dùng điều kiện kích hoạt này trong phần sau để phản hồi lệnh.

    1. URL điểm cuối HTTP: Bạn có thể chỉ định một URL điểm cuối HTTP chung tại đây. Ngoài ra, để sử dụng các điểm cuối HTTP khác nhau cho các điều kiện kích hoạt khác nhau, hãy chỉ định trực tiếp điểm cuối trong trường Lệnh ứng dụng.
    2. Apps Script: Nhập mã nhận dạng lượt triển khai Apps Script. Theo mặc định, hàm onAppCommand sẽ được gọi. Để sử dụng một hàm Apps Script khác, hãy chỉ định tên hàm tuỳ chỉnh trong trường Lệnh ứng dụng.

  4. Trong phần Lệnh, hãy nhấp vào Thêm lệnh.

  5. Nhập thông tin sau về lệnh:

    1. Mã lệnh: một số từ 1 đến 1000 mà ứng dụng Chat của bạn dùng để nhận dạng lệnh và trả về phản hồi.
    2. Nội dung 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. Loại lệnh: chọn Lệnh nhanh hoặc Lệnh gạch chéo.
    4. Chỉ định tên cho lệnh nhanh hoặc lệnh dấu gạch chéo:
      • Tên lệnh nhanh: Tên hiển thị mà người dùng chọn trong trình đơn để gọi lệnh. Có thể chứa tối đa 50 ký tự và bao gồm cả ký tự đặc biệt. Ví dụ: Remind me.
      • Tên lệnh dấu gạch chéo: Văn bản mà người dùng nhập để gọi lệnh trong một tin nhắn. Phải bắt đầu bằng dấu gạch chéo, chỉ chứa văn bản và có thể dài tối đa 50 ký tự. Ví dụ: /remindMe.

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

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

Lệnh này hiện đã được định cấu hình cho ứng dụng Chat.

Phản hồi một lệnh

Khi người dùng sử dụng một lệnh, ứng dụng Chat của bạn sẽ nhận được một đối tượng sự kiện. Tải trọng sự kiện chứa một đối tượng appCommandPayload với thông tin chi tiết về lệnh đã được gọi (bao gồm cả mã nhận dạng lệnh và loại lệnh), để bạn có thể trả về một phản hồi thích hợp. Đối tượng sự kiện được gửi đến điểm cuối HTTP hoặc hàm Apps Script mà bạn đã chỉ định khi định cấu hình trình kích hoạt Lệnh ứng dụng.

Tin nhắn riêng tư cho ứng dụng Cymbal Labs Chat. Tin nhắn này cho biết ứng dụng Chat do Cymbal Labs tạo và chia sẻ đường liên kết đến tài liệu cũng như đường liên kết để liên hệ với nhóm hỗ trợ.
Một ứng dụng Chat sẽ phản hồi riêng tư cho lệnh /help để giải thích cách nhận được sự hỗ trợ.

Đoạn mã sau đây cho thấy ví dụ về một ứng dụng Chat phản hồi lệnh /about bằng một tin nhắn văn bản. Để phản hồi các lệnh gạch chéo, ứng dụng Chat sẽ xử lý các đối tượng sự kiện từ một trình kích hoạt Lệnh ứng dụng. Khi tải trọng của một đối tượng sự kiện chứa mã lệnh dấu gạch chéo, ứng dụng Chat sẽ trả về thao tác DataActions bằng đối tượng createMessageAction:

Node.js 

// The ID of the slash command "/about".
// It's not enabled by default, set to the actual ID to enable it. You must
// use the same ID as set in the Google Chat API configuration.
const ABOUT_COMMAND_ID = 0;

/**
 * Google Cloud Function that responds to events sent from a
 * Google Chat space.
 *
 * @param {Object} req Request sent from Google Chat space
 * @param {Object} res Response to send back
 */
exports.avatarApp = function avatarApp(req, res) {
    if (req.method === 'GET' || !req.body.chat) {
        return res.send('Hello! This function is meant to be used ' +
            'in a Google Chat Space.');
    }
    // Stores the Google Chat event as a variable.
    const chatEvent = req.body.chat;

    // Handles events that contain payloads about commands
    if (chatEvent.appCommandPayload) {

      // Stores the Google Chat app command metadata as a variable.
      const appCommandMetadata = chatEvent.appCommandPayload.appCommandMetadata;

      // Executes the slash command logic based on its ID.
      // Slash command IDs are set in the Google Chat API configuration.
      switch (appCommandMetadata.appCommandId) {
          case ABOUT_COMMAND_ID:
              return res.send({ hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
                  text: 'The Avatar app replies to Google Chat messages.'
              }}}}});
      }
    // Handles MESSAGE events
    } else if (chatEvent.messagePayload) {

        // Stores the Google Chat event as a variable.
        const chatMessage = chatEvent.messagePayload.message;

        // Replies with the sender's avatar in a card otherwise.
        const displayName = chatMessage.sender.displayName;
        const avatarUrl = chatMessage.sender.avatarUrl;
        res.send({ hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
            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 }
                        }]
                    }]
                }
            }]
        }}}}});
    }
};

Apps Script 

// The ID of the slash command "/about".
// It's not enabled by default, set to the actual ID to enable it. You must
// use the same ID as set in the Google Chat API configuration.
const ABOUT_COMMAND_ID = 0;

/**
 * Responds to a MESSAGE event in Google Chat.
 *
 * @param {Object} event the event object from Google Chat
 */
function onMessage(event) {

    // Stores the Google Chat event as a variable.
    const chatMessage = event.chat.messagePayload.message;

    // Replies with the sender's avatar in a card otherwise.
    const displayName = chatMessage.sender.displayName;
    const avatarUrl = chatMessage.sender.avatarUrl;
    return { hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
        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 }
                    }]
                }]
            }
        }]
    }}}}};
}

/**
 * Responds to an APP_COMMAND event in Google Chat.
 *
 * @param {Object} event the event object from Google Chat
 */
function onAppCommand(event) {

  // Stores the Google Chat app command metadata as a variable.
  const appCommandMetadata = event.chat.appCommandPayload.appCommandMetadata;

  // Executes the slash command logic based on its ID.
  // Slash command IDs are set in the Google Chat API configuration.
  switch (appCommandMetadata.appCommandId) {
      case ABOUT_COMMAND_ID:
          return { hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
              text: 'The Avatar app replies to Google Chat messages.'
          }}}}};
  }
}

Để sử dụng đoạn mã này, hãy thay thế ABOUT_COMMAND_ID bằng mã lệnh mà bạn đã chỉ định khi định cấu hình lệnh trong Chat API.

Kiểm thử lệnh

Để kiểm thử lệnh và mã, hãy xem phần Kiểm thử các tính năng tương tác cho ứng dụng Google Chat.

Để tìm hiểu cách kiểm thử và sử dụng lệnh trong giao diện người dùng Chat, hãy xem bài viết Dùng các ứng dụng trong Google Chat trong tài liệu trợ giúp của Google Chat.