อัปเดตสถานะการอ่านชุดข้อความของผู้ใช้

คู่มือนี้จะอธิบายวิธีใช้เมธอด update ในทรัพยากร ThreadReadState ของ Google Chat API เพื่อทำเครื่องหมายชุดข้อความว่าอ่านแล้วหรือยังไม่อ่าน

ทรัพยากร ThreadReadState เป็นทรัพยากรแบบซิงเกิลตันที่แสดงรายละเอียดเกี่ยวกับข้อความแชทที่อ่านล่าสุดของผู้ใช้ที่ระบุในชุดข้อความของ Google Chat

ข้อกำหนดเบื้องต้น

Node.js

  • บัญชี Google Workspace แบบ Business หรือ Enterprise ที่มีสิทธิ์เข้าถึง Google Chat

Python

  • บัญชี Google Workspace แบบ Business หรือ Enterprise ที่มีสิทธิ์เข้าถึง Google Chat

อัปเดตสถานะการอ่านชุดข้อความของผู้ใช้ที่โทร

หากต้องการอัปเดตสถานะการอ่านของผู้ใช้ภายในชุดข้อความ ให้ระบุข้อมูลต่อไปนี้ในคำขอ

  • ระบุขอบเขตการให้สิทธิ์ chat.users.readstate
  • เรียกใช้เมธอด UpdateThreadReadState
  • ส่ง updateMask พร้อมค่า lastReadTime
  • ส่ง threadReadState เป็นอินสแตนซ์ของ ThreadReadState พร้อมด้วยข้อมูลต่อไปนี้
    • ช่อง name ตั้งค่าเป็นสถานะการอ่านชุดข้อความที่จะอัปเดต ซึ่งรวมถึงรหัสผู้ใช้หรือชื่อแทน รหัสพื้นที่ทำงาน และรหัสชุดข้อความ การอัปเดตสถานะการอ่านของชุดข้อความรองรับเฉพาะการอัปเดตสถานะการอ่านของผู้ใช้ที่โทร ซึ่งระบุได้โดยการตั้งค่าอย่างใดอย่างหนึ่งต่อไปนี้
      • ชื่อแทน me เช่น users/me/spaces/SPACE/threads/THREAD/threadReadState
      • อีเมล Workspace ของผู้ใช้ที่โทร เช่น users/user@example.com/spaces/SPACE/threads/THREAD/threadReadState
      • รหัสผู้ใช้ของผู้ใช้ที่โทร เช่น users/USER/spaces/SPACE/threads/THREAD/threadReadState
    • ช่อง lastReadTime ตั้งค่าเป็นการประทับเวลาที่ทำเครื่องหมายตำแหน่งที่อ่านล่าสุดของผู้ใช้ที่โทรในชุดข้อความ เช่น การประทับเวลาของข้อความที่อ่านล่าสุดหรือเวลาปัจจุบัน
      • ทำเครื่องหมายว่ายังไม่อ่าน: ตั้งค่า lastReadTime เป็นการประทับเวลาก่อนเวลาสร้างข้อความล่าสุดในชุดข้อความ ใน Chat ชุดข้อความจะปรากฏเป็นยังไม่อ่านตั้งแต่การประทับเวลาดังกล่าวเป็นต้นไป โดยจะอัปเดตป้ายที่ยังไม่อ่าน ทำชุดข้อความเป็นตัวหนา และแสดงในหน้าแรก
      • ทำเครื่องหมายว่าอ่านแล้ว: ตั้งค่า lastReadTime เป็นการประทับเวลาที่เท่ากับหรือหลังจากเวลาที่สร้างข้อความล่าสุดในชุดข้อความ หากคุณระบุการประทับเวลาในอนาคต API จะบังคับให้ lastReadTime เป็นเวลาของคำขอปัจจุบัน
      • การประทับเวลาขั้นต่ำ: ฟิลด์ lastReadTime ต้องตรงกับหรือหลังจาก Unix Epoch (1970-01-01T00:00:00Z) การตั้งค่าการประทับเวลาเป็นค่าลบ (ก่อน 1970-01-01T00:00:00Z) จะแสดงข้อผิดพลาด INVALID_ARGUMENT (400)

ตัวอย่างต่อไปนี้จะอัปเดตสถานะการอ่านชุดข้อความของผู้ใช้ที่โทร

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()

หากต้องการเรียกใช้ตัวอย่างนี้ ให้แทนที่ค่าต่อไปนี้

  • SPACE_NAME: รหัสจาก name ของพื้นที่ทำงาน คุณสามารถดูรหัสได้โดยเรียกใช้เมธอด ListSpaces หรือจาก URL ของพื้นที่ทำงาน
  • THREAD_NAME: รหัสจาก name ของชุดข้อความ คุณสามารถรับรหัสจากเนื้อหาการตอบกลับที่แสดงผลหลังจากสร้างข้อความแบบอะซิงโครนัสด้วย Chat API หรือด้วยชื่อที่กำหนดเองที่กำหนดให้กับข้อความเมื่อสร้าง

Chat API จะอัปเดตสถานะการอ่านของชุดข้อความที่ระบุและแสดงผลอินสแตนซ์ของ ThreadReadState