يتضمّن هذا المستند معلومات حول المصادقة والتفويض الخاصة بواجهة Gmail API. قبل قراءة هذا المستند، احرص على قراءة معلومات المصادقة والتفويض العامة في Google Workspace على الرابط مزيد من المعلومات عن المصادقة والتفويض.
ضبط OAuth 2.0 للحصول على إذن
ضبط شاشة موافقة بروتوكول OAuth واختيار النطاقات لتحديد المعلومات التي يتم عرضها للمستخدمين ومراجعي التطبيقات، وتسجيل تطبيقك كي تتمكّن من نشره لاحقًا
نطاقات Gmail API
لتحديد مستوى الوصول الممنوح لتطبيقك، عليك تحديد نطاقات الأذونات والإفصاح عنها. نطاق التفويض هو سلسلة URI بتنسيق OAuth 2.0 تحتوي على اسم تطبيق Google Workspace ونوع البيانات التي يمكنه الوصول إليها ومستوى الوصول. النطاقات هي طلبات تطبيقك للعمل مع بيانات Google Workspace، بما في ذلك بيانات حسابات المستخدمين على Google.
عند تثبيت تطبيقك، يُطلب من المستخدم التحقّق من صحة النطاقات التي يستخدمها التطبيق. وبشكل عام، عليك اختيار النطاق الأكثر تركيزًا وتجنُّب طلب نطاقات لا يحتاجها تطبيقك. يمنح المستخدمون إذن الوصول إلى النطاقات المحدودة والموضّحة بوضوح بشكل أسهل.
استخدِم النطاقات غير الحسّاسة متى أمكن ذلك لتضييق نطاق الوصول إلى الميزات المحدّدة التي يحتاجها التطبيق فقط.
النطاقات غير الحسّاسة
ننصح باستخدام نطاقات Gmail API التالية لمعظم حالات الاستخدام:
| رمز النطاق | الوصف |
|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose |
إدارة المسودات وإرسال رسائل البريد الإلكتروني عند التفاعل مع الإضافة |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
عرض رسائل البريد الإلكتروني عند التفاعل مع الإضافة |
https://www.googleapis.com/auth/gmail.labels |
الاطّلاع على تصنيفات بريدك الإلكتروني وتعديلها |
النطاقات الحسّاسة
| رمز النطاق | الوصف |
|---|---|
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
عرض البيانات الوصفية للرسالة الإلكترونية عند تشغيل الإضافة |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
عرض رسائل البريد الإلكتروني عندما تكون الإضافة مشغّلة |
https://www.googleapis.com/auth/gmail.send |
إرسال رسالة إلكترونية بالنيابة عنك |
النطاقات المحظورة
| رمز النطاق | الوصف |
|---|---|
https://mail.google.com/ |
قراءة جميع رسائلك الإلكترونية من Gmail وإنشاؤها وإرسالها وحذفها نهائيًا
ملاحظة: لا تطلب هذا النطاق إلا إذا كان تطبيقك بحاجة إلى حذف سلاسل المحادثات والرسائل على الفور وبشكل دائم، مع تجاهل المهملات. يمكنك تنفيذ جميع الإجراءات الأخرى باستخدام نطاقات أقل تساهلاً. |
https://www.googleapis.com/auth/gmail.readonly |
عرض رسائلك الإلكترونية وإعداداتك |
https://www.googleapis.com/auth/gmail.compose |
إدارة المسودات وإرسال الرسائل الإلكترونية |
https://www.googleapis.com/auth/gmail.insert |
إضافة الرسائل الإلكترونية إلى صندوق بريدك الإلكتروني في Gmail |
https://www.googleapis.com/auth/gmail.modify |
قراءة الرسائل الإلكترونية وإنشاؤها وإرسالها من حسابك على Gmail لا يتيح هذا النطاق الحذف الفوري والدائم لسلاسل المحادثات والرسائل، مع تجاوز مجلد المهملات. |
https://www.googleapis.com/auth/gmail.metadata |
عرض البيانات الوصفية لرسالتك الإلكترونية مثل التصنيفات والعناوين، ولكن لا يتم عرض نص الرسالة الإلكترونية |
https://www.googleapis.com/auth/gmail.settings.basic |
الاطّلاع على إعدادات البريد الإلكتروني والفلاتر أو تعديلها أو إنشاؤها أو تغييرها في Gmail |
https://www.googleapis.com/auth/gmail.settings.sharing |
إدارة إعدادات البريد الحساسة، بما في ذلك من يمكنه إدارة بريدك
ملاحظة: العمليات التي يغطيها هذا النطاق محصورة بالاستخدام الإداري فقط. ولا تتوفّر إلا لعملاء Google Workspace الذين يستخدمون حساب خدمة مع تفويض على مستوى النطاق. |
تشير النطاقات في الجداول السابقة إلى مستوى حساسيتها، وفقًا للتعريفات التالية:
غير حساسة: توفّر هذه النطاقات أصغر نطاق من أذونات الوصول، ولا تتطلّب سوى التحقّق الأساسي من تطبيق OAuth. لمزيد من المعلومات، يُرجى الاطّلاع على متطلبات التحقّق.
حسّاسة: تتيح هذه النطاقات الوصول إلى بيانات المستخدمين المحدّدة على Google التي يمنحون تطبيقك الإذن بالوصول إليها، وتتطلّب هذه النطاقات إجراء التحقّق من تطبيقات OAuth. لمزيد من المعلومات، يُرجى الاطّلاع على متطلبات النطاق الحساس والمقيّد.
مقيّدة: توفّر هذه النطاقات إمكانية وصول واسعة إلى بيانات مستخدمي Google وتتطلّب التحقّق من تطبيق OAuth الذي يستخدم نطاقًا مقيّدًا. لمزيد من المعلومات، يُرجى الاطّلاع على سياسة بيانات المستخدمين الخاصة بخدمات Google API والمتطلبات الإضافية لنطاقات واجهات برمجة التطبيقات المحدّدة.
إذا كنت تخزّن بيانات النطاق المحدود على خوادم (أو تنقلها)، عليك اجتياز تقييم أمان.
يمكنك الاطّلاع على معلومات إضافية تحكم استخدامك لواجهات Gmail API والوصول إليها عند طلب الوصول إلى بيانات المستخدمين في سياسة بيانات المستخدمين وسياسة المطوّرين في Google Workspace API.
إذا كان تطبيقك يتطلّب الوصول إلى أي واجهات برمجة تطبيقات أخرى من Google، يمكنك إضافة هذه النطاقات أيضًا. لمزيد من المعلومات عن نطاقات Google API، يُرجى الاطّلاع على استخدام بروتوكول OAuth 2.0 للدخول إلى واجهات Google APIs.
لمزيد من المعلومات حول نطاقات OAuth 2.0 المحدّدة، يُرجى الاطّلاع على نطاقات OAuth 2.0 لـ Google APIs.
التحقّق من OAuth
قد يتطلّب استخدام بعض نطاقات OAuth الحساسة أن يكمل تطبيقك عملية التحقّق من OAuth التي تجريها Google. يمكن أن تساعدك الأسئلة الشائعة حول التحقّق من تطبيقات OAuth في تحديد ما إذا كان ذلك ضروريًا ونوع التحقّق المطلوب.