Mail Admin Quarantine API を呼び出す前に、このページの手順を完了して API を有効にし、すべてのリクエストに必要な ID を見つけて、Google Workspace アカウントに必要な管理者権限を付与します。
前提条件
- 管理者検疫機能が有効になっている Google Workspace アカウント。詳しくは、メール検疫の設定と管理をご覧ください。
- Google Cloud プロジェクト プロジェクトを作成するには、プロジェクトを作成するをご覧ください。
- Google Workspace デベロッパー プレビュー プログラムのメンバーシップ。Admin Quarantine API を呼び出すには、クラウド プロジェクトをプログラムに登録する必要があります。
- 特権管理者として Google 管理コンソールにアクセスし、管理者権限を付与してドメイン全体の委任を承認します。
API を有効にする
統合をホストするクラウド プロジェクトで mailadminquarantine.googleapis.com を有効にします。
Console
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 エラーを返します。