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

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

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

前提条件

Node.js

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

スペース内のユーザーの読み取りステータスの詳細を取得するには、リクエストに次のものを含めます。

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

次の例では、呼び出し元のユーザーのスペースの読み取りステータスを取得します。

Node.js

chat/client-libraries/cloud/get-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.readonly'];

// This sample shows how to get the 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 request = {
    // Replace SPACE_NAME here
    name: 'users/me/spaces/SPACE_NAME/spaceReadState'
  };

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

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

main().catch(console.error);

このサンプルを実行するには、SPACE_NAME をスペースの name の ID に置き換えます。ID は、ListSpaces() メソッドを呼び出すか、スペースの URL から取得できます。

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