Gruppenbereich aktualisieren

In diesem Leitfaden wird erläutert, wie Sie die patch() Methode für die Space Ressource der Google Chat API verwenden, um einen Gruppenbereich zu aktualisieren. Sie können einen Gruppenbereich aktualisieren, um Attribute wie den für Nutzer sichtbaren Anzeigenamen, die Beschreibung und die Richtlinien zu ändern.

Wenn Sie Google Workspace-Administrator sind, können Sie die Methode patch() aufrufen, um einen vorhandenen Gruppenbereich in Ihrer Google Workspace-Organisation zu aktualisieren.

Die Ressource Space stellt einen Ort dar, an dem Nutzer und Chat-Apps Nachrichten senden, Dateien teilen und zusammenarbeiten können. Es gibt verschiedene Arten von Gruppenbereichen:

  • Direktnachrichten (DN) sind Unterhaltungen zwischen zwei Nutzern oder einem Nutzer und einer Chat-App.
  • Gruppenchats sind Unterhaltungen zwischen mindestens drei Nutzern und Chat-Apps.
  • Benannte Gruppenbereiche sind dauerhafte Orte, an denen Nutzer Nachrichten senden, Dateien teilen und zusammenarbeiten können.

Vorbereitung

Node.js

  • Ein Google Chat-Gruppenbereich. Informationen zum Erstellen eines Gruppenbereichs mit der Google Chat API finden Sie unter Gruppenbereich erstellen. Informationen zum Erstellen eines Gruppenbereichs in Google Chat finden Sie in der Hilfe.

Python

  • Ein Google Chat-Gruppenbereich. Informationen zum Erstellen eines Gruppenbereichs mit der Google Chat API finden Sie unter Gruppenbereich erstellen. Informationen zum Erstellen eines Gruppenbereichs in Google Chat finden Sie in der Hilfe.

Java

  • Ein Google Chat-Gruppenbereich. Informationen zum Erstellen eines Gruppenbereichs mit der Google Chat API finden Sie unter Gruppenbereich erstellen. Informationen zum Erstellen eines Gruppenbereichs in Google Chat finden Sie in der Hilfe.

Apps Script

  • Ein Google Chat-Gruppenbereich. Informationen zum Erstellen eines Gruppenbereichs mit der Google Chat API finden Sie unter Gruppenbereich erstellen. Informationen zum Erstellen eines Gruppenbereichs in Google Chat finden Sie in der Hilfe.

Gruppenbereich als Nutzer aktualisieren

Wenn Sie einen vorhandenen Gruppenbereich in Google Chat mit Nutzerauthentifizierung aktualisieren möchten, übergeben Sie Folgendes in Ihrer Anfrage:

  • Geben Sie den Autorisierungsbereich chat.spaces an.
  • Rufen Sie die UpdateSpace() Methode auf. In Ihrer Anfrage geben Sie das Feld name des Gruppenbereichs, das Feld updateMask mit einem oder mehreren zu aktualisierenden Feldern und einen body mit den aktualisierten Informationen zum Gruppenbereich an.

Sie können beispielsweise den Anzeigenamen, den Gruppenbereichstyp und den Verlauf aktualisieren. Eine Liste aller Felder, die Sie aktualisieren können, finden Sie in der Referenzdokumentation.

So aktualisieren Sie das Feld displayName eines vorhandenen Gruppenbereichs:

Node.js

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

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.spaces'];

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

  // Initialize request argument(s)
  const request = {
    space: {
      // Replace SPACE_NAME here
      name: 'spaces/SPACE_NAME',
      displayName: 'New space display name',
    },
    // The field paths to update. Separate multiple values with commas or use `*`
    // to update all field paths.
    updateMask: {
      // The field paths to update.
      paths: ['display_name'],
    },
  };

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

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

await main();

Python

chat/client-libraries/cloud/update_space_user_cred.py
from authentication_utils import create_client_with_user_credentials
from google.apps import chat_v1 as google_chat

SCOPES = ["https://www.googleapis.com/auth/chat.spaces"]

# This sample shows how to update a space with user credential
def update_space_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.UpdateSpaceRequest(
        space = {
            # Replace SPACE_NAME here
            'name': 'spaces/SPACE_NAME',
            'display_name': 'New space display name'
        },
        # The field paths to update. Separate multiple values with commas.
        update_mask = 'displayName'
    )

    # Make the request
    response = client.update_space(request)

    # Handle the response
    print(response)

update_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/UpdateSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.UpdateSpaceRequest;
import com.google.chat.v1.Space;
import com.google.protobuf.FieldMask;

// This sample shows how to update space with user credential.
public class UpdateSpaceUserCred {

  private static final String SCOPE =
    "https://www.googleapis.com/auth/chat.spaces";

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      UpdateSpaceRequest.Builder request = UpdateSpaceRequest.newBuilder()
        .setSpace(Space.newBuilder()
          // Replace SPACE_NAME here.
          .setName("spaces/SPACE_NAME")
          .setDisplayName("New space display name"))
        .setUpdateMask(FieldMask.newBuilder()
          // The field paths to update.
          .addPaths("display_name"));
      Space response = chatServiceClient.updateSpace(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to update a space with user credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces'
 * referenced in the manifest file (appsscript.json).
 */
function updateSpaceUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here
  const name = "spaces/SPACE_NAME";
  const space = {
    displayName: "New space display name",
  };
  // The field paths to update. Separate multiple values with commas or use
  // `*` to update all field paths.
  const updateMask = "displayName";

  // Make the request
  const response = Chat.Spaces.patch(space, name, {
    updateMask: updateMask,
  });

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

Ersetzen Sie SPACE_NAME durch die ID aus dem Feld name des Gruppenbereichs, um dieses Beispiel auszuführen. Sie können die ID abrufen, indem Sie die ListSpaces() Methode aufrufen oder die URL des Gruppenbereichs verwenden.

Die Google Chat API gibt eine Instanz von Space zurück, die die Aktualisierungen widerspiegelt.

Gruppenbereich als Google Workspace-Administrator aktualisieren

Wenn Sie Google Workspace-Administrator sind, können Sie die Methode UpdateSpace() aufrufen, um einen beliebigen Gruppenbereich in Ihrer Google Workspace-Organisation zu aktualisieren.

So rufen Sie diese Methode als Google Workspace-Administrator auf:

  • Rufen Sie die Methode mit der Nutzerauthentifizierung auf und geben Sie einen Autorisierungsbereich an, der den Aufruf der Methode mit Administratorberechtigungenunterstützt.
  • Geben Sie in Ihrer Anfrage den Abfrageparameter useAdminAccess auf true an.

Weitere Informationen und Beispiele finden Sie unter Google Chat-Gruppenbereiche als Google Workspace-Administrator verwalten.

Gruppenbereich als Chat-App aktualisieren

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

Wenn Sie einen vorhandenen Gruppenbereich in Google Chat mit App-Authentifizierung, aktualisieren möchten, übergeben Sie Folgendes in Ihrer Anfrage:

  • Geben Sie den Autorisierungsbereich chat.app.spaces an. Mit der App-Authentifizierung können Sie nur Gruppenbereiche aktualisieren, die von Chat-Apps erstellt wurden.
  • Rufen Sie die patch Methode für die Space Ressource auf. In Ihrer Anfrage geben Sie das Feld name des Gruppenbereichs, das Feld updateMask mit einem oder mehreren zu aktualisierenden Feldern und einen body mit den aktualisierten Informationen zum Gruppenbereich an.

Sie können beispielsweise den Anzeigenamen, den Gruppenbereichstyp, den Verlauf und die Berechtigungseinstellungen aktualisieren. Eine Liste aller Felder, die Sie aktualisieren können, finden Sie in der Referenzdokumentation.

Skript zum Aufrufen der Chat API schreiben

So aktualisieren Sie das Feld spaceDetails eines vorhandenen Gruppenbereichs:

Python

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

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

    from google.oauth2 import service_account
from apiclient.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.app.spaces"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then updates the specified space description and guidelines.
    '''

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

    • SPACE durch einen Gruppenbereichsnamen, den Sie mit der spaces.list Methode in der Chat API oder über die URL eines Gruppenbereichs abrufen können.

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

    python3 chat_space_update_app.py

Die Google Chat API gibt eine Instanz der Space Ressource zurück, die die Aktualisierungen widerspiegelt.

Einschränkungen und Überlegungen