Gruppenbereiche auflisten

In diesem Leitfaden wird erläutert, wie Sie die Ressource list in der Ressource Space von Google Chat API verwenden, um Gruppenbereiche aufzulisten. Wenn Sie Gruppenbereiche auflisten, wird eine paginierte, filterbare Liste der Gruppenbereiche.

Die Space-Ressource ist ein Ort, an dem Personen und Chat-Apps Nachrichten senden, Dateien freigeben und gemeinsam bearbeiten. Es gibt verschiedene Arten von Gruppenbereichen:

  • Direktnachrichten (DNs) sind Unterhaltungen zwischen zwei Nutzern oder einem Nutzer und eine Chat-App.
  • Gruppenchats sind Unterhaltungen zwischen drei oder mehr Nutzern und Chat-Apps.
  • Benannte Gruppenbereiche sind dauerhafte Orte, an denen Nutzer Nachrichten senden, Dateien teilen und zusammenzuarbeiten.

Gruppenbereiche auflisten mit App-Authentifizierung führt die Gruppenbereiche auf, auf die die Chat-App Zugriff hat. Eintrag Gruppenbereiche mit Nutzerauthentifizierung führt alle Gruppenbereiche auf, auf die der authentifizierte Nutzer Zugriff hat.

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

Gruppenbereiche mit Nutzerauthentifizierung auflisten

Wenn Sie Gruppenbereiche in Google Chat auflisten möchten, müssen Sie Folgendes in Ihr Anfrage:

Im folgenden Beispiel werden benannte Gruppenbereiche und Gruppenchats aufgeführt, jedoch keine direkten gefilterte Nachrichten), die für den authentifizierten Nutzer sichtbar sind:

Python

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

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

def main():
    '''
    Authenticates with Chat API via user credentials,
    then lists named spaces and group chats (but not direct messages)
    visible to the authenticated 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.spaces().list(

          # An optional filter that returns named spaces or unnamed group chats,
          # but not direct messages (DMs).
          filter='spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'

      ).execute()

    # Prints the returned list of spaces.
    print(result)

if __name__ == '__main__':
    main()

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

    python3 chat_space_list.py

Node.js

  1. Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen list-spaces.js.

  2. Fügen Sie den folgenden Code in list-spaces.js ein:

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

/**
* List Chat spaces.
* @return {!Promise<!Object>}
*/
async function listSpaces() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.spaces.readonly',
  ];

  const authClient =
      await authenticate({scopes, keyfilePath: 'client_secrets.json'});

  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.list({
    filter: 'spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'
  });
}

listSpaces().then(console.log);

  3. Führen Sie das Beispiel in Ihrem Arbeitsverzeichnis aus:

    node list-spaces.js

Die Chat API gibt eine Fehlermeldung Array mit benannten Gruppenbereichen und Gruppenchats

Gruppenbereiche mit App-Authentifizierung auflisten

Wenn Sie Gruppenbereiche in Google Chat auflisten möchten, müssen Sie Folgendes in Ihr Anfrage:

Im folgenden Beispiel werden benannte Gruppenbereiche und Gruppenchats aufgeführt, jedoch keine direkten Nachrichten), die für die Chat App sichtbar sind:

Python

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

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

    from google.oauth2 import service_account
from apiclient.discovery import build

# Specify required scopes.
SCOPES = ['https://www.googleapis.com/auth/chat.bot']

# Specify service account details.
CREDENTIALS = (
    service_account.Credentials.from_service_account_file('credentials.json')
    .with_scopes(SCOPES)
)

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', credentials=CREDENTIALS)

# Use the service endpoint to call Chat API.
result = chat.spaces().list(

        # An optional filter that returns named spaces or unnamed
        # group chats, but not direct messages (DMs).
        filter='spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'

    ).execute()

print(result)

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

    python3 chat_space_list_app.py

Node.js

  1. Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen app-list-spaces.js.

  2. Fügen Sie den folgenden Code in app-list-spaces.js ein:

    const chat = require('@googleapis/chat');

/**
* List Chat spaces.
* @return {!Promise<!Object>}
*/
async function listSpaces() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.bot',
  ];

  const auth = new chat.auth.GoogleAuth({
    scopes,
    keyFilename: 'credentials.json',
  });

  const authClient = await auth.getClient();

  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.list({
    filter: 'spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'
  });
}

listSpaces().then(console.log);

  3. Führen Sie das Beispiel in Ihrem Arbeitsverzeichnis aus:

    node app-list-spaces.js

Die Chat API gibt ein paginiertes Array von Gruppenbereichen zurück.

Paginierung anpassen oder Liste filtern

Wenn Sie Gruppenbereiche in Google Chat auflisten möchten, müssen Sie Folgendes optional übergeben: Suchparameter zum Anpassen der Paginierung oder zum Filtern aufgelisteter Bereiche:

  • pageSize: Die maximale Anzahl von Leerzeichen, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise kleiner als dieser Wert ist. Wenn nicht angegeben, werden maximal 100 Leerzeichen zurückgegeben. Die der Maximalwert 1.000 beträgt. werden Werte über 1.000 automatisch in 1.000.
  • pageToken: Seitentoken, das von einem vorherigen Aufruf von Gruppenbereichen zur Liste empfangen wurde. Geben Sie dieses Token an, um die nachfolgende Seite abzurufen. Beim Paginieren Filterwert muss mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Übergeben eines kann das zu unerwarteten Ergebnissen führen.
  • filter: ein Abfragefilter. Details zu unterstützten Abfragen finden Sie in der spaces.list-Methode.