Ten dokument zawiera informacje o autoryzacji i uwierzytelnianiu 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 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 sprawdzają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ć proszenia o zakresy, których aplikacja nie potrzebuje. Użytkownicy chętniej przyznają dostęp do ograniczonych, jasno opisanych zakresów.
W miarę możliwości używaj zakresów, które nie są wrażliwe, aby ograniczyć dostęp tylko do określonych funkcji potrzebnych aplikacji.
Zakresy niewrażliwe
W większości przypadków zalecamy te zakresy interfejsu Gmail API:
| Kod zakresu | Opis |
|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose |
Zarządzanie wersjami roboczymi i wysyłanie e-maili w trakcie korzystania z dodatku. |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
Wyświetlanie e-maili w trakcie korzystania z dodatku. |
https://www.googleapis.com/auth/gmail.labels |
Wyświetlaj i edytuj etykiety e-maili. |
Zakresy wrażliwe
| Kod zakresu | Opis |
|---|---|
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
Wyświetlanie metadanych wiadomości e-mail, gdy dodatek jest uruchomiony. |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
Wyświetlanie e-maili, gdy dodatek jest uruchomiony. |
https://www.googleapis.com/auth/gmail.send |
wysyłać e-maile w Twoim imieniu, |
Zakresy z ograniczeniami
| Kod zakresu | Opis |
|---|---|
https://mail.google.com/ |
Odczytywanie, tworzenie, wysyłanie i trwałe usuwanie wszystkich e-maili z Gmaila.
Uwaga: poproś o ten zakres tylko wtedy, gdy Twoja aplikacja musi natychmiast i na stałe usuwać wątki i wiadomości, pomijając kosz. Wszystkie inne działania możesz wykonywać w zakresach o mniejszych uprawnieniach. |
https://www.googleapis.com/auth/gmail.readonly |
wyświetlać e-maile i ustawienia; |
https://www.googleapis.com/auth/gmail.compose |
zarządzanie kopiami roboczymi i wysyłanie e-maili, |
https://www.googleapis.com/auth/gmail.insert |
Dodawanie e-maili do skrzynki pocztowej w Gmailu. |
https://www.googleapis.com/auth/gmail.modify |
czytać, tworzyć i wysyłać e-maile z konta Gmail; Ten zakres nie umożliwia natychmiastowego, trwałego usuwania wątków i wiadomości z pominięciem kosza. |
https://www.googleapis.com/auth/gmail.metadata |
Wyświetlanie metadanych wiadomości e-mail, takich jak etykiety i nagłówki, ale nie treści e-maila. |
https://www.googleapis.com/auth/gmail.settings.basic |
Wyświetlanie, edytowanie, tworzenie lub modyfikowanie ustawień i filtrów poczty e-mail w Gmailu. |
https://www.googleapis.com/auth/gmail.settings.sharing |
Zarządzanie poufnymi ustawieniami poczty, w tym pozwoleniami na dostęp do konta.
Uwaga: operacje chronione przez ten zakres są ograniczone do użytku administracyjnego. Są one dostępne tylko dla klientów Google Workspace, którzy korzystają z konta usługi z przekazywaniem dostępu w całej domenie. |
Zakresy w tabelach powyżej wskazują ich wrażliwość zgodnie z tymi definicjami:
Niewrażliwe: te zakresy zapewniają najmniejszy zakres autoryzacji i wymagają tylko podstawowej weryfikacji aplikacji OAuth. Więcej informacji znajdziesz w sekcji Wymagania dotyczące weryfikacji.
Wrażliwe: te zakresy zapewniają dostęp do określonych danych użytkownika Google, które użytkownicy autoryzują dla Twojej aplikacji. Wymagają dodatkowej weryfikacji aplikacji OAuth. Więcej informacji znajdziesz w artykule Wymagania dotyczące zakresu wrażliwego i objętego ograniczeniami.
Z ograniczeniami: te zakresy zapewniają szeroki dostęp do danych użytkowników Google i wymagają weryfikacji aplikacji OAuth w zakresie z ograniczeniami. Więcej informacji znajdziesz w zasadach dotyczących danych użytkownika w usługach interfejsów API Google i dodatkowych wymaganiach dotyczących zakresów interfejsu API.
Jeśli przechowujesz dane z zakresów z ograniczeniami na serwerach (lub je przesyłasz), musisz przejść ocenę zabezpieczeń.
Dodatkowe informacje dotyczące korzystania z interfejsów API Gmaila i uzyskiwania do nich dostępu, gdy prosisz o dostęp do danych użytkownika, znajdziesz w zasadach Google Workspace API dotyczących danych użytkownika i 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.
Więcej informacji o poszczególnych zakresach OAuth 2.0 znajdziesz w artykule Zakresy OAuth 2.0 dla interfejsów API Google.
Weryfikacja OAuth
Korzystanie z niektórych wrażliwych zakresów protokołu OAuth może wymagać przejścia przez aplikację procesu weryfikacji OAuth w Google. Często zadawane pytania dotyczące weryfikacji aplikacji OAuth pomogą Ci ustalić, czy jest to konieczne i jakiego rodzaju weryfikacja jest wymagana.