Als Google Chat-Nutzer authentifizieren und autorisieren

Java

• JDK 1.7 oder höher
• Das Paketverwaltungstool Maven

• Ein initialisiertes Maven-Projekt. Führen Sie in der Befehlszeile den folgenden Befehl 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
  

Python

• Python 3.6 oder höher
• Das Paketverwaltungstool pip

Node.js

• Node.js
• Das npm-Paketverwaltungstool

• Ein initialisiertes Node.js-Projekt. Zum Initialisieren eines neuen Projekts müssen Sie einen neuen Ordner erstellen und dorthin wechseln. Führen Sie dann in der Befehlszeile den folgenden Befehl aus:

  npm init
  

Apps Script

• Ein Apps Script-Projekt, das mit Ihrem Google Cloud-Projekt verbunden ist. Informationen zum Initialisieren eines Apps Script-Projekts finden Sie unter Kurzanleitung zur Google Apps Script Chat-App.

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.oauth-client</groupId>
    <artifactId>google-oauth-client-jetty</artifactId>
    <version>1.34.1</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-oauthlib

Node.js

Um Ihrem Node.js-Projekt die Google-Clientbibliotheken und andere erforderliche Abhängigkeiten hinzuzufügen, wechseln Sie in das Verzeichnis Ihres Projekts und führen Sie in der Befehlszeile den folgenden Befehl aus:

npm install "@googleapis/chat" open server-destroy

Apps Script

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 im Verzeichnis Ihres Projekts die Datei src/main/java/com/google/chat/app/authsample/App.java.

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

   package com.google.chat.app.authsample;
   
   import com.google.api.client.auth.oauth2.Credential;
   import com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp;
   import com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver;
   import com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow;
   import com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets;
   import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
   import com.google.api.client.http.HttpTransport;
   import com.google.api.client.json.JsonFactory;
   import com.google.api.client.json.gson.GsonFactory;
   import com.google.api.client.util.store.FileDataStoreFactory;
   import com.google.api.services.chat.v1.HangoutsChat;
   import com.google.api.services.chat.v1.model.Space;
   
   import java.io.InputStreamReader;
   import java.util.Collection;
   import java.util.Collections;
   
   /**
    * Authenticates with Chat API via user credentials, then creates a Chat space.
    */
   public class App {
       // Application OAuth credentials.
       private static final String KEYS_RESOURCE_URI = "/client_secrets.json";
   
       // Define your app's authorization scopes.
       private static final Collection<String> SCOPES =
           Collections.singleton("https://www.googleapis.com/auth/chat.spaces.create");
   
       // Directory to store user credentials.
       private static final java.io.File DATA_STORE_DIR =
           new java.io.File(System.getProperty("user.home"), ".store/auth-sample-app");
   
       // Global instance of the JSON factory.
       private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
   
       // Global instance of the HTTP transport.
       private static HttpTransport httpTransport;
   
       // Global instance of the DataStoreFactory. The best practice is to make it a single
       // globally shared instance across your application.
       private static FileDataStoreFactory dataStoreFactory;
   
       public static void main( String[] args ) {
           try {
               // Run app.
               httpTransport = GoogleNetHttpTransport.newTrustedTransport();
               dataStoreFactory = new FileDataStoreFactory(DATA_STORE_DIR);
               Credential userCredential = authorize();
               Space response = App.createChatSpace(userCredential);
               // Print details about the created space.
               System.out.println(response);
           } catch (Exception e) {
               e.printStackTrace();
           }
       }
   
       /**
        * Authorizes the installed application to access user's protected data.
        */
       private static Credential authorize() throws Exception {
           // Load client secrets.
           GoogleClientSecrets clientSecrets = GoogleClientSecrets.load(JSON_FACTORY,
               new InputStreamReader(App.class.getResourceAsStream("/client_secrets.json")));
           // Set up authorization code flow.
           GoogleAuthorizationCodeFlow flow = new GoogleAuthorizationCodeFlow.Builder(
               httpTransport, JSON_FACTORY, clientSecrets, SCOPES)
               .setDataStoreFactory(dataStoreFactory)
               .build();
           // Authorize.
           return new AuthorizationCodeInstalledApp(flow, new LocalServerReceiver()).authorize("user");
       }
   
       /**
        * Creates a Chat space.
        */
       private static Space createChatSpace(Credential userCredential) throws Exception {
           // Build the Chat API client and authenticate with the user account.
           HangoutsChat chatService = new HangoutsChat.Builder(
               httpTransport, JSON_FACTORY, userCredential)
               .setApplicationName("auth-sample-app")
               .build();
   
           // Create a Chat space.
           Space space = new Space()
               // To create a named space, set spaceType to SPACE.
               .setSpaceType("SPACE")
               // The user-visible name of the space.
               .setDisplayName("API-made");
           return chatService.spaces().create(space).execute();
       }
   }
   

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

4. Kopieren Sie die Datei client_secrets.json in das Unterverzeichnis resources.

5. Um Maven so zu konfigurieren, dass die Datei mit den Clientschlüsseln in das Projektpaket aufgenommen wird, bearbeiten Sie die Datei pom.xml im Verzeichnis Ihres Projekts und fügen Sie die folgende Konfiguration im Abschnitt <build> hinzu:

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

6. Wenn Sie Maven so konfigurieren möchten, dass die Abhängigkeiten in das Projektpaket aufgenommen und die Hauptklasse Ihrer Anwendung ausgeführt wird, bearbeiten Sie die Datei pom.xml im Verzeichnis Ihres Projekts und fügen Sie die folgende Konfiguration in den Abschnitt <plugins> ein:

   <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. Speichern Sie den folgenden Code in einer Datei mit dem Namen chat_space_create_named.py im selben Verzeichnis, das auch client_secrets.json enthält:

   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.create"]
   
   def main():
     '''
     Authenticates with Chat API via user credentials,
     then creates a Chat space.
     '''
   
     flow = InstalledAppFlow.from_client_secrets_file(
                       'client_secrets.json', SCOPES)
     creds = flow.run_local_server()
   
     # Build a service endpoint for Chat API.
     service = build('chat', 'v1', credentials=creds)
   
     # Use the service endpoint to call Chat API.
     result = service.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'
   
       }
   
     ).execute()
   
     # Prints details about the created space.
     print(result)
   
   if __name__ == '__main__':
     main()
   

Node.js

1. Speichern Sie den folgenden Code in einer Datei mit dem Namen chat_space_create_named.js im selben Verzeichnis, in dem sich das Node.js-Projekt und client_secrets.json befinden:

   const fs = require('fs');
   const path = require('path');
   const http = require('http');
   const url = require('url');
   const destroyer = require('server-destroy');
   
   const chat = require('@googleapis/chat');
   
   // Application OAuth credentials.
   const keys = require('./client_secrets.json').installed;
   
   // Define your app's authorization scopes.
   // When modifying these scopes, delete the file token.json, if it exists.
   const scopes = ["https://www.googleapis.com/auth/chat.spaces.create"];
   
   // Create a new OAuth2 client with the configured keys.
   const oauth2Client = new chat.auth.OAuth2(
     keys.client_id,
     keys.client_secret,
     'http://localhost:3000'
   );
   
   /**
    * Opens an HTTP server to accept the OAuth callback.
    * In this simple example, the only request to our webserver is to /?code=<code>.
    */
   async function authenticate(scopes) {
     const opn = (await import('open')).default;
   
     return new Promise((resolve, reject) => {
       // Generate the URL for authorization.
       const authorizeUrl = oauth2Client.generateAuthUrl({
         access_type: 'offline',
         scope: scopes.join(' '),
       });
       // Start the HTTP server to listen for the callback.
       const server = http
         .createServer(async (req, res) => {
           try {
             const qs = new url.URL(req.url, 'http://localhost:3000').searchParams;
             res.end('Authentication successful! Please return to the console.');
             server.destroy();
             const { tokens } = await oauth2Client.getToken(qs.get('code'));
             oauth2Client.credentials = tokens;
             resolve(oauth2Client);
           } catch (e) {
             reject(e);
           }
         })
         .listen(3000, () => {
           // Open the browser to the authorize URL to start the workflow.
           opn(authorizeUrl, { wait: false }).then(cp => cp.unref());
         });
       destroyer(server);
     });
   }
   
   /**
    * Authenticates with Chat API via user credentials, then creates a Chat space.
    */
   async function createSpace() {
     // Create the Chat API client and authenticate with the authorized user.
     const chatClient = await chat.chat({
       version: 'v1',
       auth: oauth2Client
     });
   
     // Call the Chat API to create a space.
     const result = await chatClient.spaces.create({
   
       // Details about the space to create.
       requestBody: {
   
         // To create a named space, set spaceType to SPACE.
         'spaceType': 'SPACE',
   
         // The user-visible name of the space.
         'displayName': 'API-made'
   
       }
   
     });
     return result;
   }
   
   // Authenticate the user, execute the function,
   // then print details about the created space.
   authenticate(scopes)
     .then(createSpace)
     .then(console.log);
   

Apps Script

1. Bearbeiten Sie im Apps Script-Editor die Datei appsscript.json und fügen Sie den erforderlichen OAuth-Bereich zum Aufrufen der API hinzu:

     "oauthScopes": [
       "https://www.googleapis.com/auth/chat.spaces.create"
     ]
   

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

   /**
    * Authenticates with Chat API via user credentials, then creates a
    * Chat space.
    */
   function createSpace() {
     try {
       // Details about the space to create.
       // To create a named space, set spaceType to SPACE.
       // The user-visible name of the space is displayName.
       const space = {'displayName': 'API-made', 'spaceType': 'SPACE'};
   
       // Call Chat API with user credentials to create the space.
       const result = Chat.Spaces.create(space);
   
       // Log details about the created space.
       console.log(result);
     } catch (err) {
       // TODO (developer) - Handle exception
       console.log('Failed to create space with error %s', err.message);
     }
   }
   

Java

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

Python

python3 chat_space_create_named.py

Node.js

node chat_space_create_named.js

Apps Script

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