المصادقة والتفويض كمستخدم Google Chat

Java

• حساب على Google Workspace من فئة Business أو Enterprise يتيح الوصول إلى Google Chat
• أنشئ مشروعًا على Google Cloud.
• فعِّل Google Chat API وضبطها باستخدام اسم و رمز ووصف لتطبيق Chat.
• ‫JDK 1.7 أو إصدار أحدث
• أداة إدارة حزم Maven
• مشروع Maven تم إعداده لبدء مشروع جديد، نفِّذ الأمر التالي في واجهة سطر الأوامر:

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

Python

• حساب على Google Workspace من فئة Business أو Enterprise يتيح الوصول إلى Google Chat
• أنشئ مشروعًا على Google Cloud.
• فعِّل Google Chat API وضبطها باستخدام اسم و رمز ووصف لتطبيق Chat.
• الإصدار 3.6 من Python أو إصدار أحدث
• أداة إدارة حزم pip

Node.js

• حساب على Google Workspace من فئة Business أو Enterprise يتيح الوصول إلى Google Chat
• أنشئ مشروعًا على Google Cloud.
• فعِّل Google Chat API وضبطها باستخدام اسم و رمز ووصف لتطبيق Chat.
• الإصدار 14 من Node.js أو إصدار أحدث
• أداة إدارة الحِزم npm
• مشروع Node.js تم إعداده. لبدء مشروع جديد، أنشئ مجلّدًا جديدًا وبدِّل إليه، ثم نفِّذ الأمر التالي في واجهة سطر الأوامر:

  npm init

برمجة تطبيقات

• حساب على Google Workspace من فئة Business أو Enterprise يتيح الوصول إلى Google Chat
• أنشئ مشروعًا على Google Cloud.
• فعِّل Google Chat API وضبطها باستخدام اسم و رمز ووصف لتطبيق Chat.
• أنشئ مشروعًا مستقلاً في Apps Script، وفعِّل خدمة Chat المتقدّمة.

Java

لإضافة مكتبات برامج Google للعملاء والتبعيات المطلوبة الأخرى إلى مشروع Maven، عدِّل الملف pom.xml في دليل مشروعك وأضِف التبعيات التالية:

<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

إذا لم يسبق لك تثبيت مكتبات واجهة برمجة التطبيقات من Google لبرنامج Python، شغِّل الأمر التالي في واجهة سطر الأوامر:

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

Node.js

لإضافة مكتبات Google API Client Libraries والتبعيات المطلوبة الأخرى إلى مشروعك المستنِد إلى Node.js، انتقِل إلى دليل مشروعك ونفِّذ العبارة التالية في واجهة سطر الأوامر:

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

برمجة تطبيقات

يستخدم هذا المثال خدمة Chat المتقدّمة للاتصال بواجهة برمجة تطبيقات Google Chat. لتفعيل الخدمة لمشروعك على برمجة تطبيقات Google:

1. على يمين الصفحة، انقر على أداة التعديل code.
2. على يمين الصفحة، بجانب الخدمات، انقر على إضافة خدمة add.
3. اختَر Google Chat API.
4. في الإصدار، اختَر الإصدار 1.
5. انقر على إضافة.

Java

1. في دليل مشروعك، افتح الملف src/main/java/com/google/chat/app/authsample/App.java.

2. استبدِل المحتوى في App.java بالرمز التالي:

   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. أنشئ دليلاً فرعيًا جديدًا باسم resources ضمن دليل مشروعك.

4. انسخ الملف client_secrets.json إلى المجلد الفرعي resources.

5. لضبط Maven لتضمين ملف أسرار العملاء في حزمة المشروع، عدِّل الملف pom.xml في دليل مشروعك وأضِف الإعدادات التالية إلى القسم <build>:

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

6. لضبط Maven لتضمين التبعيات في حزمة المشروع وتنفيذ الفئة الرئيسية لتطبيقك، عدِّل الملف pom.xml في دليل مشروعك وأضِف الإعدادات التالية إلى القسم <plugins>:

   <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. احفظ الرمز التالي في ملف باسم chat_space_create_named.py في الدليل نفسه الذي يحتوي على client_secrets.json:

   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. احفظ الرمز التالي في ملف باسم chat_space_create_named.js في الدليل نفسه الذي يتضمن مشروع Node.js وclient_secrets.json:

   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);
   

برمجة تطبيقات

1. في محرِّر "برمجة تطبيقات Google"، عدِّل الملف appsscript.json وأضِف نطاق OAuth اللازم لطلب واجهة برمجة التطبيقات:

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

2. احفظ الرمز البرمجي التالي في ملف باسم ChatSpaceCreateNamed.gs في مشروعك على Apps Script:

   /**
    * 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

برمجة تطبيقات

افتح الملف ChatSpaceCreateNamed.gs في Apps Script Editor (محرر نصوص Apps Script) وانقر على Run (تشغيل).