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

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

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

بعد المصادقة والتفويض طلب بيانات من واجهة برمجة التطبيقات باستخدام بيانات اعتماد المستخدم، يمكن للتطبيقات في Chat إجراء التالي:

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

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

ينشئ تطبيق Google Chat مساحة للمستخدم. — **الشكل 1**. رسالة تحديد المصدر التي يعرضها Google Chat عندما ينشئ تطبيق Chat مساحة بالنيابة عن مستخدم

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

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

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

المصادقة والتفويض باستخدام امتيازات المشرف

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

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

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

Java

نشاط تجاري أو مؤسسة حساب Google Workspace لديه إذن بالوصول إلى 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 لديه إذن بالوصول إلى Google Chat
أنشِئ مشروعًا على Google Cloud.
تفعيل Google Chat API وضبطه باستخدام اسم ورمزه ووصفه لتطبيق Chat.
Python 3.6 أو أعلى
أداة إدارة حزم pip

Node.js

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

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

نشاط تجاري أو مؤسسة حساب Google Workspace لديه إذن بالوصول إلى Google Chat
أنشِئ مشروعًا على Google Cloud.
تفعيل Google Chat API وضبطه باستخدام اسم ورمزه ووصفه لتطبيق Chat.
إنشاء مشروع "برمجة تطبيقات Google" مستقل وفعِّل خدمة المحادثة المتقدّمة.

الخطوة 1: ضبط شاشة موافقة OAuth وتحديد النطاقات وتسجيل تطبيقك

عند استخدام OAuth 2.0 للتفويض، تعرض Google شاشة موافقة من أجل المستخدم بما في ذلك ملخص لمشروعك وسياساته والبيانات المطلوبة ونطاقات التفويض. ضبط شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth في تطبيقك يحدد ما تعرضه Google للمستخدمين ومراجعي التطبيقات، ويسجّل تطبيقك لكي تتمكّن من نشره لاحقًا

تتطلب جميع التطبيقات التي تستخدم OAuth 2.0 ضبط شاشة طلب الموافقة، ولكن يمكنك فقط تحتاج إلى إدراج نطاقات التطبيقات التي يستخدمها الأشخاص من خارج Google Workspace. التنظيم.

في وحدة التحكّم في Google Cloud، انتقِل إلى القائمة . > واجهات برمجة التطبيقات الخدمات > شاشة موافقة OAuth.

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

ملاحظة: لتنفيذ مثال المصادقة في هذا الدليل، أضِف https://www.googleapis.com/auth/chat.spaces.create.

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

الخطوة 2: إنشاء بيانات اعتماد معرِّف عميل OAuth في Google Cloud Console

للمصادقة كمستخدم نهائي والوصول إلى بيانات المستخدمين في تطبيقك، عليك: إنشاء واحد أو أكثر من معرّفات عميل OAuth 2.0. يُستخدم معرف العميل لتحديد تطبيقًا واحدًا بخوادم OAuth في Google. إذا كان تطبيقك يعمل على عدة أنظمة الأنظمة الأساسية - مثل Android وiOS والويب - تحتاج إلى إنشاء معرّف عميل منفصل لكل منصة.

إنشاء بيانات اعتماد معرِّف عميل OAuth

اختَر نوع التطبيق للحصول على تعليمات محدَّدة حول كيفية إنشاء معرِّف عميل OAuth:

تطبيق الويب

في وحدة تحكُّم Google Cloud، انتقِل إلى القائمة > واجهات برمجة التطبيقات الخدمات > بيانات الاعتماد.
الانتقال إلى بيانات الاعتماد
انقر على إنشاء بيانات اعتماد > معرِّف عميل OAuth.
انقر على نوع التطبيق > تطبيق الويب.
في حقل الاسم، اكتب اسمًا لبيانات الاعتماد. ولا يظهر هذا الاسم إلا في وحدة تحكُّم Google Cloud.
أضِف معرّفات موارد منتظمة (URI) معتمَدة ذات صلة بتطبيقك:
- التطبيقات من جهة العميل (JavaScript): ضمن مصادر JavaScript المعتمَدة، انقر على إضافة معرّف موارد منتظم (URI). بعد ذلك، أدخِل عنوان URL لاستخدامه في طلبات المتصفّح. يحدِّد ذلك النطاقات التي يمكن لتطبيقك من خلالها إرسال طلبات واجهة برمجة التطبيقات إلى خادم OAuth 2.0.
- التطبيقات من جهة الخادم (Java وPython وغيرهما): ضمن معرّفات الموارد المنتظمة (URI) المعتمَدة لإعادة التوجيه، انقر على إضافة معرّف موارد منتظم (URI). بعد ذلك، أدخِل معرِّف الموارد المنتظم (URI) لنقطة النهاية الذي يمكن لخادم OAuth 2.0 إرسال الاستجابات إليه.
انقر على إنشاء. تظهر الشاشة التي تم إنشاؤها من خلال عميل OAuth، وتعرض معرِّف العميل الجديد وسر العميل.
سجِّل معرِّف العميل. لا يتم استخدام أسرار العميل مع تطبيقات الويب.
انقر على موافق. تظهر بيانات الاعتماد التي تم إنشاؤها حديثًا ضمن معرّفات عميل OAuth 2.0.

Android

في وحدة تحكُّم Google Cloud، انتقِل إلى القائمة > واجهات برمجة التطبيقات الخدمات > بيانات الاعتماد.
الانتقال إلى بيانات الاعتماد
انقر على إنشاء بيانات اعتماد > معرِّف عميل OAuth.
انقر على نوع التطبيق > Android.
في حقل "الاسم" اكتب اسمًا لبيانات الاعتماد. ولا يظهر هذا الاسم إلا في وحدة تحكُّم Google Cloud.
في حقل "اسم الحزمة" أدخِل اسم الحزمة من ملف AndroidManifest.xml.
في "الملف المرجعي لشهادة SHA-1" أدخِل الملف المرجعي لشهادة SHA-1 التي تم إنشاؤها.
انقر على إنشاء. تظهر الشاشة التي تم إنشاؤها من خلال عميل OAuth، وتعرض معرِّف العميل الجديد الخاص بك.
انقر على موافق. تظهر بيانات الاعتماد التي تم إنشاؤها حديثًا ضمن "معرّفات عميل OAuth 2.0".

iOS

في وحدة تحكُّم Google Cloud، انتقِل إلى القائمة > واجهات برمجة التطبيقات الخدمات > بيانات الاعتماد.
الانتقال إلى بيانات الاعتماد
انقر على إنشاء بيانات اعتماد > معرِّف عميل OAuth.
انقر على نوع التطبيق > iOS.
في حقل "الاسم" اكتب اسمًا لبيانات الاعتماد. ولا يظهر هذا الاسم إلا في وحدة تحكُّم Google Cloud.
في "معرّف الحزمة" أدخِل معرِّف الحزمة كما هو مُدرَج في ملف Info.plist للتطبيق.
اختياري: إذا كان تطبيقك يظهر في Apple App Store، أدخِل رقم تعريف متجر التطبيقات.
اختياري: في "رقم تعريف الفريق" أدخِل السلسلة الفريدة المكوّنة من 10 أحرف التي أنشأتها Apple وتم تخصيصها لفريقك.
انقر على إنشاء. تظهر الشاشة التي تم إنشاؤها من خلال عميل OAuth، وتعرض معرِّف العميل الجديد وسر العميل.
انقر على موافق. تظهر بيانات الاعتماد التي تم إنشاؤها حديثًا ضمن "معرّفات عميل OAuth 2.0".

تطبيق Chrome

في وحدة تحكُّم Google Cloud، انتقِل إلى القائمة > واجهات برمجة التطبيقات الخدمات > بيانات الاعتماد.
الانتقال إلى بيانات الاعتماد
انقر على إنشاء بيانات اعتماد > معرِّف عميل OAuth.
انقر على نوع التطبيق > تطبيق Chrome.
في حقل "الاسم" اكتب اسمًا لبيانات الاعتماد. ولا يظهر هذا الاسم إلا في وحدة تحكُّم Google Cloud.
في قسم "معرِّف التطبيق" ، أدخِل سلسلة رقم تعريف تطبيقك الفريدة المكوّنة من 32 حرفًا. يمكنك العثور على قيمة رقم التعريف في عنوان URL لتطبيقك على "سوق Chrome الإلكتروني" وفي لوحة بيانات المطوّر في "سوق Chrome الإلكتروني".
انقر على إنشاء. تظهر الشاشة التي تم إنشاؤها من خلال عميل OAuth، وتعرض معرِّف العميل الجديد وسر العميل.
انقر على موافق. تظهر بيانات الاعتماد التي تم إنشاؤها حديثًا ضمن "معرّفات عميل OAuth 2.0".

تطبيق لأجهزة الكمبيوتر المكتبي

في وحدة تحكُّم Google Cloud، انتقِل إلى القائمة > واجهات برمجة التطبيقات الخدمات > بيانات الاعتماد.
الانتقال إلى بيانات الاعتماد
انقر على إنشاء بيانات اعتماد > معرِّف عميل OAuth.
انقر على نوع التطبيق > تطبيق الكمبيوتر المكتبي.
في حقل الاسم، اكتب اسمًا لبيانات الاعتماد. ولا يظهر هذا الاسم إلا في وحدة تحكُّم Google Cloud.
انقر على إنشاء. تظهر الشاشة التي تم إنشاؤها من خلال عميل OAuth، وتعرض معرِّف العميل الجديد وسر العميل.
انقر على موافق. تظهر بيانات الاعتماد التي تم إنشاؤها حديثًا ضمن معرّفات عميل OAuth 2.0.

أجهزة التلفزيون أجهزة الإدخال المحدود

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

Universal Windows Platform (منصة Windows العالمية)

في وحدة تحكُّم Google Cloud، انتقِل إلى القائمة > واجهات برمجة التطبيقات الخدمات > بيانات الاعتماد.
الانتقال إلى بيانات الاعتماد
انقر على إنشاء بيانات اعتماد > معرِّف عميل OAuth.
انقر على نوع التطبيق > نظام التشغيل Windows الأساسي (UWP).
في حقل "الاسم" اكتب اسمًا لبيانات الاعتماد. ولا يظهر هذا الاسم إلا في وحدة تحكُّم Google Cloud.
في "رقم تعريف المتجر" أدخِل قيمة معرّف Microsoft Store الفريدة والمكوّنة من 12 حرفًا لتطبيقك. يمكنك العثور على رقم التعريف هذا في عنوان URL لتطبيقك على Microsoft Store وفي مركز الشركاء.
انقر على إنشاء. تظهر الشاشة التي تم إنشاؤها من خلال عميل OAuth، وتعرض معرِّف العميل الجديد وسر العميل.
انقر على موافق. تظهر بيانات الاعتماد التي تم إنشاؤها حديثًا ضمن "معرّفات عميل OAuth 2.0".

تنزيل ملف JSON لسر العميل

ملف سر العميل هو تمثيل JSON لمعرِّف عميل OAuth. بيانات الاعتماد التي يمكن لتطبيق Chat الرجوع إليها عند تقديم بيانات الاعتماد.

في وحدة التحكّم في Google Cloud، انتقِل إلى القائمة . > واجهات برمجة التطبيقات الخدمات > بيانات الاعتماد.

الانتقال إلى بيانات الاعتماد
ضمن معرّفات عميل OAuth 2.0، انقر على معرِّف العميل الذي أنشأته.
انقر على تنزيل JSON.
احفظ الملف باسم client_secrets.json.

الخطوة 3: تثبيت مكتبة برامج 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.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 والتبعيات الأخرى المطلوبة إلى Node.js، ثم الانتقال إلى دليل مشروعك وتنفيذ ما يلي الأمر في واجهة سطر الأوامر:

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

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

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

على يمين الصفحة، انقر على رمز المحرِّر .
على يمين الشاشة، بجانب الخدمات، انقر على إضافة خدمة.
اختَر Google Chat API.
في الإصدار، اختَر الإصدار 1.
انقر على إضافة.

يمكنك استخدام أي لغة متاحة في مكتبات البرامج.

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

يمكن طلب البيانات من واجهة برمجة التطبيقات باستخدام تفويض OAuth عملية متعدّدة الخطوات. في الويب أو تطبيقات سطح المكتب، تكون العملية عادةً على النحو التالي:

يوجِّه التطبيق المستخدم إلى صفحة التفويض التي تطلب الوصول إلى بيانات المستخدم. البيانات المحددة من خلال نطاقات التفويض. يعرّف التطبيق نفسه عن طريق العميل بيانات اعتماد المعرّف
يراجع المستخدم الأذونات التي يطلبها التطبيق ويوافق على طلبك.
يُعيد خادم مصادقة Google توجيه المتصفِّح إلى بروتوكول HTTP الخاص بالتطبيق. نقطة النهاية إلى جانب رمز التفويض.
يرسل التطبيق طلبًا آخر إلى خادم تفويض Google من أجل استبدال رمز التفويض برمز الدخول.
يستخدم التطبيق رمز الدخول لطلب بيانات من واجهة برمجة التطبيقات نيابةً عن المستخدم.

لمزيد من المعلومات حول عملية تفويض OAuth، راجع استخدام OAuth 2.0 للوصول إلى دليل Google APIs.

تستخدم نماذج التعليمات البرمجية التالية في Java، وPython، وNode.js مكتبة البرامج لتنفيذ مسار تفويض OAuth. فهي تفتح خادم HTTP محلي استلام رمز التفويض مرة أخرى من خادم التفويض، والذي التبادل برمز الدخول. في نموذج رمز برمجة التطبيقات، يكون تدفق التفويض هذا التي تتم معالجتها من خلال "برمجة تطبيقات Google"

بعد إكمال عملية المصادقة، تتم المصادقة على النص البرمجي Chat API باستخدام رمز الدخول الخاص بالمستخدم ثم تنشئ مساحة.

Java

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

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

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

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

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

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

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

الخطوة 5: تشغيل نموذج النص البرمجي

لتشغيل المثال، من سطر الأوامر، انتقِل إلى الدليل الذي يتضمّن ملفات مشروعك، ثم نفذ الأمر التالي:

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" في "برمجة تطبيقات Google" محرِّر وانقر على Run (تشغيل).

سيفتح متصفّح ويطلب منك تسجيل الدخول إلى حسابك على Google:

تسجيل الدخول لمنح الإذن لتطبيق في Chat

الشكل 2. شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth حيث يمكنك اختيار الحساب المطلوب مصادقة التطبيق.

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

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

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

عند تشغيل chat_space_create_named.py، قد تظهر لك رسالة الخطأ التالية:

Expected a JSON object with a single property for a "web" or "installed" application

تعني رسالة الخطأ هذه أن ملف client_secrets.json الذي نزّلته من وحدة تحكُّم Google Cloud لا يبدأ بـ "web" أو "installed" الموقع. بعد المصادقة باستخدام الملف الذي تم تنزيله، إذا لم يحدث الرمز لحفظ رمز الدخول في ملف جديد مثل token.json، يصبح رمز الدخول تمت كتابته إلى client_secrets.json، مما قد يتسبب في حدوث هذا الخطأ خلال محاولات التفويض.

لحل هذا الخطأ، نزِّل ملف سر العميل من وحدة تحكُّم Google Cloud. مرة أخرى وحفظ الملف الجديد في مكان الملف الحالي.

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

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

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

المصادقة والتفويض باستخدام امتيازات المشرف

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

Java

Python

Node.js

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

الخطوة 1: ضبط شاشة موافقة OAuth وتحديد النطاقات وتسجيل تطبيقك

الخطوة 2: إنشاء بيانات اعتماد معرِّف عميل OAuth في Google Cloud Console

إنشاء بيانات اعتماد معرِّف عميل OAuth

تطبيق الويب

Android

iOS

تطبيق Chrome

تطبيق لأجهزة الكمبيوتر المكتبي

أجهزة التلفزيون أجهزة الإدخال المحدود

Universal Windows Platform (منصة Windows العالمية)

تنزيل ملف JSON لسر العميل

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

Java

Python

Node.js

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

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

Java

Python

Node.js

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

الخطوة 5: تشغيل نموذج النص البرمجي

Java

Python

Node.js

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

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

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