Memperbarui status baca rangkaian pesan pengguna

Panduan ini menjelaskan cara menggunakan metode update pada resource ThreadReadState Google Chat API untuk menandai rangkaian pesan sebagai telah dibaca atau belum dibaca.

Resource ThreadReadState adalah resource singleton yang mewakili detail tentang pesan terakhir yang dibaca pengguna tertentu dalam rangkaian pesan Google Chat.

Prasyarat

Node.js

Python

Memperbarui status baca rangkaian pesan pengguna yang melakukan panggilan

Untuk memperbarui status baca pengguna dalam rangkaian pesan, sertakan hal berikut dalam permintaan Anda:

  • Tentukan cakupan otorisasi chat.users.readstate.
  • Panggil metode UpdateThreadReadState.
  • Teruskan updateMask dengan nilai lastReadTime.
  • Teruskan threadReadState sebagai instance ThreadReadState dengan kode berikut:
    • Kolom name ditetapkan ke status baca rangkaian pesan yang akan diperbarui, yang mencakup ID Pengguna atau alias, ID ruang, dan ID rangkaian pesan. Memperbarui status baca rangkaian pesan hanya mendukung pembaruan status baca pengguna yang memanggil, yang dapat ditentukan dengan menetapkan salah satu hal berikut:
      • Alias me. Misalnya, users/me/spaces/SPACE/threads/THREAD/threadReadState.
      • Alamat email Workspace pengguna yang melakukan panggilan. Misalnya, users/user@example.com/spaces/SPACE/threads/THREAD/threadReadState.
      • ID pengguna dari pengguna yang melakukan panggilan. Misalnya, users/USER/spaces/SPACE/threads/THREAD/threadReadState.
    • Kolom lastReadTime ditetapkan ke stempel waktu yang menandai posisi baca terakhir pengguna yang menelepon dalam rangkaian pesan, seperti stempel waktu pesan terakhir yang dibaca atau waktu saat ini:
      • Tandai sebagai belum dibaca: Tetapkan lastReadTime ke stempel waktu yang lebih awal dari waktu pembuatan pesan terbaru dalam rangkaian pesan. Di Chat, rangkaian pesan akan muncul sebagai belum dibaca mulai dari stempel waktu tersebut, memperbarui badge belum dibaca, menebalkan rangkaian pesan, dan menampilkannya di Beranda.
      • Tandai sebagai telah dibaca: Tetapkan lastReadTime ke stempel waktu yang sama dengan atau lebih baru dari waktu pembuatan pesan terbaru dalam rangkaian pesan. Jika Anda menentukan stempel waktu mendatang, API akan memaksa lastReadTime ke waktu permintaan saat ini.
      • Stempel waktu minimum: Kolom lastReadTime harus berada pada atau setelah epoch Unix (1970-01-01T00:00:00Z). Menetapkan stempel waktu negatif (sebelum 1970-01-01T00:00:00Z) akan menampilkan error INVALID_ARGUMENT (400).

Contoh berikut memperbarui status baca rangkaian pesan pengguna yang menelepon:

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

Untuk menjalankan contoh ini, ganti kode berikut:

  • SPACE_NAME: ID dari name ruang. Anda bisa mendapatkan ID dengan memanggil metode ListSpaces atau dari URL ruang.
  • THREAD_NAME: ID dari name rangkaian pesan. Anda dapat memperoleh ID dari isi respons yang ditampilkan setelah membuat pesan secara asinkron dengan Chat API, atau dengan nama kustom yang ditetapkan ke pesan saat pembuatan.

Chat API memperbarui status baca rangkaian pesan yang ditentukan dan menampilkan instance ThreadReadState.