Gruppenbereich erstellen

In diesem Leitfaden wird die Verwendung des create() für die Ressource Space der Google Chat API, um einen benannten Bereich zu erstellen.

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.

In einem benannten Gruppenbereich können Nutzer Nachrichten senden, Dateien teilen und zusammenarbeiten. Benannte Gruppenbereiche können Chat-Apps enthalten. Namentlich benannte Gruppenbereiche bieten zusätzliche Funktionen, die nicht benannte Gruppenunterhaltungen und Direktnachrichten nicht haben. So können Administratoren von Gruppenbereichen beispielsweise Verwaltungseinstellungen anwenden, Beschreibungen hinzufügen und Personen und Apps hinzufügen oder entfernen. Nachdem Sie einen benannten Gruppenbereich erstellt haben, ist der authentifizierte Nutzer das einzige Mitglied des Gruppenbereichs. Der Gruppenbereich enthält keine anderen Personen oder Apps, auch nicht die Chat-App, mit der er erstellt wurde. Informationen zum Hinzufügen von Mitgliedern zu einem Gruppenbereich finden Sie unter Mitgliedschaft erstellen.

So erstellen Sie einen benannten Gruppenbereich mit mehreren Mitgliedern, also einen unbenannten Gruppenchat zwischen mit drei oder mehr Personen bzw. einer Unterhaltung in Direktnachrichten zwischen zwei Personen oder einem und die Chat-App, die den Chat API: Gruppenbereich einrichten .

Vorbereitung

Node.js

Python

Java

Apps Script

Benannten Gruppenbereich als Nutzer erstellen

So erstellen Sie einen benannten Gruppenbereich mit Nutzerauthentifizierung, übergeben Folgendes in Ihrer Anfrage angeben:

  • Geben Sie den Autorisierungsbereich chat.spaces.create oder chat.spaces an.
  • Rufen Sie die Methode CreateSpace() auf und übergeben Sie space als Instanz von Space mit den folgenden Feldern:
    • „spaceType“ ist auf „SPACE“ gesetzt.
    • displayName auf den für Nutzer sichtbaren Namen des Gruppenbereichs festgelegt ist.
    • Optional können Sie weitere Attribute festlegen, z. B.:
      • spaceDetails: eine für den Nutzer sichtbare Beschreibung und Richtlinien für den Gruppenbereich.
      • predefinedPermissionSettings: Vordefinierte Berechtigungen für den Gruppenbereich. Sie können beispielsweise festlegen, dass alle Mitglieder oder nur die Administratoren des Gruppenbereichs Nachrichten posten dürfen.

So erstellen Sie einen benannten Gruppenbereich:

Node.js

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

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

// This sample shows how to create a named 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: {
      spaceType: 'SPACE',
      // Replace DISPLAY_NAME here.
      displayName: 'DISPLAY_NAME'
    }
  };

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/create_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.create"]

def create_space_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.CreateSpaceRequest(
        space = {
            "space_type": 'SPACE',
            # Replace DISPLAY_NAME here.
            "display_name": 'DISPLAY_NAME'
        }
    )

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

    # Handle the response
    print(response)

create_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/CreateSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.CreateSpaceRequest;
import com.google.chat.v1.Space;

// This sample shows how to create space with user credential.
public class CreateSpaceUserCred {

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

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      CreateSpaceRequest.Builder request = CreateSpaceRequest.newBuilder()
        .setSpace(Space.newBuilder()
          .setSpaceType(Space.SpaceType.SPACE)
          // Replace DISPLAY_NAME here.
          .setDisplayName("DISPLAY_NAME"));
      Space response = chatServiceClient.createSpace(request.build());

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

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to create space with user credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.create'
 * referenced in the manifest file (appsscript.json).
 */
function createSpaceUserCred() {
  // Initialize request argument(s)
  const space = {
    spaceType: 'SPACE',
    // TODO(developer): Replace DISPLAY_NAME here
    displayName: 'DISPLAY_NAME'
  };

  // Make the request
  const response = Chat.Spaces.create(space);

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

Einen benannten Gruppenbereich als Chat-App erstellen

Die App-Authentifizierung ist nur einmal erforderlich Administratorgenehmigung

Wenn Sie einen Nutzer zu einem Gruppenbereich mit App-Authentifizierung einladen oder hinzufügen möchten, geben Sie in Ihrer Anfrage Folgendes an:

  • Geben Sie die chat.app.spaces.create- oder chat.app.spaces-Autorisierung an. Umfang.
  • Rufen Sie die Methode create-Methode am Space-Ressource.
  • Legen Sie spaceType auf SPACE fest.
  • Festlegen displayName an den für Nutzer sichtbaren Namen des Gruppenbereichs an. Im folgenden Beispiel ist displayName auf API-made festgelegt.
  • Geben Sie die Kundennummer der Google Workspace-Domain in das Feld customer ein.
  • Optional können Sie weitere Attribute für den Gruppenbereich festlegen, z. B. spaceDetails Das sind eine für Nutzer sichtbare Beschreibung und Richtlinien für den Gruppenbereich.

API-Schlüssel erstellen

Wenn Sie eine API-Methode der Entwicklervorschau aufrufen möchten, müssen Sie eine nicht öffentliche Entwicklervorschauversion des API-Discovery-Dokuments verwenden. Zur Authentifizierung der Anfrage müssen Sie einen API-Schlüssel übergeben.

Öffnen Sie zum Erstellen des API-Schlüssels das Google Cloud-Projekt Ihrer App und führen Sie die folgenden Schritte aus:

  1. Öffnen Sie in der Google Cloud Console das Menü . > APIs und Dienste > Anmeldedaten.

    Zu den Anmeldedaten

  2. Klicken Sie auf Anmeldedaten erstellen > API-Schlüssel:
  3. Ihr neuer API-Schlüssel wird angezeigt.
    • Klicken Sie auf „Kopieren“ , um den API-Schlüssel für die Verwendung im Code Ihrer App zu kopieren. Den API-Schlüssel finden Sie auch im Bereich „API-Schlüssel“ der Anmeldedaten Ihres Projekts.
    • Klicken Sie auf Schlüssel einschränken, um die erweiterten Einstellungen zu aktualisieren und die Verwendung einzuschränken. Ihres API-Schlüssels. Weitere Informationen finden Sie unter Einschränkungen für API-Schlüssel anwenden.

Skript schreiben, das die Chat API aufruft

So erstellen Sie einen benannten Bereich:

Python

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

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

def main():
    '''
    Authenticates with Chat API using app authentication,
    then creates a Chat 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, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY')

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

      # Details about the space to create.
      body = {

        # To create a named space, set spaceType to SPACE.
        'spaceType': 'SPACE',

        # The user-visible name of the space.
        'displayName': 'API-made',

        # The customer ID of the Workspace domain.
        'customer': 'CUSTOMER'
      }

      ).execute()

    # Prints details about the created space.
    print(result)

if __name__ == '__main__':
    main()

  3. Ersetzen Sie im Code Folgendes:

    • API_KEY: Der API-Schlüssel, den Sie zum Erstellen des Dienstendpunkts für die Chat API erstellt haben.

    • CUSTOMER: die Kundennummer der Domain des Leerzeichen im Format customer/{customer}, wobei {customer} die ID ist aus der Kundenressource für das Admin SDK Wenn Sie einen Gruppenbereich in derselben Google Workspace-Organisation wie die Chat-App erstellen möchten, verwenden Sie customers/my_customer.

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

    python3 chat_space_create_named_app.py

Gruppenbereich in Google Chat öffnen

Verwenden Sie die Ressourcen-ID, um den Gruppenbereich aufzurufen um die URL des Gruppenbereichs zu erstellen. Die Ressourcen-ID finden Sie im Gruppenbereich name im Google Chat-Antworttext. Wenn die name Ihres Gruppenbereichs beispielsweise spaces/1234567 ist, können Sie ihn über die folgende URL aufrufen: https://mail.google.com/chat/u/0/#chat/space/1234567.