يحتوي هذا المستند على معلومات حول المصادقة والتفويض الخاصة بواجهة برمجة التطبيقات 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 Drive | ||||
https://www.googleapis.com/auth/drive.file |
إنشاء ملفات جديدة على Drive أو تعديل الملفات الحالية التي تفتحها باستخدام تطبيق أو التي يشاركها المستخدم مع تطبيق أثناء استخدام Google Picker API أو أداة اختيار الملفات في التطبيق | غير حساسة | ||
https://www.googleapis.com/auth/drive |
عرض جميع ملفاتك في Drive وإدارتها | محظور | ||
https://www.googleapis.com/auth/drive.readonly |
عرض جميع ملفات Drive وتنزيلها | محظور | ||
https://www.googleapis.com/auth/drive.metadata |
عرض البيانات الوصفية للملفات وإدارتها في Drive | محظور | ||
https://www.googleapis.com/auth/drive.metadata.readonly |
عرض البيانات الوصفية للملفات في Drive | محظور | ||
| 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. اطّلِع على الأسئلة الشائعة حول تطبيقات OAuth لتحديد الحالات التي يجب فيها التحقّق من تطبيقك ونوع التحقّق المطلوب. يُرجى الاطّلاع أيضًا على بنود خدمة Google Drive.
أنواع المصادقة المطلوبة
يوضّح هذا القسم أنواع المصادقة المطلوبة أو المتاحة، ويقدّم النطاقات المتاحة لكل طريقة من طرق استخدام Google Workspace Events API.
بالنسبة إلى الاشتراكات في أحداث Google Chat، تتيح "واجهة برمجة تطبيقات أحداث Google Workspace" مصادقة المستخدم والتطبيق لاستدعاء بعض طرقها. إذا كانت إحدى طرق واجهة برمجة التطبيقات تتيح استخدام نوعَي بيانات الاعتماد، سيؤثر نوع بيانات الاعتماد المستخدَمة في الطلب في النتيجة التي يتم عرضها. على سبيل المثال، إذا استدعيت الطريقة
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 Drive | ||||||||
| تم إنشاء ملف أو تغييره أو نقله أو حذفه أو نقله إلى المهملات أو إزالته من المهملات. |
|
|
||||||
| يتم إنشاء اقتراح وصول أو الاستجابة إليه في ملف. |
|
|
||||||
| Google Meet | ||||||||
| بدء مؤتمر أو انتهائه |
|
|
||||||
| ينضم مشارك إلى مؤتمر أو يغادره. |
|
|
||||||
| تم إنشاء تسجيل. |
|
|
||||||
| تم إنشاء نسخة نصية. |
|
|
||||||