Cập nhật trạng thái đọc chuỗi tin nhắn của người dùng

Hướng dẫn này giải thích cách sử dụng phương thức update trên tài nguyên ThreadReadState của Google Chat API để đánh dấu chuỗi tin nhắn là đã đọc hoặc chưa đọc.

Tài nguyên ThreadReadState là một tài nguyên singleton, thể hiện thông tin chi tiết về tin nhắn đã đọc gần đây nhất của một người dùng cụ thể trong một chuỗi tin nhắn trò chuyện trên Google Chat.

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

Node.js

Python

Cập nhật trạng thái đọc của chuỗi tin nhắn của người dùng gọi điện

Để cập nhật trạng thái đã đọc của người dùng trong một chuỗi thư, hãy thêm thông tin sau vào yêu cầu của bạn:

  • Chỉ định phạm vi uỷ quyền chat.users.readstate.
  • Gọi phương thức UpdateThreadReadState.
  • Truyền updateMask có giá trị lastReadTime.
  • Truyền threadReadState dưới dạng một thực thể của ThreadReadState bằng cách sau:
    • Trường name được đặt thành trạng thái đọc của chuỗi tin nhắn cần cập nhật, bao gồm mã nhận dạng người dùng hoặc bí danh, mã không gian và mã chuỗi tin nhắn. Việc cập nhật trạng thái đọc của chuỗi tin nhắn chỉ hỗ trợ cập nhật trạng thái đọc của người dùng đang gọi. Bạn có thể chỉ định trạng thái này bằng cách đặt một trong những trạng thái sau:
      • Email đại diện me. Ví dụ: users/me/spaces/SPACE/threads/THREAD/threadReadState.
      • Địa chỉ email Workspace của người dùng gọi điện. Ví dụ: users/user@example.com/spaces/SPACE/threads/THREAD/threadReadState.
      • Mã nhận dạng người dùng của người dùng gọi. Ví dụ: users/USER/spaces/SPACE/threads/THREAD/threadReadState.
    • Trường lastReadTime được đặt thành dấu thời gian đánh dấu vị trí đọc gần đây nhất của người dùng gọi trong chuỗi, chẳng hạn như dấu thời gian của tin nhắn đã đọc gần đây nhất hoặc thời gian hiện tại:
      • Đánh dấu là chưa đọc: Đặt lastReadTime thành dấu thời gian sớm hơn thời gian tạo tin nhắn mới nhất trong chuỗi tin nhắn. Trong Chat, chuỗi tin nhắn sẽ xuất hiện dưới dạng chưa đọc kể từ dấu thời gian đó trở đi, cập nhật huy hiệu chưa đọc, in đậm chuỗi tin nhắn và hiển thị chuỗi tin nhắn đó trong Trang chủ.
      • Đánh dấu là đã đọc: Đặt lastReadTime thành dấu thời gian bằng hoặc muộn hơn thời gian tạo tin nhắn mới nhất trong chuỗi. Nếu bạn chỉ định dấu thời gian trong tương lai, API sẽ buộc lastReadTime phải khớp với thời gian yêu cầu hiện tại.
      • Dấu thời gian tối thiểu: Trường lastReadTime phải bằng hoặc sau thời gian Unix (1970-01-01T00:00:00Z). Việc đặt dấu thời gian âm (trước 1970-01-01T00:00:00Z) sẽ trả về lỗi INVALID_ARGUMENT (400).

Ví dụ sau đây cập nhật trạng thái đọc của chuỗi tin nhắn của người dùng gọi:

Node.js

/**
 * This sample shows how to update the calling user's thread read state.
 *
 * It relies on the @google-apps/chat npm package.
 */
// Read the documentation for more details:
// https://developers.google.com/workspace/chat/api/reference/rest/v1/users.spaces.threads/updateThreadReadState

const {ChatServiceClient} = require('@google-apps/chat');
const {auth} = require('google-auth-library');

async function main() {
  // Create a client
  const chatClient = new ChatServiceClient({
    authClient: await auth.getClient({
      scopes: ['https://www.googleapis.com/auth/chat.users.readstate']
    })
  });

  // Initialize request arguments.
  const request = {
    threadReadState: {
      name: 'users/me/spaces/SPACE_NAME/threads/THREAD_NAME/threadReadState',
      lastReadTime: {
        seconds: Math.floor(Date.now() / 1000),
        nanos: 0
      }
    },
    updateMask: {
      paths: ['last_read_time']
    }
  };

  // Make the request
  const response = await chatClient.updateThreadReadState(request);
  console.log(response);
}

main().catch(console.error);

Python

"""
This sample shows how to update the calling user's thread read state.
"""
from google.apps import chat_v1
import google.auth
from google.protobuf import timestamp_pb2

# Read the documentation for more details:
# https://developers.google.com/workspace/chat/api/reference/rest/v1/users.spaces.threads/updateThreadReadState

def update_thread_read_state():
    # Authenticate with Chat API using user credentials.
    credentials, _ = google.auth.default(
        scopes=["https://www.googleapis.com/auth/chat.users.readstate"]
    )
    client = chat_v1.ChatServiceClient(credentials=credentials)

    # Set timestamp for last read time.
    now = timestamp_pb2.Timestamp()
    now.GetCurrentTime()

    thread_read_state = chat_v1.ThreadReadState(
        name="users/me/spaces/SPACE_NAME/threads/THREAD_NAME/threadReadState",
        last_read_time=now,
    )

    request = chat_v1.UpdateThreadReadStateRequest(
        thread_read_state=thread_read_state,
        update_mask={"paths": ["last_read_time"]},
    )

    response = client.update_thread_read_state(request=request)
    print(response)

if __name__ == "__main__":
    update_thread_read_state()

Để chạy mẫu này, hãy thay thế các giá trị sau:

  • SPACE_NAME: mã nhận dạng từ name của không gian. Bạn có thể lấy mã nhận dạng bằng cách gọi phương thức ListSpaces hoặc từ URL của không gian.
  • THREAD_NAME: mã nhận dạng từ name của chuỗi tin nhắn. Bạn có thể lấy mã nhận dạng từ nội dung phản hồi được trả về sau khi tạo tin nhắn không đồng bộ bằng API Chat hoặc bằng tên tuỳ chỉnh được chỉ định cho tin nhắn khi tạo.

API Chat cập nhật trạng thái đã đọc của chuỗi tin nhắn được chỉ định và trả về một thực thể của ThreadReadState.