Lesestatus eines Nutzers für den Gruppenbereich aktualisieren

In diesem Leitfaden wird die Verwendung der Methode updateSpaceReadState auf der SpaceReadState der Google Chat API, um Gruppenbereiche als gelesen oder ungelesen zu markieren.

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

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

Lesestatus des aufrufenden Nutzers für Gruppenbereich aktualisieren

Um den Lesestatus eines Nutzers innerhalb eines Gruppenbereichs zu aktualisieren, fügen Sie Folgendes in Ihre Anfrage:

  • Geben Sie den Autorisierungsbereich chat.users.readstate an.
  • Rufen Sie die Methode updateSpaceReadState-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:
    • 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
  • Übergeben Sie den updateMask, der die Aspekte des Lesestatus des Gruppenbereichs angibt, update, das die folgenden Feldpfade unterstützt:
    • lastReadTime: Der Zeitpunkt, zu dem der Lesestatus des Gruppenbereichs aktualisiert wurde. Normalerweise entspricht dies dem Zeitstempel der letzten gelesenen Nachricht, oder einen Zeitstempel, der vom Nutzer angegeben wird, um die zuletzt gelesene Position in einem Leerzeichen. Wenn lastReadTime vor dem Zeitpunkt der letzten Nachrichtenerstellung liegt, wird in der Benutzeroberfläche als ungelesen angezeigt. Um den Gruppenbereich als gelesen zu markieren, legen Sie lastReadTime auf einen beliebigen Wert, der nach der letzten Nachrichtenerstellung liegt (größer) . lastReadTime wird erzwungen, um dem Zeitpunkt der letzten Nachrichtenerstellung zu entsprechen. Beachten Sie, dass sich der Lesestatus des Gruppenbereichs nur auf den Lesestatus von Nachrichten auswirkt, die sind in der übergeordneten Unterhaltung des Gruppenbereichs sichtbar. Antworten in Threads sind von diesem Zeitstempel nicht betroffen sind, und verlassen sich stattdessen auf den Lesestatus des Threads.

Im folgenden Beispiel wird der Lesestatus des aufrufenden Nutzers aktualisiert:

Python

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

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

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()

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

Node.js

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

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

    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);

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

Apps Script

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

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

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

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

    /**
* 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);
  }
}

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