Memperbarui status baca ruang pengguna

Panduan ini menjelaskan cara menggunakan update() metode pada resource SpaceReadState Google Chat API untuk menandai ruang sebagai sudah dibaca atau belum dibaca.

Resource SpaceReadState adalah resource singleton yang mewakili detail tentang pesan terakhir yang dibaca pengguna tertentu di ruang Google Chat.

Prasyarat

Node.js

Memperbarui status baca ruang pengguna yang memanggil

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

  • Tentukan cakupan otorisasi chat.users.readstate.
  • Panggil metode UpdateSpaceReadState().
  • Teruskan updateMask dengan nilai lastReadTime.
  • Teruskan spaceReadState sebagai instance SpaceReadState dengan hal berikut:
    • Kolom name ditetapkan ke status baca ruang yang akan diperbarui, yang mencakup ID pengguna atau alias dan ID ruang. Memperbarui status baca ruang hanya mendukung pembaruan status baca pengguna yang memanggil, yang dapat ditentukan dengan menetapkan salah satu hal berikut:
      • Alias me. Misalnya, users/me/spaces/SPACE/spaceReadState.
      • Alamat email Workspace pengguna yang memanggil. Misalnya, users/user@example.com/spaces/SPACE/spaceReadState.
      • ID pengguna yang memanggil. Misalnya, users/USER/spaces/SPACE/spaceReadState.
    • Kolom lastReadTime ditetapkan ke nilai waktu yang diperbarui saat status baca ruang pengguna diperbarui. Biasanya, hal ini sesuai dengan stempel waktu pesan terakhir yang dibaca, atau stempel waktu yang ditentukan oleh pengguna untuk menandai posisi terakhir yang dibaca di ruang. Jika lastReadTime sebelum waktu pembuatan pesan terbaru, ruang akan muncul sebagai belum dibaca di UI. Untuk menandai ruang sebagai sudah dibaca, tetapkan lastReadTime ke nilai apa pun yang lebih baru (lebih besar) dari waktu pembuatan pesan terbaru. lastReadTime dipaksa untuk cocok dengan waktu pembuatan pesan terbaru. Perhatikan bahwa status baca ruang hanya memengaruhi status baca pesan yang terlihat dalam percakapan tingkat atas ruang. Balasan dalam rangkaian pesan tidak terpengaruh oleh stempel waktu ini, dan bergantung pada status baca rangkaian pesan.

Contoh berikut memperbarui status baca ruang pengguna yang memanggil:

Node.js

chat/client-libraries/cloud/update-space-read-state-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = [
  'https://www.googleapis.com/auth/chat.users.readstate',
];

// This sample shows how to update a space read state for the calling user
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(
    USER_AUTH_OAUTH_SCOPES,
  );

  // Initialize request argument(s)
  const timestamp = new Date('2000-01-01').getTime();
  const request = {
    spaceReadState: {
      // Replace SPACE_NAME here
      name: 'users/me/spaces/SPACE_NAME/spaceReadState',
      lastReadTime: {
        seconds: Math.floor(timestamp / 1000),
        nanos: (timestamp % 1000) * 1000000,
      },
    },
    updateMask: {
      // The field paths to update.
      paths: ['last_read_time'],
    },
  };

  // Make the request
  const response = await chatClient.updateSpaceReadState(request);

  // Handle the response
  console.log(response);
}

await main();

Untuk menjalankan contoh ini, ganti SPACE_NAME dengan ID dari ruang's name. Anda dapat memperoleh ID dengan memanggil ListSpaces() metode atau dari URL ruang.

Google Chat API memperbarui status baca ruang yang ditentukan dan menampilkan instance SpaceReadState.