Mail Admin Quarantine API'yi çağırmadan önce bu sayfadaki adımları tamamlayarak API'yi etkinleştirin, her isteğin ihtiyaç duyduğu tanımlayıcıları bulun ve Google Workspace hesabınızda gerekli yönetici ayrıcalıklarını verin.
Ön koşullar
- Yönetici karantinası özelliğine sahip bir Google Workspace hesabı. Daha fazla bilgi edinmek için E-posta karantinaları oluşturma ve yönetme başlıklı makaleyi inceleyin.
- Google Cloud projesi. Proje oluşturmak için Proje oluşturma başlıklı makaleyi inceleyin.
- Google Workspace Geliştirici Önizleme Programı üyeliği Cloud projenizin Yönetici Karantinası API'sini çağırabilmesi için programa kayıtlı olması gerekir.
- Yönetici ayrıcalıkları vermek ve alan genelinde yetkiyi onaylamak için Google Yönetici Konsolu'na süper yönetici olarak erişim.
API'yi etkinleştirme
Entegrasyonunuzu barındıran Cloud projesinde mailadminquarantine.googleapis.com API'yi etkinleştirin.
Konsol
Google Cloud Console'da Mail Admin Quarantine API'yi etkinleştirin.
gcloud
PROJECT_ID yerine Cloud proje kimliğinizi yazarak aşağıdaki komutu çalıştırın:
gcloud services enable mailadminquarantine.googleapis.com \
--project=PROJECT_ID
Müşteri kimliğinizi bulma
Admin Quarantine API'ye gönderilen her istek, Google Workspace hesabınızı customers/CUSTOMER_ID kaynak adıyla tanımlar.
Müşteri kimliğinizi bulmak için:
- Yönetici Konsolu'nda yönetici olarak oturum açın.
- Hesap > Hesap ayarları > Profil'e gidin.
- Müşteri kimliğini kopyalayın.
Müşteri kimliği C ile başlıyorsa C değerini kaldırın ve kaynak adında kalan alfanümerik değeri (ör. customers/01abc23de) kullanın.
Müşteri kimliği olarak alan adınızı kullanmayın.
Daha fazla bilgi için Müşteri kimliğinizi bulma başlıklı makaleyi inceleyin.
Gerekli yönetici ayrıcalıklarını verme
Admin Quarantine API, Yönetici Konsolu'ndaki yönetici karantinasıyla aynı yönetici ayrıcalığı kontrollerini zorunlu kılar. Her istek bir Google Workspace yöneticisi adına çalıştırılır ve bu yöneticinin aşağıdaki Gmail ayrıcalıklarından birine sahip olması gerekir:
| Privilege | İzin verdiği işlemler |
|---|---|
| Yönetici karantinasına erişme | Varsayılan karantina dahil tüm karantinalardaki iletilere erişebilir ve bunları yönetebilir. |
| Kısıtlı karantinalara erişim | Yalnızca yöneticinin ait olduğu gruplarla ilişkili karantinalardaki iletilere erişebilir ve bunları yönetebilir. |
Süper yöneticiler bu ayrıcalıklara otomatik olarak sahiptir. Diğer yöneticiler için ayrıcalığı içeren bir rol atayın:
- Yönetici Konsolu'nda süper yönetici olarak oturum açın.
- Hesap > Yönetici rolleri'ne gidin.
- Mevcut bir rolü seçin veya Yeni rol oluştur'u tıklayın.
- Ayrıcalıklar sekmesinde Hizmetler > Gmail'e gidin ve Yönetici Karantinası'na Erişim veya Kısıtlı karantinalara erişim'i seçin.
- Rolü, entegrasyonunuzun API'yi çağırırken kimliğine büründüğü yönetici hesabına atayın.
Yetki verilmiş yönetici rolleri hakkında ayrıntılı bilgi için Gmail'de yönetici ayrıcalıkları için yetki verme ve Yönetici ayrıcalığı tanımları başlıklı makaleleri inceleyin.
Kimliğine bürünülen yönetici gerekli ayrıcalığa sahip değilse API, 403 PERMISSION_DENIED hatası döndürür.