تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

المصادقة كتطبيق Google Chat

يوضِّح هذا الدليل كيفية إعداد حساب الخدمة واستخدامه للوصول إلى Google Chat API نيابةً عن تطبيق Chat. ويرشدك أولاً إلى طريقة إنشاء حساب خدمة. وبعد ذلك، تشرح طريقة كتابة نص برمجي يستخدم حساب الخدمة للمصادقة باستخدام Chat API ونشر رسالة في مساحة Chat.

يمكن لتطبيقات Chat استخدام حسابات الخدمة للمصادقة عند الاتصال بـ Google Chat API بشكل غير متزامن، حتى يتمكنوا من إجراء ما يلي:

يمكنك إرسال رسائل إلى Google Chat باستخدام spaces.messages.create لإجراء ما يلي:
- إبلاغ المستخدمين عند انتهاء مهمة طويلة الأمد في الخلفية
- يمكنك تنبيه المستخدمين بعدم اتصال الخادم بالإنترنت.
- اطلب من أحد موظفي دعم العملاء التعامل مع طلب دعم تم فتحه حديثًا.
يمكنك تعديل الرسائل التي تم إرسالها سابقًا باستخدام spaces.messages.update لإجراء ما يلي:
- تغيير حالة التشغيل الجاري.
- تعديل المُسنَد إليه المهمة أو تاريخ تسليمها
يمكنك إدراج المستخدمين في مساحة باستخدام spaces.members.list لتنفيذ ما يلي:
- معرفة الأشخاص الموجودين في مساحة.
- تأكَّد من أنّ عضوية المساحة تشمل جميع أعضاء الفريق.

عند المصادقة باستخدام حساب خدمة، للحصول على بيانات حول مساحة Chat أو تنفيذ إجراءات فيها، يجب أن تحصل تطبيقات Chat على اشتراك في المساحة. على سبيل المثال، لإدراج أعضاء مساحة أو لإنشاء رسالة في مساحة، يجب أن يكون تطبيق Chat عضوًا في المساحة.

إذا كان تطبيق Chat يحتاج إلى الوصول إلى بيانات المستخدم أو تنفيذ إجراءات نيابةً عن المستخدم، يمكنك المصادقة كمستخدم بدلاً من ذلك.

إذا كنت مشرف نطاق، يمكنك منح تفويض مرجع على مستوى النطاق لتفويض حساب خدمة التطبيق بالوصول إلى بيانات المستخدمين بدون طلب موافقة كل مستخدم. بعد إعداد التفويض على مستوى النطاق، يمكنك إجراء طلبات بيانات من واجهة برمجة التطبيقات باستخدام حساب الخدمة الخاص بك لانتحال هوية حساب مستخدم. على الرغم من استخدام حساب الخدمة للمصادقة، إلا أن التفويضات على مستوى النطاق تنتحل هوية المستخدم وبالتالي يعتبر مصادقة المستخدم. يمكنك استخدام التفويض على مستوى النطاق لأي وظيفة تتطلّب مصادقة المستخدم.

لمعرفة المزيد من المعلومات حول الحالات التي تتطلّب فيها تطبيقات Chat المصادقة ونوع المصادقة التي يجب استخدامها، يمكنك الاطّلاع على مقالة أنواع المصادقة المطلوبة في النظرة العامة على التفويض والمصادقة على Chat API.

المتطلبات الأساسية

لتنفيذ المثال في هذا الدليل، ستحتاج إلى المتطلّبات الأساسية التالية:

حساب Google Workspace يمكنه الوصول إلى Google Chat
مشروع على Google Cloud تم تفعيل Chat API فيه لإنشاء مشروع وتفعيل واجهة برمجة التطبيقات، يمكنك الرجوع إلى إنشاء مشروع وتفعيل واجهة برمجة التطبيقات.
أحد تطبيقات Chat المنشورة مع الاشتراك في مساحة Chat:
- لإنشاء تطبيق Chat ونشره، يُرجى الاطّلاع على إنشاء تطبيق Google Chat باستخدام دوال السحابة.
- لإضافة تطبيق Chat إلى مساحة Chat، راجِع مقالة إضافة تطبيقات إلى المساحات أو المحادثات في Google Chat.

بالإضافة إلى ذلك، ستحتاج إلى المتطلبات الأساسية التالية الخاصة باللغات:

Java

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

الإصدار 3.6 أو إصدار أحدث من Python
تتيح أداة pip لإدارة الحزم

Node.js

Node.js
تتيح لك أداة إدارة الحزم npm
مشروع Node.js مهيأ. لتهيئة مشروع جديد، عليك إنشاء مجلد جديد والتبديل إليه، ثم تشغيل الأمر التالي في واجهة سطر الأوامر:
```
npm init
```

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

مشروع "برمجة تطبيقات Google" مرتبط بمشروعك على Google Cloud. لإعداد مشروع "برمجة تطبيقات Google"، راجِع البدء السريع لتطبيق المحادثة في "برمجة تطبيقات Google".

الخطوة 1: إنشاء حساب خدمة في Google Cloud Console

أنشِئ حساب خدمة يمكن لتطبيق Chat استخدامه للوصول إلى Google APIs.

إنشاء حساب خدمة

لإنشاء حساب خدمة، اتّبِع الخطوات التالية:

وحدة التحكُّم في Google Cloud

في Google Cloud Console، انتقِل إلى القائمة > إدارة الهوية وإمكانية الوصول والمشرف > حسابات الخدمة.
الانتقال إلى حسابات الخدمة
انقر على إنشاء حساب خدمة.
املأ تفاصيل حساب الخدمة، ثم انقر على إنشاء ومتابعة.
ملاحظة: وفقًا للإعدادات التلقائية، تنشئ Google رقم تعريف حساب خدمة فريدًا. وإذا أردت تغيير المعرّف، يمكنك تعديله في حقل رقم تعريف حساب الخدمة.
اختياري: أسنِد الأدوار إلى حساب الخدمة لمنح إذن الوصول إلى موارد مشروعك على Google Cloud. لمزيد من التفاصيل، يُرجى الرجوع إلى منح إذن الوصول إلى الموارد وتغييره وإبطاله.
انقر على متابعة.
اختياري: أدخِل المستخدمين أو المجموعات التي يمكنها إدارة الإجراءات وتنفيذها باستخدام حساب الخدمة هذا. لمعرفة مزيد من التفاصيل، يُرجى الرجوع إلى إدارة انتحال هوية حساب الخدمة.
انقر على تم. دوِّن عنوان البريد الإلكتروني لحساب الخدمة.

واجهة سطر الأوامر في gcloud

أنشئ حساب الخدمة:

gcloud iam service-accounts create SERVICE_ACCOUNT_NAME \
  --display-name="SERVICE_ACCOUNT_NAME"

اختياري: أسنِد الأدوار إلى حساب الخدمة لمنح إذن الوصول إلى موارد مشروعك على Google Cloud. لمزيد من التفاصيل، يُرجى الرجوع إلى منح إذن الوصول إلى الموارد وتغييره وإبطاله.

يظهر حساب الخدمة في صفحة حساب الخدمة. بعد ذلك، أنشئ مفتاحًا خاصًا لحساب الخدمة.

إنشاء مفتاح خاص

لإنشاء مفتاح خاص وتنزيله لحساب الخدمة، يُرجى اتّباع الخطوات التالية:

في Google Cloud Console، انتقِل إلى القائمة > إدارة الهوية وإمكانية الوصول والمشرف > حسابات الخدمة.
الانتقال إلى حسابات الخدمة
اختَر حساب الخدمة.
انقر على المفاتيح > إضافة مفتاح > إنشاء مفتاح جديد.
اختَر JSON ثم انقر على إنشاء.
يتم إنشاء زوج المفاتيح العام/الخاص الجديد وتنزيله على جهازك كملف جديد. احفظ ملف JSON الذي تم تنزيله بتنسيق credentials.json في دليل العمل. وهذا الملف هو النسخة الوحيدة من هذا المفتاح. للحصول على معلومات حول طريقة تخزين مفتاحك بأمان، يُرجى الاطّلاع على إدارة مفاتيح حساب الخدمة.
انقر على إغلاق.

لمزيد من المعلومات حول حسابات الخدمة، يُرجى الاطّلاع على حسابات الخدمة في مستندات "إدارة الهوية وإمكانية الوصول" على Google Cloud.

الخطوة 2: تثبيت مكتبة برامج Google والتبعيات الأخرى

ثبِّت مكتبة برامج Google والتبعيات الأخرى المطلوبة للمشروع.

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.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 المميّز لمصادقة حساب الخدمة. لإضافة المكتبة إلى مشروع "برمجة التطبيقات":

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

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

على يمين الصفحة، انقر على أداة التعديل .
على يمين الصفحة، بجانب الخدمات، انقر على إضافة خدمة .
اختَر Google Chat API.
في الإصدار، اختَر v1.
انقر على إضافة.

يمكنك استخدام أي لغة معتمَدة في مكتبات العملاء.

الخطوة 3: كتابة نص برمجي يستخدم حساب الخدمة للمصادقة باستخدام Chat API

تتم مصادقة الرمز التالي مع Chat API باستخدام حساب خدمة، ثم ينشر رسالة على مساحة Chat:

Java

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

استبدال المحتوى في 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 via 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();
    }
}

في الرمز، استبدِل SPACE_NAME باسم مساحة، يمكنك الحصول عليه من طريقة spaces.list في Chat API أو من عنوان URL للمساحة.
أنشئ دليلاً فرعيًا جديدًا باسم resources في دليل مشروعك.
تأكَّد من تسمية ملف المفتاح الخاص لحساب الخدمة credentials.json وانسخه إلى الدليل الفرعي "resources".
لإعداد Maven لتضمين ملف المفتاح الخاص في حزمة المشروع، عدّل الملف pom.xml في دليل مشروعك وأضف الضبط التالي إلى القسم <build>:
```
<build>
  
  <resources>
    <resource>
      <directory>resources</directory>
    </resource>
  </resources>
</build>
```

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

في دليل العمل، أنشئ ملفًا باسم chat_app_auth.py.

أدرِج الرمز التالي في 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.
CREDENTIALS = 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=CREDENTIALS)

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

في الرمز، استبدِل SPACE_NAME باسم مساحة، يمكنك الحصول عليه من طريقة spaces.list في Chat API أو من عنوان URL للمساحة. تأكَّد من تسمية ملف المفتاح الخاص لحساب الخدمة باسم credentials.json.

Node.js

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

أدرِج الرمز التالي في 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);

في الرمز، استبدِل SPACE_NAME باسم مساحة، يمكنك الحصول عليه من طريقة spaces.list في Chat API أو من عنوان URL للمساحة. تأكَّد من تسمية ملف المفتاح الخاص لحساب الخدمة باسم credentials.json.

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

في محرِّر "برمجة تطبيقات Google"، عدِّل الملف appsscript.json وأضِف نطاق OAuth اللازم لإجراء طلبات خارجية للحصول على رمز OAuth المميز لحساب الخدمة:
```
  "oauthScopes": [
    "https://www.googleapis.com/auth/script.external_request"
  ]
```

احفظ الرمز التالي في ملف باسم 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 via 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());
}

في الرمز، استبدِل CREDENTIALS بمحتوى الملف credentials.json.
في الرمز، استبدِل SPACE_NAME باسم مساحة، يمكنك الحصول عليه من طريقة spaces.list في Chat API أو من عنوان URL للمساحة.

الخطوة 4: تنفيذ المثال الكامل

في دليل العمل، أنشئ النموذج وشغِّله:

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

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

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

يرسل النص البرمجي طلبًا تمت مصادقته إلى Chat API، التي تستجيب من خلال نشر رسالة في مساحة Chat كتطبيق Chat.

تحديد المشاكل في المثال وحلّها

يصف هذا القسم المشكلات الشائعة التي قد تواجهها أثناء محاولة تشغيل هذه العينة.

غير مسموح لك باستخدام هذا التطبيق

عند تشغيل النص البرمجي، قد تتلقى رسالة خطأ تفيد بما يلي:

<HttpError 403 when requesting https://chat.googleapis.com/v1/spaces/{space}/messages?alt=json returned "You are not permitted to use this app". Details: "You are not permitted to use this app">

تعني رسالة الخطأ هذه أنّ تطبيق Chat لا يملك الإذن لإنشاء رسائل Chat في مساحة Chat المحدّدة.

لإصلاح الخطأ، عليك إضافة تطبيق Chat إلى مساحة Chat المحدّدة في النص البرمجي.

تعرَّف على الإجراءات الأخرى التي يمكن تنفيذها في Chat API من خلال مراجعة المستندات المرجعية الخاصة بـ Chat API.

المصادقة كتطبيق Google Chat

المتطلبات الأساسية

Java

Python

Node.js

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

الخطوة 1: إنشاء حساب خدمة في Google Cloud Console

إنشاء حساب خدمة

وحدة التحكُّم في Google Cloud

واجهة سطر الأوامر في gcloud

إنشاء مفتاح خاص

الخطوة 2: تثبيت مكتبة برامج Google والتبعيات الأخرى

Java

Python

Node.js

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

الخطوة 3: كتابة نص برمجي يستخدم حساب الخدمة للمصادقة باستخدام Chat API

Java

Python

Node.js

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

الخطوة 4: تنفيذ المثال الكامل

Java

Python

Node.js

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

تحديد المشاكل في المثال وحلّها

غير مسموح لك باستخدام هذا التطبيق

مواضيع ذات صلة