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

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

「 ThreadReadState リソース 特定のリソースに関する詳細を表すシングルトン リソースです。 指定したユーザーの Google Chat メッセージ スレッドで最後に読まれたメッセージ。

前提条件

Node.js

• Google Chat へのアクセス権を持つビジネスまたはエンタープライズ向け Google Workspace アカウント。

• 環境を設定します。 <ph type="x-smartling-placeholder">
  </ph>
  • Google Cloud プロジェクトを作成します。
  • OAuth 同意画面を構成する
  • Google Chat API を有効にして構成する。名前、 アプリのアイコン、説明を入力します。
  • Node.js Cloud クライアント ライブラリをご覧ください。
  • デスクトップ アプリケーションの OAuth クライアント ID 認証情報を作成します。このガイドのサンプルを実行するには、認証情報を client_secrets.json という名前の JSON ファイルとしてローカル ディレクトリに保存します。
  ガイダンスについては、こちらのクイックスタートで環境の設定手順を完了してください。
• ユーザー認証をサポートする認可スコープを選択します。

このページのコードサンプルでは、Google Cloud クライアント ライブラリで gRPC API インターフェースを使用しています。また、REST API インターフェースを使用することもできます。gRPC の詳細については、 インターフェースについては、 Google Chat API の概要

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

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

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

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

Node.js

chat/client-libraries/cloud/get-thread-read-state-user-cred.js

GitHub で表示

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 のインスタンスを返します。

関連トピック

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