قبل‌از فراخوانی Mail Admin Quarantine API، مراحل این صفحه را تکمیل کنید تا API را فعال کنید، شناسه‌هایی را که هر درخواست نیاز دارد پیدا کنید، و امتیازهای سرپرست لازم را در حساب Google Workspace خود اعطا کنید.
پیش‌نیازها
- حساب Google Workspace با ویژگی قرنطینه سرپرست. برای کسب اطلاعات بیشتر، به راه‌اندازی و مدیریت قرنطینه ایمیل مراجعه کنید.
- پروژه Google Cloud. برای ایجاد پروژه، ایجاد پروژه را ببینید.
- عضویت در برنامه پیش‌نمایش توسعه‌دهندگان Google Workspace. پروژه Cloud شما باید در برنامه ثبت‌نام شده باشد تا بتواند Admin Quarantine API را فراخوانی کند.
- دسترسی به کنسول سرپرست Google به‌عنوان سرپرست کل، برای اعطای امتیازهای سرپرست و مجاز کردن واگذاری در سراسر دامنه.
فعال کردن میانای برنامه‌سازی کاربردی
mailadminquarantine.googleapis.com را در پروژه Cloud که میزبان ادغام شما است فعال کنید.
کنسول
در کنسول Google Cloud، Mail Admin Quarantine API را فعال کنید.
gcloud
فرمان زیر را اجرا کنید و PROJECT_ID را با شناسه پروژه Cloud خود جایگزین کنید:
gcloud services enable mailadminquarantine.googleapis.com \
--project=PROJECT_ID
یافتن شناسه مشتری
هر درخواست به Admin Quarantine API حساب Google Workspace شما را با نام منبع customers/CUSTOMER_ID شناسایی می‌کند.
برای پیدا کردن شناسه مشتری:
- به‌عنوان سرپرست به سیستم کنسول سرپرست وارد شوید.
- به حساب > تنظیمات حساب > نمایه بروید.
- شناسه مشتری را کپی کنید.
اگر شناسه مشتری با C شروع می‌شود، C را بردارید و از مقدار الفبانمایی باقی‌مانده در نام منبع استفاده کنید، برای مثال customers/01abc23de.
از نام دامنه‌تان به‌عنوان شناسه مشتری استفاده نکنید.
برای اطلاعات بیشتر، یافتن شناسه مشتری را ببینید.
اعطای امتیازهای سرپرست لازم
«میانای برنامه‌سازی کاربردی قرنطینه سرپرست» همان بررسی‌های امتیاز سرپرست را که قرنطینه سرپرست در کنسول «سرپرست» انجام می‌دهد اعمال می‌کند. هر درخواست ازطرف سرپرست Google Workspace اجرا می‌شود و آن سرپرست باید یکی از امتیازهای Gmail زیر را داشته باشد:
| ممتاز | چه چیزی را مجاز می‌کند |
|---|---|
| دسترسی به قرنطینه سرپرست | دسترسی و مدیریت پیام‌ها در همه قرنطینه‌ها، ازجمله قرنطینه پیش‌فرض. |
| دسترسی به قرنطینه‌های محدودشده | دسترسی و مدیریت پیام‌ها فقط در قرنطینه‌هایی که با گروه‌هایی که سرپرست به آن‌ها تعلق دارد مرتبط هستند. |
سرپرستان ممتاز به‌طور خودکار این امتیازها را دارند. برای سرپرستان دیگر، نقشی را اختصاص دهید که شامل این امتیاز باشد:
- به‌عنوان سرپرست ممتاز به سیستم کنسول سرپرست وارد شوید.
- به حساب > نقش‌های سرپرست بروید.
- نقش موجودی را انتخاب کنید یا روی ایجاد نقش جدید کلیک کنید.
- در برگه امتیازات، به سرویس‌ها > Gmail بروید و دسترسی به قرنطینه سرپرست یا دسترسی به قرنطینه‌های محدودشده را انتخاب کنید.
- نقش را به حساب سرپرستی اختصاص دهید که ادغام شما هنگام فراخوانی میانای برنامه‌سازی کاربردی، خود را به‌جای آن جا می‌زند.
برای جزئیات درباره نقش‌های سرپرست واگذارشده، واگذار کردن امتیازهای سرپرست در Gmail و تعاریف امتیاز سرپرست را ببینید.
اگر سرپرست جعل‌شده امتیاز لازم را نداشته باشد، API خطای 403 PERMISSION_DENIED را برمی‌گرداند.