يحتوي هذا المستند على معلومات التفويض والمصادقة الخاصة بواجهة برمجة التطبيقات Google Workspace Events API. قبل قراءة هذا المستند، احرص على قراءة معلومات المصادقة والتفويض العامة في Google Workspace على الرابط التعرّف على المصادقة والتفويض.
ضبط بروتوكول OAuth 2.0 للتفويض
ضبط شاشة موافقة بروتوكول OAuth واختيار النطاقات لتحديد المعلومات التي يتم عرضها للمستخدمين ومعلّقي التطبيقات، وتسجيل تطبيقك حتى تتمكّن من نشره لاحقًا
نطاقات Google Workspace Events API
لتحديد مستوى الوصول الممنوح لتطبيقك، عليك تحديد نطاقات التفويض و الإفصاح عنها. نطاق التفويض هو سلسلة عنوان موارد متحدّد (URI) في OAuth 2.0 تحتوي على اسم تطبيق Google Workspace ونوع البيانات التي يصل إليها ومستوى الوصول. النطاقات هي طلبات تطبيقك للعمل مع بيانات Google Workspace، بما في ذلك بيانات حسابات المستخدمين على Google.
عند تثبيت تطبيقك، يُطلب من المستخدم التحقّق من صحة النطاقات التي يستخدمها التطبيق. بشكل عام، يجب اختيار النطاق الذي يركز على أصغر عدد ممكن من البيانات وتجنُّب طلب النطاقات التي لا يتطلّبها تطبيقك. يمنح المستخدمون الإذن بالوصول إلى نطاقات محدودة وموضّحة بوضوح بشكلٍ أسهل.
ننصح باستخدام النطاقات غير الحسّاسة كلما أمكن، لأنّها تمنح نطاق وصول لكل ملف ويقتصر الوصول على وظائف معيّنة يحتاجها التطبيق.
تستخدِم Google Workspace Events API نطاقات من تطبيقات Google Workspace التي تتيح الاشتراكات. إذا كان تطبيقك يستخدم النطاقات المطلوبة لاشتراكك، لن تحتاج إلى إضافة نطاقات إضافية لاستخدام Google Workspace Events API.
يعرض الجدول التالي النطاقات المتوافقة مع Google Workspace Events API:
| رمز النطاق | الوصف | الاستخدام | ||
|---|---|---|---|---|
| Google Chat | ||||
https://www.googleapis.com/auth/chat.bot |
السماح لتطبيقات Google Chat بالاطّلاع على المحادثات وإرسال الرسائل منح إذن الوصول إلى جميع الميزات المتاحة لتطبيقات Chat | غير حساسة | ||
https://www.googleapis.com/auth/chat.memberships |
الاطّلاع على المشاركين في محادثات في Google Chat وإضافتهم وإزالتهم | حساسة |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
الاطّلاع على المشاركين في المحادثات على Google Chat | حساسة |
||
https://www.googleapis.com/auth/chat.spaces |
إنشاء محادثات ومساحات وعرض البيانات الوصفية أو تعديلها (بما في ذلك إعدادات السجلّ) في Google Chat | الفئات الحساسة | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
الاطّلاع على المحادثات والمساحات في Google Chat | حساسة |
||
https://www.googleapis.com/auth/chat.messages.reaction ثانية |
عرض التفاعلات مع الرسائل في Chat وإضافتها وحذفها | حساسة |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
عرض التفاعلات مع رسالة في Chat | حساسة |
||
https://www.googleapis.com/auth/chat.messages |
عرض الرسائل وإنشاؤها وإرسالها وتعديلها وحذفها وإضافة التفاعلات مع الرسائل وعرضها وحذفها | محظور | ||
https://www.googleapis.com/auth/chat.messages.readonly |
عرض الرسائل والتفاعلات في Google Chat | محظورة |
||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
السماح للتطبيقات بإنشاء البيانات الوصفية وتعديلها وقراءتها حول مساحات الاجتماعات التي أنشأها تطبيقك | حساسة |
||
https://www.googleapis.com/auth/meetings.space.readonly |
السماح للتطبيقات بقراءة البيانات الوصفية عن أي مساحة اجتماع يمكن للمستخدم الوصول إليها | حساسة |
||
يشير عمود "الاستخدام" في الجدول السابق إلى حساسية كل نطاق، وفقًا للتعريفات التالية:
غير الحسّاسة: توفّر هذه النطاقات أصغر نطاق لوصول التفويض ولا تتطلّب سوى إثبات ملكية التطبيق بشكل أساسي. للحصول على معلومات عن هذا الشرط، يُرجى الاطّلاع على خطوات الاستعداد لإثبات هويتك.
حساسة: توفّر هذه النطاقات إمكانية الوصول إلى بيانات محددة لمستخدمي Google منحها المستخدم الإذن لتطبيقك بالوصول إليها. ويتطلّب ذلك اجتياز عملية تحقّق إضافية للتطبيق. للحصول على معلومات عن هذا الشرط، يُرجى الاطّلاع على الخطوات للتطبيقات التي تطلب نطاقات حساسة.
محدود: توفّر هذه النطاقات إمكانية وصول واسعة إلى بيانات مستخدمي Google، ويُشترط عليك اجتياز عملية إثبات ملكية النطاق المحدود. للحصول على معلومات عن هذا الشرط، يُرجى الاطّلاع على خدمات Google API: سياسة بيانات المستخدمين والمتطلبات الإضافية لنطاقات واجهات برمجة التطبيقات المحدّدة. إذا كنت تخزِّن بيانات النطاق المحدود على الخوادم (أو تنقل هذه البيانات)، يجب أن تخضع لتقييم الأمان.
إذا كان تطبيقك يتطلب الوصول إلى أي واجهات برمجة تطبيقات أخرى من Google، يمكنك إضافة هذه النطاقات أيضًا. لمزيد من المعلومات عن نطاقات Google API، يُرجى الاطّلاع على مقالة استخدام بروتوكول OAuth 2.0 للوصول إلى Google APIs.
لمزيد من المعلومات عن نطاقات OAuth 2.0 المحدّدة، يُرجى الاطّلاع على نطاقات OAuth 2.0 ل Google APIs.
إثبات ملكية حساب OAuth
قد يتطلّب استخدام نطاقات OAuth معيّنة أن يمر تطبيقك بعملية التحقّق من OAuth التي تتبع Google. يُرجى الاطّلاع على الأسئلة الشائعة بشأن إثبات الملكية في واجهة برمجة تطبيقات OAuth لتحديد الحالات التي يجب فيها إثبات ملكية تطبيقك ونوع الإثبات المطلوب. يُرجى الاطّلاع أيضًا على بنود الخدمة الإضافية في Google Drive.
أنواع المصادقة المطلوبة
يوضّح هذا القسم أنواع المصادقة المطلوبة أو المتوافقة، ويقدّم النطاقات المتوافقة لكل طريقة من واجهة برمجة التطبيقات Google Workspace Events API.
بالنسبة إلى الاشتراكات في أحداث Google Chat، توفّر Google Workspace Events API
إمكانية مصادقة المستخدم والتطبيق لطلب بعض طرقها. إذا كانت إحدى مثيلات واجهة برمجة التطبيقات
تتوافق مع كلتا بيانات الاعتماد، يؤثر نوع بيانات الاعتماد المستخدَمة في الطلب
في النتيجة التي يتم عرضها. على سبيل المثال، إذا استدعيت الأسلوب
subscriptions.list()
مع مصادقة المستخدم، تعرض واجهة برمجة التطبيقات قائمة بالاشتراكات التي يمكن
للمستخدم المُعتمَد الوصول إليها. في حال استخدام مصادقة التطبيق، تعرِض واجهة برمجة التطبيقات
قائمة بالاشتراكات التي يمكن للتطبيق الوصول إليها. لمزيد من المعلومات عن
أنواع مصادقة Chat، يُرجى الاطّلاع على مقالة مصادقة وتفويض
طلبات تطبيقات Chat وGoogle Chat API.
يعرض الجدول التالي النطاقات وأنواع مصادقة العميل المطلوبة أو المتوافقة مع كل طريقة من طرق Google Workspace Events API:
| الطريقة | مصادقة المستخدم مطلوبة أو متاحة | توفُّر ميزة المصادقة في التطبيقات (تطبيقات Google Chat فقط) | نطاقات التفويض المتوافقة | |
|---|---|---|---|---|
| إنشاء اشتراك | — |
تتطلّب نطاقًا متوافقًا لكل نوع من أنواع الأحداث:
|
||
| الحصول على اشتراك |
عند مصادقة المستخدم، تتطلّب هذه الطريقة نطاقًا يتوافق مع نوع حدث واحد على الأقل للاشتراك.
باستخدام مصادقة التطبيق (تطبيقات Google Chat فقط):
|
|||
| إدراج الاشتراكات |
عند مصادقة المستخدم، تتطلّب هذه الطريقة نطاقًا يتوافق مع نوع حدث واحد على الأقل للاشتراك.
باستخدام مصادقة التطبيق (تطبيقات Google Chat فقط):
|
|||
| تعديل اشتراك | — |
تتطلّب نطاقًا متوافقًا لكل نوع من أنواع الأحداث:
|
||
| إعادة تفعيل اشتراك | — |
تتطلّب نطاقًا متوافقًا لكل نوع من أنواع الأحداث:
|
||
| حذف اشتراك |
عند مصادقة المستخدم، تتطلّب هذه الطريقة نطاقًا يتوافق مع نوع حدث واحد على الأقل للاشتراك.
باستخدام مصادقة التطبيق (تطبيقات Google Chat فقط):
|
|||
النطاقات حسب نوع الحدث
عند طلب Google Workspace Events API باستخدام مصادقة المستخدم، يجب تحديد نطاق واحد أو أكثر يتوافق مع أنواع الأحداث في الاشتراك.
يعرض الجدول التالي نطاقات التفويض المتاحة لكل نوع من الأحداث:
| الأحداث | أنواع الأحداث | نطاقات التفويض المتاحة | ||||||
|---|---|---|---|---|---|---|---|---|
| Google Chat | ||||||||
| نشر رسالة أو تعديلها |
|
|
||||||
| إضافة تفاعل أو حذفه أو تغيير تفاعلات متعددة |
|
|
||||||
| تم إنشاء اشتراك أو تعديله أو إزالته، أو تم تغيير اشتراكات متعددة |
|
|
||||||
| تعديل مساحة أو حذفها |
|
|
||||||
| Google Meet | ||||||||
| بدء مؤتمر أو انتهاؤه |
|
|
||||||
| مشارِك ينضم إلى مؤتمر أو يغادره |
|
|
||||||
| تم إنشاء تسجيل. |
|
|
||||||
| تم إنشاء نص. |
|
|
||||||