Als Google Chat-App authentifizieren

Java

• JDK 1.7 oder höher
• Das Paketverwaltungstool Maven
• Ein initialisiertes Maven-Projekt. Führen Sie den folgenden Befehl in der Befehlszeile aus, um ein neues Projekt zu initialisieren:

  mvn archetype:generate -DgroupId=com.google.chat.app.authsample -DartifactId=auth-sample-app -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false

• Eine Google Chat-App, für die interaktive Funktionen aktiviert sind. Wenn Sie eine interaktive Chat-App mit einem HTTP-Dienst erstellen möchten, folgen Sie dieser Kurzanleitung.
• Fügen Sie der Chat-App einen Gruppenbereich hinzu. Wie Sie die Chat-App hinzufügen, erfahren Sie unter Interaktive Funktionen für Google Chat-Apps testen.

Python

• Python 3.6 oder höher
• Das Paketverwaltungstool pip
• Eine Google Chat-App, für die interaktive Funktionen aktiviert sind. Wenn Sie eine interaktive Chat-App mit einem HTTP-Dienst erstellen möchten, folgen Sie dieser Kurzanleitung.
• Fügen Sie der Chat-App einen Gruppenbereich hinzu. Wie Sie die Chat-App hinzufügen, erfahren Sie unter Interaktive Funktionen für Google Chat-Apps testen.

Node.js

• Node.js 14 oder höher
• Das Paketverwaltungstool npm
• Ein initialisiertes Node.js-Projekt. Wenn Sie ein neues Projekt initialisieren möchten, erstellen Sie einen neuen Ordner, wechseln Sie zu diesem und führen Sie dann den folgenden Befehl in der Befehlszeile aus:

  npm init

• Eine Google Chat-App, für die interaktive Funktionen aktiviert sind. Wenn Sie eine interaktive Chat-App mit einem HTTP-Dienst erstellen möchten, folgen Sie dieser Kurzanleitung.
• Fügen Sie der Chat-App einen Gruppenbereich hinzu. Wie Sie die Chat-App hinzufügen, erfahren Sie unter Interaktive Funktionen für Google Chat-Apps testen.

Apps Script

• Eine Google Chat-App, für die interaktive Funktionen aktiviert sind. Wenn Sie eine interaktive Chat-App in Apps Script erstellen möchten, folgen Sie dieser Kurzanleitung.
• Fügen Sie der Chat-App einen Gruppenbereich hinzu. Wie Sie die Chat-App hinzufügen, erfahren Sie unter Interaktive Funktionen für Google Chat-Apps testen.

Java

Wenn Sie Ihrem Maven-Projekt die Google-Clientbibliotheken und andere erforderliche Abhängigkeiten hinzufügen möchten, bearbeiten Sie die Datei pom.xml im Verzeichnis Ihres Projekts und fügen Sie die folgenden Abhängigkeiten hinzu:

<dependencies>
  <!-- ... existing dependencies ... -->
  <dependency>
    <groupId>com.google.apis</groupId>
    <artifactId>google-api-services-chat</artifactId>
    <version>v1-rev20230905-2.0.0</version>
  </dependency>
  <dependency>
    <groupId>com.google.auth</groupId>
    <artifactId>google-auth-library-oauth2-http</artifactId>
    <version>1.19.0</version>
  </dependency>
  <dependency>
      <groupId>com.google.code.gson</groupId>
      <artifactId>gson</artifactId>
      <version>2.10.1</version>
  </dependency>
</dependencies>

Python

Wenn Sie die Google-Clientbibliotheken für Python noch nicht installiert haben, führen Sie den folgenden Befehl in der Befehlszeile aus:

pip3 install --upgrade google-api-python-client google-auth

Node.js

Wenn Sie Ihrem Node.js-Projekt die Google-Clientbibliotheken hinzufügen möchten, wechseln Sie in das Verzeichnis Ihres Projekts und führen Sie den folgenden Befehl in der Befehlszeile aus:

npm install "@googleapis/chat"

Apps Script

In diesem Beispiel wird die OAuth2 for Apps Script-Bibliothek verwendet, um ein JWT-Token für die Dienstkontoauthentifizierung zu generieren. So fügen Sie die Bibliothek Ihrem Apps Script-Projekt hinzu:

1. Klicken Sie links auf Editor code.
2. Klicken Sie links neben Mediatheken auf Mediathek hinzufügen add.
3. Geben Sie die Script-ID 1B7FSrk5Zi6L1rSxxTDgDEUsPzlukDsi4KGuTMorsTQHhGBzBkMun4iDF ein.
4. Klicken Sie auf Suchen und dann auf Hinzufügen.

In diesem Beispiel wird der erweiterte Chatdienst verwendet, um die Google Chat API aufzurufen. So aktivieren Sie den Dienst für Ihr Apps Script-Projekt:

1. Klicken Sie links auf Editor code.
2. Klicken Sie links neben Dienste auf Dienst hinzufügen add.
3. Wählen Sie Google Chat API aus.
4. Wählen Sie unter Version die Option v1 aus.
5. Klicken Sie auf Hinzufügen.

Java

1. Öffnen Sie die Datei src/main/java/com/google/chat/app/authsample/App.java im Verzeichnis Ihres Projekts.

2. Ersetzen Sie den Inhalt von App.java durch den folgenden Code:

   package com.google.chat.app.authsample;
   
   import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
   import com.google.api.client.http.HttpRequestInitializer;
   import com.google.api.client.json.gson.GsonFactory;
   import com.google.api.services.chat.v1.HangoutsChat;
   import com.google.api.services.chat.v1.model.Message;
   import com.google.auth.http.HttpCredentialsAdapter;
   import com.google.auth.oauth2.GoogleCredentials;
   
   /**
    * Authenticates with Chat API using service account credentials,
    * then creates a Chat message.
    */
   public class App {
       // Specify required scopes.
       private static final String CHAT_SCOPE = "https://www.googleapis.com/auth/chat.bot";
   
       // Specify service account details.
       private static final String PRIVATE_KEY_RESOURCE_URI = "/credentials.json";
   
       public static void main( String[] args ) {
           try {
               // Run app.
               Message response = App.createChatMessage();
               // Print details about the created message.
               System.out.println(response);
           } catch (Exception e) {
               e.printStackTrace();
           }
       }
   
       private static Message createChatMessage() throws Exception {
           // Build the Chat API client and authenticate with the service account.
           GoogleCredentials credentials = GoogleCredentials.fromStream(
               App.class.getResourceAsStream(PRIVATE_KEY_RESOURCE_URI))
               .createScoped(CHAT_SCOPE);
           HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(credentials);
           HangoutsChat chatService = new HangoutsChat.Builder(
               GoogleNetHttpTransport.newTrustedTransport(),
               GsonFactory.getDefaultInstance(),
               requestInitializer)
               .setApplicationName("auth-sample-app")
               .build();
   
           // The space to create the message in.
           //
           // Replace SPACE_NAME with a space name.
           // Obtain the space name from the spaces resource of Chat API,
           // or from a space's URL.
           String spaceName = "spaces/SPACE_NAME";
   
           // Create a Chat message.
           Message message = new Message().setText("Hello, world!");
           return chatService.spaces().messages().create(spaceName, message).execute();
       }
   }
   

3. Ersetzen Sie im Code SPACE_NAME durch den Namen eines Gruppenbereichs. Sie können ihn über die Methode spaces.list in der Chat API oder über die URL eines Gruppenbereichs abrufen.

4. Erstellen Sie im Verzeichnis Ihres Projekts ein neues Unterverzeichnis mit dem Namen resources.

5. Achten Sie darauf, dass die Datei mit dem privaten Schlüssel für Ihr Dienstkonto den Namen credentials.json hat, und kopieren Sie sie in das Unterverzeichnis resources.

6. Wenn Sie Maven so konfigurieren möchten, dass die Datei mit dem privaten Schlüssel in das Projektpaket aufgenommen wird, bearbeiten Sie die Datei pom.xml im Verzeichnis Ihres Projekts und fügen Sie dem Abschnitt <build> die folgende Konfiguration hinzu:

   <build>
     <!-- ... existing configurations ... -->
     <resources>
       <resource>
         <directory>resources</directory>
       </resource>
     </resources>
   </build>
   

7. Um Maven so zu konfigurieren, dass die Abhängigkeiten in das Projektpaket aufgenommen und die Hauptklasse der Anwendung ausgeführt wird, bearbeiten Sie die Datei pom.xml im Verzeichnis Ihres Projekts und fügen Sie dem Abschnitt <plugins> die folgende Konfiguration hinzu:

   <plugins>
     <!-- ... existing configurations ... -->
     <plugin>
       <artifactId>maven-assembly-plugin</artifactId>
       <configuration>
         <archive>
           <manifest>
             <mainClass>com.google.chat.app.authsample.App</mainClass>
           </manifest>
         </archive>
         <descriptorRefs>
           <descriptorRef>jar-with-dependencies</descriptorRef>
         </descriptorRefs>
       </configuration>
     </plugin>
   </plugins>
   

Python

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

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

   from apiclient.discovery import build
   from google.oauth2 import service_account
   
   # Specify required scopes.
   SCOPES = ['https://www.googleapis.com/auth/chat.bot']
   
   # Specify service account details.
   creds = service_account.Credentials.from_service_account_file(
       'credentials.json', scopes=SCOPES)
   
   # Build the URI and authenticate with the service account.
   chat = build('chat', 'v1', credentials=creds)
   
   # Create a Chat message.
   result = chat.spaces().messages().create(
   
       # The space to create the message in.
       #
       # Replace SPACE_NAME with a space name.
       # Obtain the space name from the spaces resource of Chat API,
       # or from a space's URL.
       parent='spaces/SPACE_NAME',
   
       # The message to create.
       body={'text': 'Hello, world!'}
   
   ).execute()
   
   # Prints details about the created message.
   print(result)
   

3. Ersetzen Sie im Code SPACE_NAME durch den Namen eines Gruppenbereichs. Sie können ihn über die Methode spaces.list in der Chat API oder über die URL eines Gruppenbereichs abrufen. Die Datei mit dem privaten Schlüssel für Ihr Dienstkonto muss den Namen credentials.json haben.

Node.js

1. Erstellen Sie im Verzeichnis Ihres Projekts eine Datei mit dem Namen chat_app_auth.js.

2. Fügen Sie in chat_app_auth.js den folgenden Code ein:

   const chat = require('@googleapis/chat');
   
   async function createMessage() {
     const auth = new chat.auth.GoogleAuth({
   
       // Specify service account details.
       keyFilename: 'credentials.json',
   
       // Specify required scopes.
       scopes: ['https://www.googleapis.com/auth/chat.bot']
   
     });
     const authClient = await auth.getClient();
   
     // Create the Chat API client and authenticate with the service account.
     const chatClient = await chat.chat({
       version: 'v1',
       auth: authClient
     });
   
     // Create a Chat message.
     const result = await chatClient.spaces.messages.create({
   
       // The space to create the message in.
       //
       // Replace SPACE_NAME with a space name.
       // Obtain the space name from the spaces resource of Chat API,
       // or from a space's URL.
       parent: 'spaces/SPACE_NAME',
   
       // The message to create.
       requestBody: { 'text': 'Hello, world!' }
   
     });
     return result;
   }
   
   // Execute function then print details about the created message.
   createMessage().then(console.log);
   

3. Ersetzen Sie im Code SPACE_NAME durch den Namen eines Gruppenbereichs. Sie können ihn über die Methode spaces.list in der Chat API oder über die URL eines Gruppenbereichs abrufen. Die Datei mit dem privaten Schlüssel für Ihr Dienstkonto muss den Namen credentials.json haben.

Apps Script

1. Bearbeiten Sie im Apps Script-Editor die Datei appsscript.json und fügen Sie den OAuth-Bereich hinzu, der für externe Anfragen zum Abrufen des OAuth-Tokens des Dienstkontos erforderlich ist:

     "oauthScopes": [
       "https://www.googleapis.com/auth/script.external_request"
     ]
   

2. Speichern Sie den folgenden Code in einer Datei mit dem Namen ChatAppAuth.gs in Ihrem Apps Script-Projekt:

   // Specify the contents of the file credentials.json.
   const CREDENTIALS = CREDENTIALS;
   
   const SCOPE = 'https://www.googleapis.com/auth/chat.bot';
   
   // The space to create the message in.
   //
   // Replace SPACE_NAME with a space name.
   // Obtain the space name from the spaces resource of Chat API,
   // or from a space's URL.
   const PARENT = 'spaces/SPACE_NAME'
   
   /**
    * Authenticates with Chat API using app credentials, then posts a message.
    */
   function createMessageWithAppCredentials() {
     try {
       const service = getService_();
       if (!service.hasAccess()) {
         console.error(service.getLastError());
         return;
       }
   
       // Specify the message to create.
       const message = {'text': 'Hello world!'};
   
       // Call Chat API with a service account to create a message.
       const result = Chat.Spaces.Messages.create(
           message,
           PARENT,
           {},
           // Authenticate with the service account token.
           {'Authorization': 'Bearer ' + service.getAccessToken()});
   
       // Log details about the created message.
       console.log(result);
   
     } catch (err) {
       // TODO (developer) - Handle exception.
       console.log('Failed to create message with error %s', err.message);
     }
   }
   
   /**
    * Configures the OAuth library to authenticate with the service account.
    */
   function getService_() {
     return OAuth2.createService(CREDENTIALS.client_email)
         .setTokenUrl('https://oauth2.googleapis.com/token')
         .setPrivateKey(CREDENTIALS.private_key)
         .setIssuer(CREDENTIALS.client_email)
         .setSubject(CREDENTIALS.client_email)
         .setScope(SCOPE)
         .setPropertyStore(PropertiesService.getScriptProperties());
   }
   

3. Ersetzen Sie im Code CREDENTIALS durch den Inhalt der Datei credentials.json.

4. Ersetzen Sie im Code SPACE_NAME durch den Namen eines Gruppenbereichs. Sie können ihn über die Methode spaces.list in der Chat API oder über die URL eines Gruppenbereichs abrufen.

Java

mvn compile assembly:single
java -jar target/auth-sample-app-1.0-SNAPSHOT-jar-with-dependencies.jar

Python

python3 chat_app_auth.py

Node.js

node chat_app_auth.js

Apps Script

Öffnen Sie die Datei ChatAppAuth.gs im Apps Script-Editor und klicken Sie auf Ausführen.