المصادقة كتطبيق Google 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

• تطبيق Google Chat يتلقّى أحداث التفاعل ويردّ عليها. لإنشاء تطبيق Chat تفاعلي باستخدام خدمة HTTP، أكمل هذا التشغيل السريع.
• أضِف تطبيق Chat إلى مساحة. لإضافة تطبيق Chat، يُرجى الاطّلاع على مقالة اختبار الميزات التفاعلية لتطبيقات Google Chat.

Python

• الإصدار 3.6 من Python أو الإصدارات الأحدث
• أداة إدارة حزم pip
• تطبيق Google Chat يتلقّى أحداث التفاعل ويردّ عليها. لإنشاء تطبيق Chat تفاعلي باستخدام خدمة HTTP، أكمل هذا التشغيل السريع.
• أضِف تطبيق Chat إلى مساحة. لإضافة تطبيق Chat، يُرجى الاطّلاع على مقالة اختبار الميزات التفاعلية لتطبيقات Google Chat.

Node.js

• الإصدار 14 من Node.js أو الإصدارات الأحدث
• أداة إدارة حزم npm
• مشروع Node.js تم إعداده. لإعداد مشروع جديد، أنشئ مجلدًا جديدًا وانتقِل إليه، ثم نفِّذ الأمر التالي في واجهة سطر الأوامر:

  npm init

• تطبيق Google Chat يتلقّى أحداث التفاعل ويردّ عليها. لإنشاء تطبيق Chat تفاعلي باستخدام خدمة HTTP، أكمل هذا التشغيل السريع.
• أضِف تطبيق Chat إلى مساحة. لإضافة تطبيق Chat، يُرجى الاطّلاع على مقالة اختبار الميزات التفاعلية لتطبيقات Google Chat.

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

• تطبيق Google Chat يتلقّى أحداث التفاعل ويردّ عليها. لإنشاء تطبيق Chat تفاعلي في "برمجة التطبيقات"، أكمل هذا التشغيل السريع.
• أضِف تطبيق Chat إلى مساحة. لإضافة تطبيق Chat، يُرجى الاطّلاع على مقالة اختبار الميزات التفاعلية لتطبيقات Google Chat.

جافا

لإضافة مكتبات برامج 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.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

Node.js

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

npm install "@googleapis/chat"

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

يستخدم هذا النموذج مكتبة OAuth2 لبرمجة التطبيقات لإنشاء رمز JWT لمصادقة حساب الخدمة. لإضافة المكتبة إلى مشروع "برمجة التطبيقات":

1. على يمين الشاشة، انقر على المحرّر code.
2. على يمين الشاشة، بجانب المكتبات، انقر على إضافة مكتبة add.
3. أدخِل رقم تعريف النص البرمجي 1B7FSrk5Zi6L1rSxxTDgDEUsPzlukDsi4KGuTMorsTQHhGBzBkMun4iDF.
4. انقر على بحث ، ثم انقر على إضافة.

يستخدم هذا النموذج خدمة Advanced Chat لاستدعاء Google Chat API. لتفعيل الخدمة لمشروع "برمجة التطبيقات":

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

جافا

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.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. في الرمز، استبدِل SPACE_NAME باسم مساحة يمكنك الحصول عليه من spaces.list method في Chat API أو من عنوان URL لمساحة.

4. أنشئ دليلاً فرعيًا جديدًا باسم resources ضمن دليل مشروعك.

5. تأكَّد من أنّ اسم ملف المفتاح الخاص لحساب الخدمة هو credentials.json وانسَخه إلى الدليل الفرعي resources.

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

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

7. لإعداد 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_app_auth.py.

2. أدرِج الرمز التالي في chat_app_auth.py:

   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. في الرمز، استبدِل SPACE_NAME باسم مساحة يمكنك الحصول عليه من spaces.list method في Chat API أو من عنوان URL لمساحة. تأكَّد من أنّ اسم ملف المفتاح الخاص لحساب الخدمة هو credentials.json.

Node.js

1. في دليل مشروعك، أنشئ ملفًا باسم chat_app_auth.js.

2. أدرِج الرمز التالي في chat_app_auth.js:

   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. في الرمز، استبدِل SPACE_NAME باسم مساحة يمكنك الحصول عليه من spaces.list method في Chat API أو من عنوان URL لمساحة. تأكَّد من أنّ اسم ملف المفتاح الخاص لحساب الخدمة هو credentials.json.

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

1. في أداة تعديل النصوص البرمجية لتطبيقات Google، عدِّل الملف appsscript.json وأضِف نطاق OAuth اللازم لإجراء طلبات خارجية للحصول على رمز OAuth لحساب الخدمة:

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

2. احفظ الرمز التالي في ملف باسم ChatAppAuth.gs في مشروع "برمجة التطبيقات":

   // 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. في الرمز، استبدِل CREDENTIALS بمحتويات الملف credentials.json.

4. في الرمز، استبدِل SPACE_NAME باسم مساحة يمكنك الحصول عليه من spaces.list method في Chat API أو من عنوان URL لمساحة.

جافا

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

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

افتح الملف ChatAppAuth.gs في محرّر "برمجة التطبيقات" وانقر على تشغيل.