Details zu einem Gruppenbereich abrufen

In diesem Leitfaden wird erläutert, wie Sie die Methode get für eine Space-Ressource des Google Chat API, um Details zu einem Gruppenbereich aufzurufen, z. B. Anzeigename, Beschreibung und Richtlinien.

Die Space-Ressource ist ein Ort, an dem Personen und Chat-Apps Nachrichten senden können, 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.

Authentifizierung mit App-Authentifizierung kann eine Chat-App Gruppenbereiche abrufen, Die Chat-App hat in Google Chat Zugriff auf (z. B. Gruppenbereichen, in denen die App Mitglied ist). Authentifizierung mit Nutzerauthentifizierung können Sie Gruppenbereiche abrufen, auf die der authentifizierte Nutzer Zugriff hat.

Vorbereitung

Python

Node.js

Space anfordern

Wenn Sie in Google Chat einen Gruppenbereich erstellen möchten, müssen Sie in Ihrem Anfrage:

  • Mit App-Authentifizierung Geben Sie den Autorisierungsbereich chat.bot an. Mit Nutzerauthentifizierung geben Sie den Autorisierungsbereich chat.spaces.readonly oder chat.spaces an.
  • Rufen Sie die Methode get-Methode am Space-Ressource, und übergeben den name des zu erhaltenden Bereichs. Ermitteln Sie den Namen des Gruppenbereichs aus den Gruppenbereichen in Google Chat oder über die URL eines Gruppenbereichs.

Details zum Gruppenbereich mit Nutzerauthentifizierung abrufen

So rufen Sie Details zum Gruppenbereich mit Nutzerauthentifizierung:

Python

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

  2. Fügen Sie den folgenden Code in chat_space_get_user.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 gets details about a specified space.
    '''

    # 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().get(

          # The space to get.
          #
          # Replace SPACE with a space name.
          # Obtain the space name from the spaces resource of Chat API,
          # or from a space's URL.
          name='spaces/SPACE'

      ).execute()

    # Prints details about the space.
    print(result)

if __name__ == '__main__':
    main()

  3. Ersetzen Sie im Code SPACE durch einen Namen 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_space_get_user.py

Node.js

  1. Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen get-space.js.

  2. Fügen Sie den folgenden Code in get-space.js ein:

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

/**
* Gets details about a Chat space by name.
* @return {!Object}
*/
async function getSpace() {
  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.get({name: 'spaces/SPACE'});
}

getSpace().then(console.log);

  3. Ersetzen Sie im Code SPACE durch einen Namen für den Gruppenbereich, der erhalten Sie in der Methode spaces.list in der Chat API oder über die URL eines Gruppenbereichs.

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

    node get-space.js

Die Chat API gibt eine Instanz von Space, das den angegebenen Bereich angibt.

Details zum Gruppenbereich mit App-Authentifizierung abrufen

So rufen Sie Details zum Gruppenbereich mit App-Authentifizierung:

Python

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

  2. Fügen Sie den folgenden Code in chat_space_get_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().get(

    # The space to get.
    #
    # Replace SPACE with a space name.
    # Obtain the space name from the spaces resource of Chat API,
    # or from a space's URL.
    name='spaces/SPACE'

).execute()

print(result)

  3. Ersetzen Sie im Code SPACE durch einen Namen für den Gruppenbereich, der erhalten Sie in der spaces.list()-Methode 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_space_get_app.py

Node.js

  1. Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen app-get-space.js.

  2. Fügen Sie den folgenden Code in app-get-space.js ein:

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

/**
* Gets details about a Chat space by name.
* @return {!Promise<!Object>}
*/
async function getSpace() {
  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.get({name: 'spaces/SPACE'});
}

getSpace().then(console.log);

  3. Ersetzen Sie im Code SPACE durch einen Namen für den Gruppenbereich, der erhalten Sie in der Methode spaces.list in der Chat API oder über die URL eines Gruppenbereichs.

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

    node app-get-space.js

Die Chat API gibt eine Instanz von Space das den angegebenen Bereich enthält.