このガイドでは、Google Chat API の SpaceReadState
リソースの updateSpaceReadState
メソッドを使用して、スペースを既読または未読としてマークする方法について説明します。
SpaceReadState
リソースは、指定したユーザーが Google Chat スペースで最後に読んだメッセージの詳細を表すシングルトン リソースです。
前提条件
Python
- Python 3.6 以降
- pip パッケージ管理ツール
Python 用の最新の Google クライアント ライブラリ。これらをインストールまたは更新するには、コマンドライン インターフェースで次のコマンドを実行します。
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- Google Chat API が有効で構成された Google Cloud プロジェクト。手順については、Google Chat アプリを作成するをご覧ください。
Chat アプリ用に構成された認可。スペース内のユーザーの読み取り状態の詳細を取得するには、
chat.users.readstate
承認スコープを持つユーザー認証が必要です。
Node.js
- Node.js と npm
Node.js 用の最新の Google クライアント ライブラリ。これらをインストールするには、コマンドライン インターフェースで次のコマンドを実行します。
npm install @google-cloud/local-auth @googleapis/chat
- Google Chat API が有効で構成された Google Cloud プロジェクト。手順については、Google Chat アプリを作成するをご覧ください。
Chat アプリ用に構成された認可。スペース内のユーザーの読み取り状態の詳細を取得するには、
chat.users.readstate
承認スコープを持つユーザー認証が必要です。
Apps Script
- Google Chat へのアクセス権を持つ Google Workspace アカウント。
- 公開されている Chat アプリ。Chat アプリを作成するには、このquickstartの手順に沿ってください。
- Chat アプリ用に構成された認可。スペース内のユーザーの読み取り状態の詳細を取得するには、
chat.users.readstate
承認スコープを持つユーザー認証が必要です。
呼び出し元のユーザーのスペースの読み取り状態を更新する
スペース内のユーザーの読み取り状態を更新するには、リクエストに以下を含めます。
chat.users.readstate
承認スコープを指定します。SpaceReadState
リソースでupdateSpaceReadState
メソッドを呼び出します。- 取得するスペース読み取り状態の
name
を渡します。これには、ユーザー ID またはエイリアスとスペース ID が含まれます。スペースの読み取り状態の取得は、呼び出し元のユーザーの読み取り状態の取得のみをサポートしています。これは、次のいずれかを設定して指定できます。me
エイリアス。例:users/me/spaces/SPACE/spaceReadState
。- 呼び出し元のユーザーの Workspace メールアドレス。次に例を示します。
users/user@example.com/spaces/SPACE/spaceReadState
- 呼び出し元のユーザー ID。次に例を示します。
users/USER/spaces/SPACE/spaceReadState
- 更新するスペース読み取り状態のアスペクトを指定する
updateMask
を渡します。これは、次のフィールドパスをサポートします。lastReadTime
: ユーザーのスペースの読み取り状態が更新された時刻。これは通常、最後に読み取られたメッセージのタイムスタンプ、またはスペース内で最後の読み取り位置をマークするためにユーザーが指定したタイムスタンプのいずれかに対応します。lastReadTime
が最新のメッセージ作成時間よりも前である場合、UI ではスペースが未読として表示されます。スペースを既読としてマークするには、lastReadTime
を最新のメッセージ作成時間より後の任意の値(大きい値)に設定します。lastReadTime
は、最新のメッセージ作成時刻に一致するように強制変換されます。スペースの既読状態は、スペースの最上位の会話に表示されるメッセージの読み取り状態にのみ影響します。スレッド内の返信はこのタイムスタンプの影響を受けず、スレッドの読み取り状態に依存します。
次の例では、呼び出し元のユーザーのスペースの読み取り状態を更新しています。
Python
- 作業ディレクトリに
chat_spaceReadState_update.py
という名前のファイルを作成します。 chat_spaceReadState_update.py
に次のコードを追加します。from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.users.readstate"] def main(): ''' Authenticates with Chat API via user credentials, then updates the space read state for the calling user. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Use the service endpoint to call Chat API. result = chat.users().spaces().updateSpaceReadState( # The space read state to update. # # Replace USER with the calling user's ID, Workspace email, # or the alias me. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='users/me/spaces/SPACE/spaceReadState', updateMask='lastReadTime', body={'lastReadTime': f'{datetime.datetime(2000, 1, 3).isoformat()}Z'} ).execute() # Prints the API's response. print(result) if __name__ == '__main__': main()
コードで、次のように置き換えます。
SPACE
: スペース名。Chat API のspaces.list
メソッドまたはスペースの URL から取得できます。
作業ディレクトリで、サンプルをビルドして実行します。
python3 chat_spaceReadState_update.py
Node.js
- 作業ディレクトリに
chat_spaceReadState_update.js
という名前のファイルを作成します。 chat_spaceReadState_update
に次のコードを追加します。const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Authenticates with Chat API via user credentials, * then updates the space read state for the calling user. * @return {!Promise<!Object>} */ async function updateSpaceReadState() { /** * Authenticate with Google Workspace * and get user authorization. */ const scopes = [ 'https://www.googleapis.com/auth/chat.users.readstate', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); /** * Build a service endpoint for Chat API. */ const chatClient = await chat.chat({version: 'v1', auth: authClient}); /** * Use the service endpoint to call Chat API. */ return await chatClient.users.spaces.updateSpaceReadState({ /** * The space read state to update. * * Replace USER with the calling user's ID, Workspace email, * or the alias me. * * Replace SPACE with a space name. * Obtain the space name from the spaces resource of Chat API, * or from a space's URL. */ name: 'users/me/spaces/SPACE/spaceReadState', updateMask: 'lastReadTime', requestBody: { lastReadTime: '{datetime.datetime(2000, 1, 3).isoformat()}Z' } }); } /** * Use the service endpoint to call Chat API. */ getSpaceReadState().then(console.log);
コードで、次のように置き換えます。
SPACE
: スペース名。Chat API のspaces.list
メソッドまたはスペースの URL から取得できます。
作業ディレクトリで、サンプルをビルドして実行します。
node chat_spaceReadState_update.js
Apps Script
この例では、高度なチャット サービスを使用して Chat API を呼び出します。
chat.users.readstate
承認スコープを Apps Script プロジェクトのappsscript.json
ファイルに追加します。"oauthScopes": [ "https://www.googleapis.com/auth/chat.users.readstate" ]
次のような関数を Apps Script プロジェクトのコードに追加します。
/** * Authenticates with Chat API via user credentials, * then updates the space read state for the calling user. * @param {string} spaceReadStateName The resource name of the space read state. */ function updateSpaceReadState(spaceReadStateName) { try { const time = new Date('January 1, 2000')).toJSON(); const body = {'lastReadTime': time}; Chat.Users.Spaces.updateSpaceReadState(spaceReadStateName, body); } catch (err) { // TODO (developer) - Handle exception console.log('Failed to update read state with error %s', err.message); } }
Google Chat API が、指定されたスペースの読み取り状態を更新し、SpaceReadState
リソースのインスタンスを返します。