Ten dokument zawiera informacje o autoryzacji dla interfejsu Gmail API oraz dane uwierzytelniające. Przed przeczytaniem tego dokumentu koniecznie zapoznaj się z Ogólne informacje dotyczące uwierzytelniania i autoryzacji Google Workspace dostępne na stronie Więcej informacji o uwierzytelnianiu i autoryzowaniu
Konfigurowanie autoryzacji OAuth 2.0
Skonfiguruj ekran zgody OAuth i wybierz zakresy aby określić, jakie informacje mają być wyświetlane użytkownikom i weryfikatorom aplikacji, aby opublikować ją później.
Zakresy interfejsu Gmail API
Aby określić poziom dostępu przyznanego aplikacji, musisz określić zadeklarować zakresy autoryzacji. Zakres autoryzacji jest ciągiem znaków URI OAuth 2.0 zawierające nazwę aplikacji Google Workspace oraz rodzaj danych, do których uzyskuje dostęp; poziom dostępu. Zakresy to żądania aplikacji dotyczące pracy z danymi Google Workspace, w tym użytkowników dane na koncie Google.
Gdy Twoja aplikacja zostanie zainstalowana, użytkownik zostanie poproszony o sprawdzenie używanych zakresów przez aplikację. Ogólnie zalecamy wybranie najwęższego zakresu, i unikaj próśb o zakresy, których aplikacja nie wymaga. Więcej użytkowników umożliwiać łatwe przyznawanie 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 podczas pracy z Google Analytics. | Nie o charakterze kontrowersyjnym |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
Wyświetlanie e-maili podczas interakcji z Google Analytics. | Nie o charakterze kontrowersyjnym |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
Wyświetlanie metadanych e-maili, gdy dodatek jest używany jest uruchomiony. | Poufne |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
Wyświetlanie e-maili, gdy dodatek jest w domu. | Poufne |
https://www.googleapis.com/auth/gmail.labels |
Tylko tworzenie, odczytywanie, aktualizowanie i usuwanie etykiet. | Nie o charakterze kontrowersyjnym |
https://www.googleapis.com/auth/gmail.send |
Wysyłaj tylko wiadomości. Brak uprawnień do odczytu lub modyfikacji w skrzynce pocztowej. | Poufne |
https://www.googleapis.com/auth/gmail.readonly |
Odczyt wszystkich zasobów i ich metadanych – brak 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 |
Tylko wstawianie i importowanie wiadomości. | Z ograniczeniem |
https://www.googleapis.com/auth/gmail.modify |
Wszystkie operacje odczytu/zapisu oprócz natychmiastowego, trwałego usunięcia wątków i wiadomości, pomijając Kosz. | Z ograniczeniem |
https://www.googleapis.com/auth/gmail.metadata |
Odczytywanie metadanych zasobów, w tym etykiet, rekordów historii i e-maili ale nie treś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 ustawieniami poufnych poczty, w tym regułami przekierowania i aliasami.
Uwaga: operacje strzeżone tego zakresu są ograniczone do wyłącznie do użytku administracyjnego. Są dostępne tylko dla klientów Google Workspace. za pomocą konta usługi z przekazywaniem dostępu w całej domenie. |
Z ograniczeniem |
https://mail.google.com/ |
Pełny dostęp do skrzynek pocztowych na koncie, w tym trwałe usunięcie Wątki i wiadomości. Ten zakres należy żądać tylko wtedy, gdy Twoja aplikacja musi natychmiast i trwale usunąć wątki i wiadomości, omijając Kosz; wszystkie inne działania można wykonywać przy mniej rygorystycznych zakresach. | Z ograniczeniem |
Kolumna Użycie w tabeli powyżej wskazuje czułość każdego zakresu, zgodnie z tymi definicjami:
Niewrażliwe – te zakresy zapewniają najmniejszą sferę dostępu do autoryzacji i wymagają jedynie podstawowej weryfikacji aplikacji. Informacje na temat o tym wymaganiu, zobacz Etapy przygotowania do weryfikacji.
Poufne – te zakresy umożliwiają dostęp do danych użytkowników Google i wymagają weryfikacji zakresu wrażliwego. Informacje o tym wymaganiu znajdziesz tutaj: Usługi interfejsów API Google: zasady dotyczące danych użytkownika. Te zakresy nie wymagają oceny zabezpieczeń.
Z ograniczonym dostępem – te zakresy zapewniają szeroki dostęp do danych użytkowników Google oraz mogą wymagać przejścia procesu weryfikacji z ograniczonym zakresem. Dla: informacji na temat tego wymogu można znaleźć w Usługi interfejsów API Google: zasady dotyczące danych użytkownika oraz Dodatkowe wymagania dotyczące określonych zakresów interfejsu API Jeśli na serwerach przechowujesz (lub przesyłasz dane o zakresie z ograniczeniami), musisz wykonać te czynności: przeprowadzić ocenę zabezpieczeń.
Dodatkowe informacje regulujące korzystanie z interfejsów API Gmaila i dostęp do nich prośby o dostęp do danych użytkownika znajdziesz w Dane użytkownika i zasady dla deweloperów w usługach Gmail API
Jeśli aplikacja wymaga dostępu do innych interfejsów API Google, możesz dodać dla tych zakresów. Więcej informacji o zakresach interfejsów API Google zobacz Korzystanie z protokołu OAuth 2.0 na potrzeby dostępu do interfejsów API Google
Weryfikacja OAuth
Korzystanie z niektórych poufnych zakresów protokołu OAuth może wymagać przejścia aplikacji przez aplikację Proces weryfikacji Google OAuth. Przeczytaj Najczęstsze pytania na temat weryfikacji OAuth. aby ustalić, kiedy aplikacja powinna przejść weryfikację i jaki typ weryfikacja jest wymagana. Zobacz też Usługi interfejsów API Google: zasady dotyczące danych użytkownika.