Details zum Lesestatus eines Nutzers zum Gruppenbereich abrufen

In diesem Leitfaden wird die Verwendung der getSpaceReadState-Methode für das SpaceReadState der Google Chat API, um Details zu den Lesematerialien eines Nutzers zu erhalten -Zustand innerhalb eines Leerzeichens. Um den Lesestatus einer Nachricht in einem Nachrichten-Thread zu erhalten, Siehe Details zum Thread-Lesestatus eines Nutzers abrufen.

Die SpaceReadState-Ressource ist eine Singleton-Ressource, die Details zu einer die letzte gelesene Nachricht eines Nutzers in einem Google Chat-Bereich.

Vorbereitung

Python

Node.js

Apps Script

Lesestatus des aufrufenden Nutzers abrufen

Geben Sie Folgendes an, um Details zum Lesestatus eines Nutzers innerhalb eines Gruppenbereichs zu erhalten: in Ihrer Anfrage:

  • chat.users.readstate oder chat.users.readstate.readonly angeben Autorisierungsbereich.
  • Rufen Sie die Methode getSpaceReadState-Methode am SpaceReadState-Ressource.
  • Übergeben Sie die name des abzurufenden Lesestatus des Gruppenbereichs. Dieser enthält eine Nutzer-ID oder Alias und einer ID des Gruppenbereichs. Das Abrufen des Lesestatus für den Gruppenbereich unterstützt nur das Abrufen des Lesevorgangs des aufrufenden Nutzers, der durch Festlegen eines der Folgendes: <ph type="x-smartling-placeholder">
      </ph>
    • Der Alias me. Beispiel: users/me/spaces/SPACE/spaceReadState
    • Die Workspace-E-Mail-Adresse des aufrufenden Nutzers. Beispiel: users/user@example.com/spaces/SPACE/spaceReadState
    • Die Nutzer-ID des aufrufenden Nutzers. Beispiel: users/USER/spaces/SPACE/spaceReadState

Im folgenden Beispiel wird der Lesestatus des aufrufenden Nutzers abgerufen:

Python

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

  2. Fügen Sie den folgenden Code in chat_spaceReadState_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 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. 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.

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

    python3 chat_spaceReadState_get.py

Node.js

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

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

    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. 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.

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

    node chat_spaceReadState_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 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);
  }
}

Die Google Chat API ruft den angegebenen Lesestatus des Gruppenbereichs ab und gibt eine Instanz von SpaceReadState-Ressource