呼叫 Mail Admin Quarantine API 前，請先完成本頁步驟，啟用 API、找出每項要求所需的 ID，並在 Google Workspace 帳戶中授予必要的管理員權限。
必要條件
- 具備管理員隔離區功能的 Google Workspace 帳戶。詳情請參閱「設定及管理電子郵件隔離區」。
- Google Cloud 專案。如要建立專案，請參閱「建立專案」。
- 加入 Google Workspace 開發人員預覽版計畫。您的雲端專案必須先註冊這項計畫，才能呼叫 Admin Quarantine API。
- 以超級管理員身分存取 Google 管理控制台，授予管理員權限並授權全網域委派。
啟用 API
在託管整合項目的雲端專案中啟用 mailadminquarantine.googleapis.com。
控制台
在 Google Cloud 控制台中啟用 Mail Admin Quarantine API。
gcloud
執行下列指令，並將 PROJECT_ID 替換為您的雲端專案 ID：
gcloud services enable mailadminquarantine.googleapis.com \
--project=PROJECT_ID
找到客戶 ID
每次向 Admin Quarantine API 發出要求時，系統都會使用 customers/CUSTOMER_ID 資源名稱識別您的 Google Workspace 帳戶。
如要查看客戶 ID，請按照下列步驟操作：
- 以管理員身分登入管理控制台。
- 依序點選「帳戶」>「帳戶設定」>「設定檔」。
- 複製客戶 ID。
如果客戶 ID 開頭為 C，請移除 C，並在資源名稱中使用剩餘的英數字元值，例如 customers/01abc23de。請勿使用網域名稱做為客戶 ID。
詳情請參閱「查看客戶 ID」。
授予必要的管理員權限
Admin Quarantine API 會強制執行與管理控制台中的管理員隔離區相同的管理員權限檢查。每項要求都會代表 Google Workspace 管理員執行，且該管理員必須具備下列其中一項 Gmail 權限：
| 秘密河尊爵遊覽行程 | 允許的操作 |
|---|---|
| 存取管理員隔離區 | 存取及管理所有隔離區 (包括預設隔離區) 中的郵件。 |
| 存取受限的隔離區 | 只能針對與管理員所屬群組相關聯的隔離區，存取及管理其中的郵件。 |
超級管理員會自動取得這些權限。如要為其他管理員指派包含該權限的角色，請按照下列步驟操作：
- 以超級管理員身分登入管理控制台。
- 依序點選「帳戶」>「管理員角色」。
- 選取現有角色，或按一下「建立新角色」。
- 在「權限」分頁中，依序前往「服務」>「Gmail」，然後選取「存取管理員隔離區」或「存取受限隔離區」。
- 將角色指派給整合項目在呼叫 API 時模擬的管理員帳戶。
如要進一步瞭解委派管理員角色，請參閱「在 Gmail 中委派管理員權限」和「管理員權限定義」。
如果模擬的管理員不具備必要權限，API 會傳回 403 PERMISSION_DENIED 錯誤。