Ten dokument zawiera informacje o autoryzacji i uwierzytelnianiu w interfejsie Gmail API. Zanim przeczytasz ten dokument, zapoznaj się z ogólnymi informacjami o uwierzytelnianiu i autoryzacji w Google Workspace, które znajdziesz w artykule Uwierzytelnianie i autoryzacja.
Konfigurowanie OAuth 2.0 na potrzeby autoryzacji
Skonfiguruj ekran zgody OAuth i wybierz zakresy, aby określić, jakie informacje będą wyświetlane użytkownikom i osobom weryfikującym aplikację, oraz zarejestrować aplikację, aby móc ją później opublikować.
Zakresy interfejsu Gmail API
Aby określić poziom dostępu przyznany aplikacji, musisz zidentyfikować i zadeklarować zakresy autoryzacji. Zakres autoryzacji to ciąg znaków URI OAuth 2.0, który zawiera nazwę aplikacji Google Workspace, rodzaj danych, do których ma ona dostęp, oraz poziom dostępu. Zakresy to żądania aplikacji dotyczące pracy z danymi Google Workspace, w tym z danymi kont Google użytkowników.
Gdy aplikacja zostanie zainstalowana, użytkownik jest proszony o potwierdzenie zakresów używanych przez aplikację. Zazwyczaj należy wybrać jak najwęższy zakres i unikać żądania zakresów, których aplikacja nie potrzebuje. Użytkownicy chętniej 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ą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 |
Tworzenie, odczytywanie, aktualizowanie i usuwanie tylko etykiet. | Niepoufne |
https://www.googleapis.com/auth/gmail.send |
Tylko wysyłanie wiadomości. Brak uprawnień do odczytu i modyfikowania skrzynki pocztowej. | Poufne |
https://www.googleapis.com/auth/gmail.readonly |
Odczytywanie wszystkich zasobów i ich metadanych – bez operacji zapisu. | Z ograniczeniem |
https://www.googleapis.com/auth/gmail.compose |
Tworzenie, odczytywanie, aktualizowanie i usuwanie wersji roboczych. wysyłanie wiadomości i wersji roboczych; | 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 i zapisu z wyjątkiem natychmiastowego, trwałego usuwania wątków i wiadomości z pominięciem Kosza. | Z ograniczeniem |
https://www.googleapis.com/auth/gmail.metadata |
Odczytywanie metadanych zasobów, w tym etykiet, historii i nagłówków wiadomości e-mail, ale nie treści wiadomości ani załączników. | Z ograniczeniem |
https://www.googleapis.com/auth/gmail.settings.basic |
Zarządzanie podstawowymi ustawieniami poczty. | Z ograniczeniem |
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 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 ograniczeniem |
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 stosować tylko wtedy, gdy aplikacja musi natychmiast i trwale usuwać wątki i wiadomości, pomijając Kosz. Wszystkie inne działania można wykonywać przy użyciu zakresów o mniejszych uprawnieniach. | Z ograniczeniem |
Kolumna Użycie w tabeli powyżej wskazuje poziom wrażliwości każdego zakresu zgodnie z tymi definicjami:
Niewrażliwe – te zakresy zapewniają najmniejszy zakres dostępu autoryzacji i wymagają tylko podstawowej weryfikacji aplikacji. Więcej informacji o tym wymaganiu znajdziesz w artykule o przygotowaniu do weryfikacji.
Wrażliwe – te zakresy umożliwiają dostęp do danych użytkowników Google i wymagają przejścia 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.
Z ograniczeniami – te zakresy zapewniają szeroki dostęp do danych użytkowników Google i wymagają przejścia procesu weryfikacji zakresów 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 zakresów interfejsu API. Jeśli przechowujesz dane z zakresu z ograniczeniami na serwerach (lub je przesyłasz), musisz przejść ocenę zabezpieczeń.
Dodatkowe informacje dotyczące 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 usług interfejsów API Gmaila i zasadach dla deweloperów.
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 niektórych wrażliwych zakresów OAuth może wymagać przejścia przez proces weryfikacji OAuth w Google. Przeczytaj najczęstsze pytania dotyczące weryfikacji OAuth, aby dowiedzieć się, kiedy Twoja aplikacja powinna przejść weryfikację i jakiego rodzaju weryfikacja jest wymagana. Zobacz też zasady dotyczące danych użytkownika w usługach interfejsów API Google.