اختيار نطاقات Google Workspace Events API

يحتوي هذا المستند على معلومات التفويض والمصادقة الخاصة بواجهة برمجة التطبيقات 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" نطاقات من تطبيقات 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 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 فقط) نطاقات التفويض المتوافقة
إنشاء اشتراك —

تتطلّب نطاقًا متوافقًا لكل نوع من أنواع الأحداث:

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • meetings.space.created
  • meetings.space.readonly
الحصول على اشتراك مع مصادقة المستخدم، تتطلّب هذه الطريقة نطاقًا يتوافق مع نوع حدث واحد على الأقل للاشتراك.

باستخدام مصادقة التطبيق (تطبيقات Google Chat فقط):

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

باستخدام مصادقة التطبيق (تطبيقات Google Chat فقط):

  • chat.bot
تعديل اشتراك —

تتطلّب نطاقًا متوافقًا لكل نوع من أنواع الأحداث:

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • meetings.space.created
  • meetings.space.readonly
إعادة تفعيل اشتراك —

تتطلّب نطاقًا متوافقًا لكل نوع من أنواع الأحداث:

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • meetings.space.created
  • meetings.space.readonly
حذف اشتراك مع مصادقة المستخدم، تتطلّب هذه الطريقة نطاقًا يتوافق مع نوع حدث واحد على الأقل للاشتراك.

من خلال مصادقة التطبيق (تطبيقات Google Chat فقط):

  • chat.bot

النطاقات حسب نوع الحدث

عند طلب Google Workspace Events API باستخدام مصادقة المستخدم، يجب تحديد نطاق واحد أو أكثر يتوافق مع أنواع الأحداث في الاشتراك.

يعرض الجدول التالي نطاقات التفويض المتاحة لكل نوع من أنواع الأحداث:

الأحداث أنواع الأحداث نطاقات التفويض المتاحة
Google Chat  
نشر رسالة أو تعديلها
  • google.workspace.chat.message.v1.created
  • google.workspace.chat.message.v1.updated
  • chat.messages
  • chat.messages.readonly
إضافة تفاعل أو حذفه أو تغيير تفاعلات متعددة
  • google.workspace.chat.reaction.v1.created
  • google.workspace.chat.reaction.v1.deleted
  • google.workspace.chat.reaction.v1.batchChanged
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.messages
  • chat.messages.readonly
تم إنشاء عضوية أو تعديلها أو إزالتها، أو تم تغيير عضويات متعددة
  • google.workspace.chat.membership.v1.created
  • google.workspace.chat.membership.v1.updated
  • google.workspace.chat.membership.v1.deleted
  • google.workspace.chat.membership.v1.batchChanged
  • chat.memberships
  • chat.memberships.readonly
تعديل مساحة أو حذفها
  • google.workspace.chat.space.v1.updated
  • google.workspace.chat.space.v1.deleted
  • chat.spaces
  • chat.spaces.readonly
Google Meet  
بدء مؤتمر أو انتهاؤه
  • google.workspace.meet.conference.v2.started
  • google.workspace.meet.conference.v2.ended
  • meetings.space.created
  • meetings.space.readonly
مشارِك ينضم إلى مؤتمر أو يغادره
  • google.workspace.meet.participant.v2.joined
  • google.workspace.meet.participant.v2.left
  • meetings.space.created
  • meetings.space.readonly
تم إنشاء تسجيل.
  • google.workspace.meet.recording.v2.fileGenerated
  • meetings.space.created
  • meetings.space.readonly
تم إنشاء نص.
  • google.workspace.meet.transcript.v2.fileGenerated
  • meetings.space.created
  • meetings.space.readonly