اختيار نطاقات 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 Events API نطاقات من تطبيقات Google Workspace التي تتيح الاشتراكات. إذا كان تطبيقك يستخدم النطاقات المطلوبة للاشتراك، لن تحتاج إلى إضافة نطاقات لاستخدام Google Workspace Events API. إذا أضفت نطاقات، اختَر النطاق الأقل حساسية الذي يتيح لتطبيقك العمل. لمعرفة تفاصيل حول فئات النطاقات، يُرجى الاطّلاع على فئات النطاقات.

يسرد الجدول التالي النطاقات المتوافقة مع Google Workspace Events API:

رمز النطاق الوصف الاستخدام
Google Chat  
https://www.googleapis.com/auth/chat.bot تسمح تطبيقات Lets Chat بعرض المحادثات وإرسال الرسائل. يمنح هذا النطاق إذن الوصول إلى جميع الميزات المتاحة لتطبيقات Chat. غير حساسة
https://www.googleapis.com/auth/chat.memberships الاطّلاع على المشاركين في محادثات في Chat وإضافتهم وإزالتهم
حسّاسة
https://www.googleapis.com/auth/chat.memberships.readonly الاطّلاع على المشاركين في محادثات Chat
حسّاسة
https://www.googleapis.com/auth/chat.app.memberships

الاطّلاع على الأعضاء وإضافتهم وإزالتهم وتعديل معلوماتهم في المحادثات والمساحات في Chat كتطبيق Chat

يتطلّب ذلك موافقة المشرف.

يتيح هذا النطاق مصادقة التطبيق باستخدام حسابات الخدمة فقط. لا يمكنك المصادقة باستخدام بيانات اعتماد المستخدم أو باستخدام تفويض على مستوى النطاق باستخدام هذا النطاق.


حسّاسة
https://www.googleapis.com/auth/chat.spaces إنشاء محادثات ومساحات وعرض البيانات الوصفية أو تعديلها (بما في ذلك إعدادات السجلّ) في Chat حسّاس
https://www.googleapis.com/auth/chat.spaces.readonly الاطّلاع على المحادثات والمساحات في Chat
حسّاسة
https://www.googleapis.com/auth/chat.app.spaces

إنشاء محادثات ومساحات وعرض البيانات الوصفية أو تعديلها (بما في ذلك إعدادات السجلّ) في Chat كتطبيق 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 عرض الرسائل والتفاعلات في Chat
مقيَّدة
https://www.googleapis.com/auth/chat.app.messages.readonly

عرض الرسائل والتفاعلات في Chat كتطبيق 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 لتحديد الحالات التي يجب فيها التحقّق من تطبيقك ونوع التحقّق المطلوب. يُرجى الاطّلاع أيضًا على بنود خدمة Drive.

أنواع المصادقة المطلوبة

يوضّح هذا القسم أنواع المصادقة المطلوبة أو المتاحة، ويقدّم النطاقات المتاحة لكل طريقة من طرق واجهة برمجة التطبيقات Google Workspace Events API.

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

يعرض الجدول التالي النطاقات وأنواع المصادقة المطلوبة أو المتوافقة مع كل طريقة من طرق Google Workspace Events API:

الطريقة المصادقة مطلوبة أو متاحة تتوفّر مصادقة التطبيقات (تطبيقات Chat فقط) نطاقات الأذونات المتاحة
إنشاء اشتراك

عند مصادقة المستخدم، يجب توفُّر نطاق متوافق لكل نوع حدث:

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • drive.file
  • drive
  • drive.readonly
  • drive.metadata
  • drive.metadata.readonly
  • meetings.space.created
  • meetings.space.readonly

إصدار تجريبي للمطوّرين: مع مصادقة التطبيق وموافقة المشرف (تطبيقات Chat فقط)، يتطلّب نطاقًا متوافقًا لكل نوع حدث:

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

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

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

باستخدام مصادقة التطبيق (تطبيقات 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
  • drive.file
  • drive
  • drive.readonly
  • drive.metadata
  • drive.metadata.readonly
  • meetings.space.created
  • meetings.space.readonly

إصدار تجريبي للمطوّرين: مع مصادقة التطبيق وموافقة المشرف (تطبيقات Chat فقط)، يتطلّب نطاقًا متوافقًا لكل نوع حدث:

  • chat.app.memberships
  • chat.app.spaces
  • chat.app.messages.readonly
إعادة تفعيل اشتراك

عند مصادقة المستخدم، يجب توفُّر نطاق متوافق لكل نوع حدث:

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • drive.file
  • drive
  • drive.readonly
  • drive.metadata
  • drive.metadata.readonly
  • meetings.space.created
  • meetings.space.readonly

إصدار تجريبي للمطوّرين: مع مصادقة التطبيق وموافقة المشرف (تطبيقات Chat فقط)، يتطلّب نطاقًا متوافقًا لكل نوع حدث:

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

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

  • chat.bot

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

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

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

الأحداث أنواع الأحداث نطاقات الأذونات المتاحة
Chat  
يتم نشر رسالة أو تعديلها.
  • google.workspace.chat.message.v1.created
  • google.workspace.chat.message.v1.updated
باستخدام مصادقة المستخدم:
  • chat.messages
  • chat.messages.readonly
باستخدام مصادقة التطبيق وموافقة المشرف (المتاحتَين في معاينة المطوّر):
  • chat.app.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
باستخدام مصادقة التطبيق وموافقة المشرف (المتاحتَين في معاينة المطوّر):
  • chat.app.memberships
تم تعديل مساحة أو حذفها.
  • google.workspace.chat.space.v1.updated
  • google.workspace.chat.space.v1.deleted
باستخدام مصادقة المستخدم:
  • chat.spaces
  • chat.spaces.readonly
باستخدام مصادقة التطبيق وموافقة المشرف (المتاحتَين في معاينة المطوّر):
  • chat.app.spaces
Drive  
تم إنشاء ملف أو تغييره أو نقله أو حذفه أو إعادة تسميته أو نقله إلى المهملات أو إزالته من المهملات.
  • google.workspace.drive.file.v3.added
  • google.workspace.drive.file.v3.moved
  • google.workspace.drive.file.v3.contentChanged
  • google.workspace.drive.file.v3.deleted
  • google.workspace.drive.file.v3.renamed
  • google.workspace.drive.file.v3.trashed
  • google.workspace.drive.file.v3.untrashed
  • drive
  • drive.file
  • drive.readonly
  • drive.metadata
يتم إنشاء اقتراح وصول أو الاستجابة إليه في ملف.
  • google.workspace.drive.accessProposal.v3.created
  • google.workspace.drive.accessProposal.v3.resolved
  • drive
  • drive.file
  • drive.readonly
  • drive.metadata
  • drive.metadata
  • drive.metadata.readonly
تم إلغاء موافقة أو إكمالها أو إنشاؤها أو إعادة ضبطها أو تغيير المراجعين أو ردّ المراجعين على ملف.
  • google.workspace.drive.approval.v3.cancelled
  • google.workspace.drive.approval.v3.completed
  • google.workspace.drive.approval.v3.created
  • google.workspace.drive.approval.v3.reset
  • google.workspace.drive.approval.v3.reviewersChanged
  • google.workspace.drive.approval.v3.reviewerResponded
  • drive
  • drive.file
  • drive.readonly
  • drive.metadata
  • drive.metadata
  • drive.metadata.readonly
تم إنشاء تعليق أو حذفه أو تعديله أو إعادة فتحه أو حلّه في ملف.
  • google.workspace.drive.comment.v3.created
  • google.workspace.drive.comment.v3.deleted
  • google.workspace.drive.comment.v3.edited
  • google.workspace.drive.comment.v3.reopened
  • google.workspace.drive.comment.v3.resolved
  • drive
  • drive.file
  • drive.readonly
  • drive.metadata
  • drive.metadata
  • drive.metadata.readonly
يتم إنشاء رد أو حذفه أو تعديله في ملف.
  • google.workspace.drive.reply.v3.created
  • google.workspace.drive.reply.v3.deleted
  • google.workspace.drive.reply.v3.edited
  • drive
  • drive.file
  • drive.readonly
  • drive.metadata
  • drive.metadata
  • drive.metadata.readonly
يتم إنشاء إذن أو حذفه أو تعديله على ملف.
  • google.workspace.drive.permission.v3.created
  • google.workspace.drive.permission.v3.deleted
  • google.workspace.drive.permission.v3.edited
  • drive
  • drive.file
  • drive.readonly
  • drive.metadata
  • drive.metadata
  • drive.metadata.readonly
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