Gruppenbereich aktualisieren

In diesem Leitfaden wird erläutert, wie Sie die Methode patch für die Ressource Space von die Google Chat API verwenden, um einen Gruppenbereich zu aktualisieren. Aktualisieren Sie einen Gruppenbereich, um Attribute zu einem wie der für den Nutzer sichtbare Anzeigename, die 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.

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

Gruppenbereich aktualisieren

Um einen vorhandenen Gruppenbereich in Google Chat zu aktualisieren, müssen Sie Folgendes übergeben: in Ihrer Anfrage:

  • Geben Sie den Autorisierungsbereich chat.spaces an.
  • Rufen Sie die Methode patch-Methode für die Ressource Space In in Ihrer Anfrage geben Sie das Feld name, das Feld updateMask Feld mit mindestens einem zu aktualisierenden Feld und body durch die aktualisierten Informationen zum Gruppenbereich.

Sie können Einstellungen wie den Anzeigenamen, den Gruppenbereichstyp, den Verlaufsstatus und mehr. Alle Felder, die Sie aktualisieren können, finden Sie unter in der Referenzdokumentation.

So aktualisieren Sie das Feld spaceDetails eines vorhandenen Gruppenbereichs:

Python

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

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

def main():
    '''
    Authenticates with Chat API via user credentials,
    then updates the specified space description and guidelines.
    '''

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

      # The space to update, and the updated space details.
      #
      # 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',
      updateMask='spaceDetails',
      body={

        'spaceDetails': {
          'description': 'This description was updated with Chat API!',
          'guidelines': 'These guidelines were updated with Chat API!'
        }

      }

    ).execute()

    # Prints details about the updated 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_update.py

Node.js

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

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

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

/**
* Updates a Chat space with the description and guidelines.
* @return {!Promise<!Object>}
*/
async function updateSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.spaces',
  ];

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

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

  return await chatClient.spaces.patch({
    name: 'spaces/SPACE',
    updateMask: 'spaceDetails',
    requestBody: {
      spaceDetails: {
        description: 'This description was updated with Chat API!',
        guidelines: 'These guidelines were updated with Chat API!'
      },
    }
  });
}

updateSpace().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 update-space.js

Die Google Chat API gibt eine Instanz des Space-Ressource für die Aktualisierungen.