Zanim wywołasz interfejs Mail Admin Quarantine API, wykonaj czynności opisane na tej stronie, aby włączyć interfejs API, znaleźć identyfikatory wymagane przez każde żądanie i przyznać wymagane uprawnienia administratora na koncie Google Workspace.
Wymagania wstępne
- Konto Google Workspace z funkcją kwarantanny administracyjnej. Więcej informacji znajdziesz w artykule Konfigurowanie kwarantann e-maili i zarządzanie nimi.
- projekt Google Cloud, Aby dowiedzieć się, jak utworzyć projekt, przeczytaj artykuł Tworzenie projektu.
- subskrypcję programu wersji przedpremierowej Google Workspace dla deweloperów, Zanim będzie można wywołać interfejs Admin Quarantine API, projekt w chmurze musi zostać zarejestrowany w programie.
- Dostęp do konsoli administracyjnej Google jako superadministrator, aby przyznać uprawnienia administratora i autoryzować przekazywanie dostępu w całej domenie.
Włącz API
Włącz mailadminquarantine.googleapis.com w projekcie w chmurze, który hostuje Twoją integrację.
Konsola
W konsoli Google Cloud włącz interfejs Mail Admin Quarantine API.
gcloud
Uruchom to polecenie, zastępując PROJECT_ID identyfikatorem swojego projektu Cloud:
gcloud services enable mailadminquarantine.googleapis.com \
--project=PROJECT_ID
Znajdź swój identyfikator klienta
Każde żądanie wysyłane do interfejsu Admin Quarantine API identyfikuje Twoje konto Google Workspace za pomocą nazwy zasobu customers/CUSTOMER_ID.
Aby znaleźć identyfikator klienta:
- Zaloguj się w konsoli administracyjnej jako administrator.
- Kliknij Konto > Ustawienia konta > Profil.
- Skopiuj identyfikator klienta.
Jeśli identyfikator klienta zaczyna się od C, usuń C i użyj pozostałej wartości alfanumerycznej w nazwie zasobu, np. customers/01abc23de.
Nie używaj nazwy domeny jako identyfikatora klienta.
Więcej informacji znajdziesz w artykule Znajdowanie identyfikatora klienta.
Przyznawanie wymaganych uprawnień administratora
Interfejs Admin Quarantine API wymusza te same kontrole uprawnień administratora co kwarantanna administracyjna w konsoli administracyjnej. Każde żądanie jest wykonywane w imieniu administratora Google Workspace, który musi mieć jedno z tych uprawnień Gmaila:
| Pakiet Privilege | Co umożliwia |
|---|---|
| Dostęp do kwarantanny administracyjnej | Umożliwia otwieranie wiadomości znajdujących się we wszystkich kwarantannach (także w kwarantannie domyślnej) oraz zarządzanie tymi wiadomościami. |
| Dostęp do kwarantann objętych ograniczeniami | Daje dostęp do wiadomości znajdujących się tylko w kwarantannach powiązanych z grupami, do których należy administrator, i pozwala zarządzać tymi wiadomościami. |
Superadministratorzy mają te uprawnienia automatycznie. W przypadku innych administratorów przypisz rolę, która obejmuje uprawnienie:
- Zaloguj się w konsoli administracyjnej jako superadministrator.
- Otwórz Konto > Role administratora.
- Wybierz istniejącą rolę lub kliknij Utwórz nową rolę.
- Na karcie Uprawnienia kliknij Usługi > Gmail i wybierz Dostęp do kwarantanny administracyjnej lub Dostęp do kwarantann objętych ograniczeniami.
- Przypisz rolę do konta administratora, pod które podszywa się integracja podczas wywoływania interfejsu API.
Szczegółowe informacje o rolach administratora z przekazanymi uprawnieniami znajdziesz w artykułach Przekazywanie uprawnień administratora w Gmailu i Definicje uprawnień administratora.
Jeśli administrator, pod którego się podszywasz, nie ma wymaganych uprawnień, interfejs API zwraca błąd 403 PERMISSION_DENIED.