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

このガイドでは、Terraform で getSpaceReadState メソッドを使用する方法について説明します。 ユーザーの既読の詳細を取得するための Google Chat API の SpaceReadState リソース スペース内の状態を簡単に把握できます。メッセージ スレッド内のメッセージの既読状態を取得するには、 ユーザーのスレッドの読み取り状態の詳細を取得する

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

前提条件

Python

Node.js

Apps Script

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

スペース内でのユーザーの読み取り状態の詳細を取得するには、以下を含めます。 リクエスト内:

  • chat.users.readstate または chat.users.readstate.readonly を指定する 認可スコープを指定します。
  • 呼び出し getSpaceReadState メソッド 日付 SpaceReadState リソース
  • 取得するスペースの読み取り状態の name を渡します。これにはユーザー ID または スペース ID が含まれます。スペースの読み取り状態の取得は、読み取りの取得のみをサポートします。 ステータス(発信元のユーザーの状態)は、 次のとおりです。 <ph type="x-smartling-placeholder">
      </ph>
    • me エイリアス。例: users/me/spaces/SPACE/spaceReadState
    • 呼び出し元のユーザーの Workspace メールアドレス。次に例を示します。 users/user@example.com/spaces/SPACE/spaceReadState
    • 呼び出し元ユーザーのユーザー ID。次に例を示します。 users/USER/spaces/SPACE/spaceReadState

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

Python

  1. 作業ディレクトリに、先ほど作成した chat_spaceReadState_get.py
  2. chat_spaceReadState_get.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.readonly"]
    
    def main():
        '''
        Authenticates with Chat API via user credentials,
        then gets 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().getSpaceReadState(
    
            # The space read state to get.
            #
            # 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'
    
          ).execute()
    
        # Prints the API's response.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. コードの次のように置き換えます。

  4. 作業ディレクトリでサンプルをビルドして実行します。

    python3 chat_spaceReadState_get.py
    

Node.js

  1. 作業ディレクトリに、先ほど作成した chat_spaceReadState_get.js
  2. chat_spaceReadState_get に次のコードを含めます。

    const chat = require('@googleapis/chat');
    const {authenticate} = require('@google-cloud/local-auth');
    
    /**
    * Authenticates with Chat API via user credentials,
    * then gets the space read state for the calling user.
    * @return {!Promise<!Object>}
    */
    async function getSpaceReadState() {
    
      /**
      * Authenticate with Google Workspace
      * and get user authorization.
      */
      const scopes = [
        'https://www.googleapis.com/auth/chat.users.readstate.readonly',
      ];
    
      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.getSpaceReadState({
    
        /**
        * The space read state to get.
        *
        * 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'
      });
    }
    
    /**
    * Use the service endpoint to call Chat API.
    */
    getSpaceReadState().then(console.log);
    
  3. コードの次のように置き換えます。

  4. 作業ディレクトリでサンプルをビルドして実行します。

    node chat_spaceReadState_get.js
    

Apps Script

この例では、API 呼び出しを使用して Chat API を呼び出し、 高度なチャット サービス

  1. chat.users.readstate.readonly 承認スコープを以下に追加します。 Apps Script プロジェクトの appsscript.json ファイル:

    "oauthScopes": [
      "https://www.googleapis.com/auth/chat.users.readstate.readonly"
    ]
    
  2. このような関数を Apps Script プロジェクトの コード:

    /**
    * Authenticates with Chat API via user credentials,
    * then gets the space read state for the calling user.
    * @param {string} spaceReadStateName The resource name of the space read state.
    */
    function getSpaceReadState(spaceReadStateName) {
      try {
        Chat.Users.Spaces.getSpaceReadState(spaceReadStateName);
      } catch (err) {
        // TODO (developer) - Handle exception
        console.log('Failed to get read state with error %s', err.message);
      }
    }
    

Google Chat API は指定されたスペースの読み取り状態を取得し、 Pod の SpaceReadState リソース