الحصول على تفاصيل حول مساحة

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

يمثّل المورد Space مكانًا يمكن فيه للمستخدمين وتطبيقات Chat إرسال الرسائل ومشاركة الملفات والتعاون. تتوفّر عدة أنواع من المساحات:

• الرسائل المباشرة هي محادثات بين مستخدمَين أو مستخدم وتطبيق في Chat.
• المحادثات الجماعية هي محادثات بين ثلاثة مستخدمين أو أكثر وتطبيقات Chat.
• المساحات المُسمّاة هي أماكن دائمة يمكن للمستخدمين من خلالها إرسال الرسائل ومشاركة الملفات والتعاون معًا.

تؤدي المصادقة باستخدام مصادقة التطبيقات إلى السماح لتطبيق Chat بالحصول على مساحات يمكن لتطبيق Chat الوصول إليها في Google Chat (مثل المساحات التي يكون التطبيق عضوًا فيها). تتيح لك المصادقة باستخدام مصادقة المستخدم الحصول على المساحات التي يمكن للمستخدم الذي تمت مصادقته الوصول إليها.

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

Python

• Python 3.6 أو أحدث
• إنّ أداة إدارة الحِزم pip

• أحدث مكتبات عملاء Google للغة Python. لتثبيتها أو تحديثها، شغّل الأمر التالي في واجهة سطر الأوامر:

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

• مشروع على Google Cloud تم فيه تفعيل Google Chat API وضبطه لمعرفة الخطوات، يُرجى الاطّلاع على مقالة إنشاء تطبيق Google Chat.

• تم ضبط التفويض لتطبيق Chat. يتيح الحصول على مساحة استخدام طريقتَي المصادقة التاليتَين:

  • مصادقة المستخدم باستخدام نطاق التفويض chat.spaces.readonly أو chat.spaces.
  • مصادقة التطبيقات باستخدام نطاق التفويض chat.bot.

Node.js

• Node.js وnpm

• أحدث مكتبات عملاء Google لنظام Node.js. ولتثبيتها، شغِّل الأمر التالي في واجهة سطر الأوامر:

  npm install @google-cloud/local-auth @googleapis/chat
  

• مشروع على Google Cloud تم فيه تفعيل Google Chat API وضبطه لمعرفة الخطوات، يُرجى الاطّلاع على مقالة إنشاء تطبيق Google Chat.

• تم ضبط التفويض لتطبيق Chat. يتيح الحصول على مساحة استخدام طريقتَي المصادقة التاليتَين:

  • مصادقة المستخدم باستخدام نطاق التفويض chat.spaces.readonly أو chat.spaces.
  • مصادقة التطبيقات باستخدام نطاق التفويض chat.bot.

الحصول على مساحة

للحصول على مساحة في Google Chat، عليك تقديم ما يلي في طلبك:

• باستخدام مصادقة التطبيق، حدِّد نطاق تفويض chat.bot. باستخدام مصادقة المستخدم، حدِّد نطاق التفويض chat.spaces.readonly أو chat.spaces.
• يمكنك استدعاء طريقة get على المورد Space، مع تمرير name من المساحة للحصول عليها. احصل على اسم المساحة من مورد المساحات في Google Chat أو من عنوان URL الخاص بالمساحة.

الحصول على تفاصيل المساحة باستخدام مصادقة المستخدم

إليك كيفية الحصول على تفاصيل المساحة باستخدام مصادقة المستخدم:

Python

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

2. ضمِّن الرمز التالي في chat_space_get_user.py:

   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.readonly"]
   
   def main():
       '''
       Authenticates with Chat API via user credentials,
       then gets details about a specified space.
       '''
   
       # Authenticate with Google Workspace
       # and get user authorization.
       flow = InstalledAppFlow.from_client_secrets_file(
                         'client_secrets.json', SCOPES)
       creds = flow.run_local_server()
   
       # Build a service endpoint for Chat API.
       chat = build('chat', 'v1', credentials=creds)
   
       # Use the service endpoint to call Chat API.
       result = chat.spaces().get(
   
             # The space to get.
             #
             # Replace SPACE with a space name.
             # Obtain the space name from the spaces resource of Chat API,
             # or from a space's URL.
             name='spaces/SPACE'
   
         ).execute()
   
       # Prints details about the space.
       print(result)
   
   if __name__ == '__main__':
       main()
   

3. في الرمز، استبدِل SPACE باسم مساحة، الذي يمكنك الحصول عليه من طريقة spaces.list في Chat API أو من عنوان URL الخاص بالمساحة.

4. في دليل العمل، أنشئ النموذج وقم بتشغيله:

   python3 chat_space_get_user.py
   

Node.js

1. في دليل العمل، أنشِئ ملفًا باسم get-space.js.

2. ضمِّن الرمز التالي في get-space.js:

   const chat = require('@googleapis/chat');
   const {authenticate} = require('@google-cloud/local-auth');
   
   /**
   * Gets details about a Chat space by name.
   * @return {!Object}
   */
   async function getSpace() {
     const scopes = [
       'https://www.googleapis.com/auth/chat.spaces.readonly',
     ];
   
     const authClient =
         await authenticate({scopes, keyfilePath: 'client_secrets.json'});
   
     const chatClient = await chat.chat({version: 'v1', auth: authClient});
   
     return await chatClient.spaces.get({name: 'spaces/SPACE'});
   }
   
   getSpace().then(console.log);
   

3. في الرمز، استبدِل SPACE باسم مساحة، الذي يمكنك الحصول عليه من طريقة spaces.list في Chat API أو من عنوان URL الخاص بالمساحة.

4. في دليل العمل، شغِّل النموذج:

   node get-space.js
   

تعرِض Chat API مثيل Space الذي يوضّح المساحة المحدَّدة.

الحصول على تفاصيل المساحة باستخدام مصادقة التطبيقات

إليك كيفية الحصول على تفاصيل المساحة باستخدام مصادقة التطبيقات:

Python

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

2. ضمِّن الرمز التالي في chat_space_get_app.py:

   from google.oauth2 import service_account
   from apiclient.discovery import build
   
   # 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')
       .with_scopes(SCOPES)
   )
   
   # Build the URI and authenticate with the service account.
   chat = build('chat', 'v1', credentials=CREDENTIALS)
   
   # Use the service endpoint to call Chat API.
   result = chat.spaces().get(
   
       # The space to get.
       #
       # Replace SPACE with a space name.
       # Obtain the space name from the spaces resource of Chat API,
       # or from a space's URL.
       name='spaces/SPACE'
   
   ).execute()
   
   print(result)
   

3. في الرمز، استبدِل SPACE باسم مساحة، الذي يمكنك الحصول عليه من طريقة spaces.list() في Chat API أو من عنوان URL الخاص بالمساحة.

4. في دليل العمل، أنشئ النموذج وقم بتشغيله:

   python3 chat_space_get_app.py
   

Node.js

1. في دليل العمل، أنشِئ ملفًا باسم app-get-space.js.

2. ضمِّن الرمز التالي في app-get-space.js:

   const chat = require('@googleapis/chat');
   
   /**
   * Gets details about a Chat space by name.
   * @return {!Promise<!Object>}
   */
   async function getSpace() {
     const scopes = [
       'https://www.googleapis.com/auth/chat.bot',
     ];
   
     const auth = new chat.auth.GoogleAuth({
       scopes,
       keyFilename: 'credentials.json',
     });
   
     const authClient = await auth.getClient();
     const chatClient = await chat.chat({version: 'v1', auth: authClient});
   
     return await chatClient.spaces.get({name: 'spaces/SPACE'});
   }
   
   getSpace().then(console.log);
   

3. في الرمز، استبدِل SPACE باسم مساحة، الذي يمكنك الحصول عليه من طريقة spaces.list في Chat API أو من عنوان URL الخاص بالمساحة.

4. في دليل العمل، شغِّل النموذج:

   node app-get-space.js
   

تعرِض Chat API مثيل Space الذي يوضِّح المساحة المحدَّدة.

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

• أنشئ مساحة.
• إعداد مساحة
• إدراج المساحات:
• تعديل مساحة
• حذف مساحة
• العثور على مساحة للرسائل المباشرة