قبل طلب Mail Admin Quarantine API، أكمِل الخطوات الواردة في هذه الصفحة لتفعيل واجهة برمجة التطبيقات والعثور على المعرّفات التي يحتاجها كل طلب ومنح امتيازات المشرف المطلوبة في حسابك على Google Workspace.
المتطلبات الأساسية
- حساب Google Workspace يتضمّن ميزة "وحدة عزل المشرف" لمزيد من المعلومات، يُرجى الاطّلاع على إعداد وحدات عزل الرسائل الإلكترونية وإدارتها.
- مشروع على Google Cloud لإنشاء مشروع، يُرجى الاطّلاع على إنشاء مشروع.
- الاشتراك في برنامج معاينة المطوّرين في Google Workspace يجب تسجيل مشروعك على السحابة الإلكترونية في البرنامج قبل أن يتمكّن من طلب واجهة برمجة التطبيقات Admin Quarantine API.
- الوصول إلى "وحدة تحكّم المشرف في Google" بصفتك مشرفًا متميّزًا، لمنح امتيازات المشرف وتفويض الوصول على مستوى النطاق
تفعيل واجهة برمجة التطبيقات
فعِّل mailadminquarantine.googleapis.com في مشروع على السحابة الإلكترونية الذي يستضيف عملية الدمج.
وحدة التحكّم
في Google Cloud Console، فعِّل Mail Admin Quarantine API.
gcloud
نفِّذ الأمر التالي، مع استبدال PROJECT_ID برقم تعريف مشروعك على السحابة الإلكترونية:
gcloud services enable mailadminquarantine.googleapis.com \
--project=PROJECT_ID
العثور على الرقم التعريفي للعميل
يحدّد كل طلب إلى Admin Quarantine API حسابك على Google Workspace باستخدام اسم المورد customers/CUSTOMER_ID.
للعثور على رقم تعريف العميل:
- سجِّل الدخول إلى وحدة تحكّم المشرف بصفتك مشرفًا.
- انتقِل إلى الحساب > إعدادات الحساب > الملف الشخصي.
- انسخ رقم تعريف العميل.
إذا كان رقم تعريف العميل يبدأ بـ C، عليك إزالة C واستخدام القيمة الأبجدية الرقمية المتبقية في اسم المورد، على سبيل المثال customers/01abc23de.
لا تستخدِم اسم نطاقك كرقم تعريف العميل.
لمزيد من المعلومات، يُرجى الاطّلاع على مقالة العثور على رقم تعريف العميل.
منح امتيازات المشرف المطلوبة
تفرض واجهة Admin Quarantine API عمليات التحقّق نفسها من امتيازات المشرف مثل عمليات عزل المشرف في "وحدة تحكّم المشرف". يتم تنفيذ كل طلب نيابةً عن مشرف حسابات Google Workspace، ويجب أن يمتلك هذا المشرف أحد امتيازات Gmail التالية:
| تذكرة Privilege | الإجراءات المسموح بها |
|---|---|
| الوصول إلى وحدة عزل المشرف | الوصول إلى الرسائل وإدارتها في جميع وحدات العزل، بما في ذلك وحدة العزل التلقائية |
| الوصول إلى وحدات العزل المحظورة | الوصول إلى الرسائل وإدارتها في وحدات العزل المرتبطة بالمجموعات التي ينتمي إليها المشرف فقط |
يحصل المشرفون المتميّزون على هذه الامتيازات تلقائيًا. بالنسبة إلى المشرفين الآخرين، يمكنك إسناد دور يتضمّن الامتياز التالي:
- سجِّل الدخول إلى وحدة تحكّم المشرف بصفتك مشرفًا متميزًا.
- انتقِل إلى الحساب > أدوار المشرف.
- اختَر دورًا حاليًا أو انقر على إنشاء دور جديد.
- في علامة التبويب الامتيازات، انتقِل إلى الخدمات > Gmail واختَر الوصول إلى وحدة عزل المشرف أو الوصول إلى وحدات عزل محدّدة.
- يجب إسناد الدور إلى حساب المشرف الذي ينتحل عملية الدمج صفته عند طلب البيانات من واجهة برمجة التطبيقات.
لمعرفة تفاصيل حول أدوار المشرف المفوَّض، يُرجى الاطّلاع على تفويض امتيازات المشرف في Gmail وتعريفات امتيازات المشرف.
إذا لم يكن لدى المشرف الذي تم انتحال هويته الامتياز المطلوب، ستعرض واجهة برمجة التطبيقات الخطأ 403 PERMISSION_DENIED.