Details zu einem Termin in einem Google Chat-Bereich abrufen

In diesem Leitfaden wird erläutert, wie Sie die get() Methode für die Ressource SpaceEvent der Google Chat API verwenden, um Details zu einem Ereignis aus einem Google Chat-Gruppenbereich abzurufen.

Die SpaceEvent Ressource stellt eine Änderung an einem Gruppenbereich oder seinen untergeordneten Ressourcen dar, z. B. Nachrichten, Reaktionen und Mitgliedschaften. Informationen zu den unterstützten Ereignistypen finden Sie im eventType Feld der SpaceEvent Ressource Referenzdokumentation.

Sie können Ereignisse bis zu 28 Tage vor dem Zeitpunkt der Anfrage anfordern. Das Ereignis enthält die aktuelle Version der geänderten Ressource. Wenn Sie beispielsweise ein Ereignis zu einer neuen Nachricht anfordern, die Nachricht aber später aktualisiert wurde, gibt der Server die aktualisierte Ressource Message in der Ereignisnutzlast zurück.

Zum Aufrufen dieser Methode müssen Sie die Nutzerauthentifizierung verwenden. Um ein Ereignis abzurufen, muss der authentifizierte Nutzer Mitglied des Gruppenbereichs sein, in dem das Ereignis aufgetreten ist.

Vorbereitung

Node.js

Python

Details zu einem Gruppenbereich-Ereignis abrufen (Nutzerauthentifizierung)

Wenn Sie Details zu einem Gruppenbereich-Ereignis in Google Chat abrufen möchten, übergeben Sie Folgendes in Ihrer Anfrage:

  • Geben Sie in Ihrer Anfrage einen Autorisierungsbereich an, der den Ereignistyp unterstützt. Wählen Sie möglichst den restriktivsten Bereich aus, der es Ihrer App weiterhin ermöglicht, zu funktionieren.
  • Rufen Sie die GetSpaceEvent() Methode auf und übergeben Sie den name des Gruppenbereich-Ereignisses, das Sie abrufen möchten.

Im folgenden Beispiel wird ein Gruppenbereich-Ereignis abgerufen:

Node.js

In diesem Node.js-Codebeispiel wird die Chat RPC API verwendet.

chat/client-libraries/cloud/get-space-event-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

// Replace SCOPE_NAME here with an authorization scope based on the event type
const USER_AUTH_OAUTH_SCOPES = ['SCOPE_NAME'];

// This sample shows how to get space event with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(
    USER_AUTH_OAUTH_SCOPES,
  );

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME and SPACE_EVENT_NAME here
    name: 'spaces/SPACE_NAME/spaceEvents/SPACE_EVENT_NAME',
  };

  // Make the request
  const response = await chatClient.getSpaceEvent(request);

  // Handle the response
  console.log(response);
}

await main();

Ersetzen Sie in diesem Beispiel Folgendes:

  • SCOPE_NAME: ein Autorisierungsbereich basierend auf dem Ereignistyp. Wenn Sie beispielsweise ein Gruppenbereich-Ereignis zu einer neuen Mitgliedschaft abrufen, verwenden Sie den Bereich chat.memberships.readonly im Format https://www.googleapis.com/auth/chat.memberships.readonly. Sie können den Ereignistyp mit der ListSpaceEvents() Methode abrufen. Informationen zur Verwendung dieser Methode finden Sie unter Ereignisse aus einem Gruppenbereich auflisten.
  • SPACE_NAME: die ID aus dem Gruppenbereichs name. Sie können die ID abrufen, indem Sie die ListSpaces() Methode aufrufen oder die URL des Gruppenbereichs verwenden.
  • SPACE_EVENT_NAME: die ID aus dem Gruppenbereich-Ereignisses name. Sie können die ID mit der ListSpaceEvents() Methode abrufen. Informationen zur Verwendung dieser Methode finden Sie unter Ereignisse aus einem Gruppenbereich auflisten.

Die Chat API gibt eine Instanz von SpaceEvent mit Details zum Ereignis zurück.

Details zu einem Gruppenbereich-Ereignis abrufen (Authentifizierung der Chat-App)

Für die App-Authentifizierung ist eine einmalige Administratorgenehmigung erforderlich.

Wenn Sie Details zu einem Gruppenbereich-Ereignis aus einem Gruppenbereich mit App-Authentifizierung über die Chat REST API, abrufen möchten, übergeben Sie Folgendes in Ihrer Anfrage:

  • Geben Sie in Ihrer Anfrage einen oder mehrere Autorisierungsbereiche an, um jeden Ereignistyp zu unterstützen. Wählen Sie möglichst den restriktivsten Bereich aus, der es Ihrer App weiterhin ermöglicht, zu funktionieren. Weitere Informationen zur Auswahl eines Bereichs finden Sie unter Authentifizierung und Autorisierung.
    • https://www.googleapis.com/auth/chat.app.memberships
    • https://www.googleapis.com/auth/chat.app.memberships.readonly
    • https://www.googleapis.com/auth/chat.app.messages.readonly
    • https://www.googleapis.com/auth/chat.app.spaces
    • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • Rufen Sie die get Methode für die spaceEvents Ressource auf.
  • Übergeben Sie den name des Gruppenbereichs, aus dem Sie Ereignisdetails abrufen möchten.

Skript zum Aufrufen der Chat API schreiben

So rufen Sie Details zu einem Gruppenbereich-Ereignis mit App-Authentifizierung und der Chat REST API ab:

Python

In diesem Python-Codebeispiel wird die Chat REST API verwendet.

  1. Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen chat_spaceevents_get_app.py.
  2. Fügen Sie den folgenden Code in chat_spaceevents_get_app.py ein:

    from google.oauth2 import service_account
    from apiclient.discovery import build
    
    # Define your app's authorization scopes.
    # Set authorization scopes based on the
    # event type. For example, if you are getting a space event
    # about a new membership, use the `chat.app.memberships` scope.
    #
    # When modifying these scopes, delete the file token.json, if it exists.
    SCOPES = ["https://www.googleapis.com/auth/chat.app.memberships",
              "https://www.googleapis.com/auth/chat.app.memberships.readonly",
              "https://www.googleapis.com/auth/chat.app.messages.readonly",
              "https://www.googleapis.com/auth/chat.app.spaces",
              "https://www.googleapis.com/auth/chat.app.spaces.readonly"]
    
    def main():
        '''
        Authenticates with Chat API using app authentication,
        then lists space events from a specified space.
        '''
    
        # Specify service account details.
        creds = (
            service_account.Credentials.from_service_account_file('credentials.json')
            .with_scopes(SCOPES)
        )
    
        # Build a service endpoint for Chat API.
        chat = build('chat', 'v1', credentials=creds)
    
        # Use the service endpoint to call Chat API.
        result = chat.spaces().spaceEvents().get(
    
            # The space to get event details from.
            #
            # Replace SPACE_NAME with a space name.
            # Obtain the space name from the spaces resource of Chat API,
            # or from a space's URL.
            name='spaces/SPACE_NAME/spaceEvents/SPACE_EVENT_NAME',
    
        ).execute()
    
        # Print Chat API's response in your command line interface.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. Ersetzen Sie im Code Folgendes:

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

    python3 chat_spaceevents_get_app.py

Die Chat API gibt eine Liste von paginierte Liste von Gruppenbereich-Ereignissen zu neuen Mitgliedschaften und Nachrichten zurück.