ユーザーのスレッドの読み取り状態の詳細を取得する

このガイドでは、Google Chat API の ThreadReadState リソースで get() メソッドを使用して、メッセージ スレッド内のユーザーの未読ステータスの詳細を取得する方法について説明します。スペース内のメッセージの読み取りステータスを取得するには、ユーザーのスペースの読み取りステータスの詳細を取得するをご覧ください。

ThreadReadState リソースは、Google Chat メッセージ スレッド内の指定したユーザーの最後に読んだメッセージの詳細を表すシングルトン リソースです。

前提条件

呼び出し元のユーザーのスレッドの読み取り状態を取得する

メッセージ スレッド内のユーザーの未読ステータスの詳細を取得するには、リクエストに次のものを含めます。

• chat.users.readstate または chat.users.readstate.readonly の認可スコープを指定します。
• GetThreadReadState() メソッドを呼び出し、スレッドの読み取り状態の name を渡して、ユーザー ID またはエイリアスとスペース ID を取得します。スレッドの読み取り状態の取得は、呼び出し元のユーザーの読み取り状態の取得のみをサポートしています。これは、次のいずれかを設定することで指定できます。
  • me エイリアス。例: users/me/spaces/SPACE/threads/THREAD/threadReadState
  • 呼び出し元のユーザーの Workspace メールアドレス。例: users/user@example.com/spaces/SPACE/threads/THREAD/threadReadState
  • 呼び出し元のユーザーのユーザー ID。例: users/USER/spaces/SPACE/threads/THREAD/threadReadState

次の例では、呼び出し元のユーザーのスレッドの読み取り状態を取得します。

import {createClientWithUserCredentials} from './authentication-utils.js';

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

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

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME and THREAD_NAME here
    name: 'users/me/spaces/SPACE_NAME/threads/THREAD_NAME/threadReadState'
  };

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

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

main().catch(console.error);

このサンプルを実行するには、次のように置き換えます。

• SPACE_NAME: スペースの name の ID。ID は、ListSpaces() メソッドを呼び出すか、スペースの URL から取得できます。
• THREAD_NAME: スレッドの name の ID。ID は、Chat API を使用してメッセージを非同期で作成した後に返されたレスポンス本文から取得できます。また、作成時にメッセージに割り当てられたカスタム名から取得することもできます。

Google Chat API は、指定されたスレッドの読み取り状態を取得し、ThreadReadState のインスタンスを返します。

関連トピック

• 呼び出し元のユーザーのスペースの読み取り状態を更新する。
• 呼び出し元のユーザーのスペースの読み取りステータスを取得する。