Ten dokument zawiera informacje na temat autoryzacji i uwierzytelniania w interfejsie Gmail API. Przed przeczytaniem tego dokumentu zapoznaj się z ogólnymi informacjami o uwierzytelnianiu i autoryzacji w Google Workspace, które znajdziesz w artykule Więcej informacji o uwierzytelnianiu i autoryzacji.
Konfigurowanie OAuth 2.0 na potrzeby autoryzacji
Konfigurowanie ekranu zgody OAuth i wybieranie zakresów, aby określić, jakie informacje są wyświetlane użytkownikom i sprawdzającym aplikację, oraz zarejestrować aplikację, aby można ją było opublikować.
Zakresy interfejsu Gmail API
Aby określić poziom dostępu przyznanego aplikacji, musisz zidentyfikować i zadeklarować zakresy autoryzacji. Zakres autoryzacji to ciąg znaków URI OAuth 2.0 zawierający nazwę aplikacji Google Workspace, rodzaj danych, do których ma ona dostęp, oraz poziom dostępu. Zakresy to żądania aplikacji dotyczące dostępu do danych Google Workspace, w tym danych z konta Google użytkowników.
Po zainstalowaniu aplikacji użytkownik musi zatwierdzić zakresy używane przez aplikację. Zazwyczaj należy wybrać jak najbardziej ograniczony zakres i unikać żądania zakresów, których aplikacja nie wymaga. Użytkownicy chętniej udzielają dostępu do ograniczonych, jasno opisanych zakresów.
Interfejs Gmail API obsługuje te zakresy:
| Kod zakresu | Opis | Wykorzystanie |
|---|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose |
Zarządzanie wersjami roboczymi i wysyłanie e-maili w trakcie korzystania z dodatku. | Niepoufne |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
Wyświetlanie e-maili w trakcie korzystania z dodatku. | Niepoufne |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
Wyświetlanie metadanych wiadomości e-mail, gdy dodatek jest uruchomiony. | Poufne |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
Wyświetlanie e-maili, gdy dodatek jest uruchomiony. | Poufne |
https://www.googleapis.com/auth/gmail.labels |
Tylko tworzenie, odczytywanie, aktualizowanie i usuwanie etykiet. | Niepoufne |
https://www.googleapis.com/auth/gmail.send |
tylko wysyłać wiadomości; Brak uprawnień do odczytu ani modyfikacji skrzynki pocztowej. | Poufne |
https://www.googleapis.com/auth/gmail.readonly |
odczyt wszystkich zasobów i ich metadanych (bez operacji zapisu). | Z ograniczeniem |
https://www.googleapis.com/auth/gmail.compose |
tworzyć, odczytywać, aktualizować i usuwać wersje robocze; wysyłać wiadomości i wersje robocze; | Z ograniczeniem |
https://www.googleapis.com/auth/gmail.insert |
Wstawiaj i importuj tylko wiadomości. | Z ograniczeniem |
https://www.googleapis.com/auth/gmail.modify |
Wszystkie operacje odczytu/zapisu z wyjątkiem natychmiastowego, trwałego usunięcia wątków i wiadomości bez przechodzenia przez Kosz. | Z ograniczeniem |
https://www.googleapis.com/auth/gmail.metadata |
odczytywać metadane zasobów, w tym etykiety, rekordy historii i nagłówki wiadomości e-mail, ale nie ich treści ani załączników; | Z ograniczeniem |
https://www.googleapis.com/auth/gmail.settings.basic |
zarządzać podstawowymi ustawieniami poczty; | Z ograniczeniem |
https://www.googleapis.com/auth/gmail.settings.sharing |
zarządzać poufnymi ustawieniami poczty, w tym regułami przekierowania i aliasami;
Uwaga: operacje chronione przez ten zakres są przeznaczone wyłącznie do użytku administracyjnego. Są one dostępne tylko dla klientów Google Workspace korzystających z konta usługi z delegowanymi uprawnieniami w całej domenie. |
Z ograniczeniem |
https://mail.google.com/ |
Pełny dostęp do skrzynek pocztowych na koncie, w tym możliwość trwałego usuwania wątków i wiadomości. O ten zakres dostępu należy poprosić tylko wtedy, gdy aplikacja musi natychmiast i trwało usuwać wątki i wiadomości, pomijając Kosz. Wszystkie inne działania można wykonywać w ramach zakresów dostępu o mniejszym zakresie. | Z ograniczeniem |
Kolumna „Użycie” w tabeli powyżej wskazuje czułość każdego zakresu według tych definicji:
Niewrażliwe – te zakresy zapewniają najmniejsze uprawnienia dostępu i wymagają tylko podstawowej weryfikacji aplikacji. Więcej informacji o tym wymaganiu znajdziesz w artykule Przygotowanie do weryfikacji.
Wrażliwe – te zakresy umożliwiają dostęp do danych użytkowników Google i wymagają procesu weryfikacji zakresu wrażliwego. Więcej informacji o tym wymaganiu znajdziesz w zasadach dotyczących danych użytkownika w usługach interfejsu API Google. Te zakresy nie wymagają oceny bezpieczeństwa.
Ograniczony – te zakresy zapewniają szeroki dostęp do danych użytkownika Google i wymagają przejścia procesu weryfikacji zakresu z ograniczeniami. Więcej informacji o tym wymaganiu znajdziesz w zasadach dotyczących danych użytkownika w usługach interfejsu API Google i dodatkowych wymaganiach dotyczących konkretnych zakresów interfejsu API. Jeśli przechowujesz dane o ograniczonym zakresie na serwerach (lub je przesyłasz), musisz przejść ocenę bezpieczeństwa.
Dodatkowe informacje, które określają zasady korzystania z interfejsów Gmail API i dostępu do nich w przypadku żądania dostępu do danych użytkownika, znajdziesz w Zasadach dotyczących danych użytkownika i zasadach dla deweloperów dotyczących usług interfejsu API Gmail.
Jeśli Twoja aplikacja wymaga dostępu do innych interfejsów API Google, możesz też dodać te zakresy. Więcej informacji o zakresach interfejsów API Google znajdziesz w artykule Używanie protokołu OAuth 2.0 na potrzeby dostępu do interfejsów API Google.
Weryfikacja OAuth
Korzystanie z pewnych wrażliwych zakresów OAuth może wymagać, aby aplikacja przeszła proces weryfikacji OAuth w Google. Aby dowiedzieć się, kiedy aplikacja powinna przejść weryfikację i jakiego typu weryfikacja jest wymagana, przeczytaj najczęstsze pytania dotyczące weryfikacji OAuth. Zobacz też zasady dotyczące danych użytkownika w usługach interfejsu API Google.