Details zum Lesestatus eines Nutzers abrufen

In diesem Leitfaden wird die Verwendung der Methode getThreadReadState auf der ThreadReadState der Google Chat API, um Details zum in einem Nachrichten-Thread gelesen werden kann. Um den Lesestatus einer Nachricht in einem Weltraum, siehe Details zum Lesestatus eines Nutzers im Gruppenbereich abrufen

Die ThreadReadState-Ressource ist eine Singleton-Ressource, die Details zu einer Die letzte gelesene Nachricht eines bestimmten Nutzers in einem Google Chat-Nachrichten-Thread.

Vorbereitung

Python

  • Python 3.6 oder höher
  • Paketverwaltungstool pip
  • Die neuesten Google-Clientbibliotheken So installieren oder aktualisieren Sie sie: Führen Sie in der Befehlszeile den folgenden Befehl aus: 
    pip3 install --upgrade google-api-python-client google-auth-oauthlib

Node.js

  • Node.js 14 oder höher
  • Der Parameter npm Paketverwaltungstool
  • Die neuesten Google-Clientbibliotheken So installieren oder aktualisieren Sie sie: Führen Sie in der Befehlszeile den folgenden Befehl aus: 
    npm install @google-cloud/local-auth @googleapis/chat

Apps Script

Thread-Lesestatus des aufrufenden Nutzers abrufen

Um Details zum Lesestatus eines Nutzers innerhalb eines Nachrichten-Threads zu erhalten, fügen Sie den Folgendes in Ihrer Anfrage angeben:

  • chat.users.readstate oder chat.users.readstate.readonly angeben Autorisierungsbereich.
  • Rufen Sie die Methode getThreadReadState-Methode am ThreadReadState-Ressource.
  • Übergeben Sie den name des abzurufenden Thread-Lesestatus. Dieser enthält eine Nutzer-ID oder Alias und einer ID des Gruppenbereichs. Das Abrufen des Thread-Lesestatus unterstützt nur das Abrufen des Lesevorgangs des aufrufenden Nutzers, der durch Festlegen eines der Folgendes:
    • Der Alias me. Beispiel: users/me/spaces/SPACE/threads/THREAD/threadReadState
    • Die Workspace-E-Mail-Adresse des aufrufenden Nutzers. Beispiel: users/user@example.com/spaces/SPACEthreads/THREAD/threadReadState
    • Die Nutzer-ID des aufrufenden Nutzers. Beispiel: users/USER/spaces/SPACE/threads/THREAD/threadReadState

Im folgenden Beispiel wird der Thread-Lesestatus des aufrufenden Nutzers abgerufen:

Python

  1. Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen chat_threadReadState_get.py

  2. Fügen Sie den folgenden Code in chat_threadReadState_get.py ein:

    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 thread 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().threads().getThreadReadState(

        # The thread 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.
        #
        # Replace THREAD with a thread name.
        # Obtain the thread name from the messages resource of Chat API.
        name='users/me/spaces/SPACE/threads/THREAD/threadReadState'

      ).execute()

    # Prints the API's response.
    print(result)

if __name__ == '__main__':
    main()

  3. Ersetzen Sie im Code Folgendes:

    • SPACE: ein Name für den Gruppenbereich, der erhalten Sie in der Methode spaces.list in der Chat API oder über die URL eines Gruppenbereichs.

    • THREAD: ein Thread-Name, der erhalten Sie in der Methode spaces.messages.get in der Chat API.

  4. Erstellen Sie das Beispiel in Ihrem Arbeitsverzeichnis und führen Sie es aus:

    python3 chat_threadReadState_get.py

Node.js

  1. Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen chat_threadReadState_get.js

  2. Fügen Sie den folgenden Code in chat_threadReadState_get ein:

    const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* Authenticates with Chat API via user credentials,
* then gets the thread read state for the calling user.
* @return {!Promise<!Object>}
*/
async function getThreadReadState() {

  /**
  * 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.threads.getThreadReadState({

    /**
    * The thread 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/threads/THREADS/threadReadState'
  });
}

/**
* Use the service endpoint to call Chat API.
*/
getThreadReadState().then(console.log);

  3. Ersetzen Sie im Code Folgendes:

    • SPACE: ein Name für den Gruppenbereich, der erhalten Sie in der Methode spaces.list in der Chat API oder über die URL eines Gruppenbereichs.

    • THREAD: ein Thread-Name, der erhalten Sie in der Methode spaces.messages.get in der Chat API.

  4. Erstellen Sie das Beispiel in Ihrem Arbeitsverzeichnis und führen Sie es aus:

    node chat_threadReadState_get.js

Apps Script

In diesem Beispiel wird die Chat API mit dem Erweiterter Chat-Dienst:

  1. Fügen Sie den Autorisierungsbereich chat.users.readstate.readonly zum Datei appsscript.json des Apps Script-Projekts:

    "oauthScopes": [
  "https://www.googleapis.com/auth/chat.users.readstate.readonly"
]

  2. Fügen Sie dem Apps Script-Projekt eine Funktion wie diese Code:

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

Die Google Chat API ruft den angegebenen Thread-Lesestatus ab und gibt eine Instanz von ThreadReadState-Ressource