Ten dokument zawiera specyficzne dla interfejsu Gmail API informacje na temat autoryzacji i uwierzytelniania. Zanim przeczytasz ten dokument, zapoznaj się z ogólnymi informacjami o uwierzytelniania i autoryzacji w Google Workspace w artykule Więcej informacji o uwierzytelnianiu i autoryzacji.
Konfigurowanie protokołu OAuth 2.0 na potrzeby autoryzacji
Skonfiguruj ekran zgody OAuth i wybierz zakresy, aby określić, jakie informacje będą widoczne dla użytkowników i weryfikatorów aplikacji, oraz zarejestrować aplikację, aby móc ją później opublikować.
Zakresy interfejsów API Gmaila
Aby określić poziom dostępu przyznany aplikacji, musisz wskazać i zadeklarować zakresy autoryzacji. Zakres autoryzacji to ciąg identyfikatora URI OAuth 2.0 zawierający nazwę aplikacji Google Workspace, rodzaj danych, do których aplikacja ma dostęp, oraz poziom dostępu. Zakresy to żądania aplikacji dotyczące pracy z danymi Google Workspace, w tym danymi kont Google użytkowników.
Po zainstalowaniu aplikacji użytkownik jest proszony o sprawdzenie zakresów używanych przez aplikację. Warto wybrać najwęższy możliwy zakres i unikać żądania zakresów, które nie są wymagane przez aplikację. Użytkownicy łatwiej przyznają dostęp 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ądzaj wersjami roboczymi i wysyłaj e-maile, gdy korzystasz z dodatku. | Niewrażliwe |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
Wyświetlaj e-maile podczas korzystania z dodatku. | Niewrażliwe |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
Wyświetlanie metadanych e-maili, gdy dodatek jest uruchomiony. | Poufne |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
wyświetlać e-maile, gdy dodatek jest uruchomiony. | Poufne |
https://www.googleapis.com/auth/gmail.labels |
Tylko tworzenie, odczytywanie, aktualizowanie i usuwanie etykiet. | Niewrażliwe |
https://www.googleapis.com/auth/gmail.send |
Wysyłaj tylko wiadomości. Brak uprawnień do odczytu i modyfikacji skrzynki pocztowej. | Poufne |
https://www.googleapis.com/auth/gmail.readonly |
Odczytywanie wszystkich zasobów i ich metadanych – bez operacji zapisu. | Z ograniczonym dostępem |
https://www.googleapis.com/auth/gmail.compose |
Tworzenie, odczytywanie, aktualizowanie i usuwanie wersji roboczych. wysyłać wiadomości i wersje robocze, | Z ograniczonym dostępem |
https://www.googleapis.com/auth/gmail.insert |
Wstawianie i importowanie tylko wiadomości. | Z ograniczonym dostępem |
https://www.googleapis.com/auth/gmail.modify |
Wszystkie operacje odczytu/zapisu z wyjątkiem natychmiastowego, trwałego usuwania wątków i wiadomości z pominięciem kosza. | Z ograniczonym dostępem |
https://www.googleapis.com/auth/gmail.metadata |
Odczytywanie metadanych zasobów, w tym etykiet, rekordów historii i nagłówków wiadomości e-mail, ale nie treści wiadomości ani załączników. | Z ograniczonym dostępem |
https://www.googleapis.com/auth/gmail.settings.basic |
Zarządzanie podstawowymi ustawieniami poczty. | Z ograniczonym dostępem |
https://www.googleapis.com/auth/gmail.settings.sharing |
Zarządzanie poufnymi ustawieniami poczty, w tym regułami przekazywania i aliasami.
Uwaga: operacje chronione przez ten zakres są ograniczone tylko do użytku administracyjnego. Są one dostępne tylko dla klientów Google Workspace korzystających z konta usługi z przekazywaniem dostępu w całej domenie. |
Z ograniczonym dostępem |
https://mail.google.com/ |
Pełny dostęp do skrzynek pocztowych konta, w tym trwałe usuwanie wątków i wiadomości. Ten zakres należy prosić tylko wtedy, gdy aplikacja musi natychmiast i trwale usunąć wątki i wiadomości z pominięciem kosza. Wszystkie inne czynności można wykonywać przy użyciu mniej restrykcyjnych zakresów. | Z ograniczonym dostępem |
Kolumna Użycie w tabeli powyżej pokazuje wrażliwość poszczególnych zakresów, zgodnie z tymi definicjami:
Niewrażliwe – te zakresy zapewniają najmniejszy zakres dostępu do autoryzacji i wymagają tylko podstawowej weryfikacji aplikacji. Więcej informacji na temat tego wymogu znajdziesz w artykule Przygotowanie do weryfikacji.
Poufne – te zakresy umożliwiają dostęp do danych użytkowników Google i wymagają procesu weryfikacji zakresu wrażliwego. Więcej informacji na temat tego wymogu znajdziesz w artykule Zasady dotyczące danych użytkownika w usługach interfejsu API Google. Te zakresy nie wymagają oceny zabezpieczeń.
Ograniczony dostęp – te zakresy zapewniają szeroki dostęp do danych użytkowników Google i wymagają przejścia procesu weryfikacji zakresu z ograniczeniami. Informacje o tym wymaganiu znajdziesz w artykułach Zasady dotyczące danych użytkownika związane z usługami interfejsu API Google i Dodatkowe wymagania dotyczące określonych zakresów interfejsu API. Jeśli przechowujesz na serwerach dane z zakresu ograniczonego dostępu (lub je przesyłasz), musisz przeprowadzić ocenę zabezpieczeń.
Dodatkowe informacje dotyczące używania interfejsów Gmail API i uzyskiwania do nich dostępu, gdy prosisz o dostęp do danych użytkownika, znajdziesz w zasadach dla deweloperów i danych użytkownika interfejsu Gmail API.
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 na temat uzyskiwania dostępu do interfejsów API Google za pomocą OAuth 2.0.
Weryfikacja OAuth
Używanie niektórych poufnych zakresów OAuth może wymagać przejścia przez aplikację procesu weryfikacji OAuth przez Google. Przeczytaj Najczęstsze pytania na temat weryfikacji OAuth, aby określić, kiedy aplikacja powinna przejść weryfikację i jaki typ weryfikacji jest wymagany. Zapoznaj się też z zasadami dotyczącymi danych użytkownika w usługach interfejsu API Google.