Ten dokument zawiera informacje dotyczące autoryzacji i uwierzytelniania dotyczące interfejsu Google Workspace Event API. Zanim przeczytasz ten dokument, zapoznaj się z ogólnymi informacjami na temat uwierzytelniania i autoryzacji w Google Workspace dostępnymi 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 interfejsu Google Workspace Event API
Aby określić poziom dostępu przyznany aplikacji, musisz określić i zadeklarować zakresy autoryzacji. Zakres autoryzacji to ciąg identyfikatora URI OAuth 2.0, który zawiera nazwę aplikacji Google Workspace, rodzaj danych, do których uzyskuje ona 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ę. Najlepiej jest wybrać najwęższy możliwy zakres i nie żądać zakresów, których aplikacja nie wymaga. Użytkownicy mogą łatwiej przyznawać dostęp do ograniczonych, jasno opisanych zakresów.
W miarę możliwości zalecamy używanie zakresów niewrażliwych, ponieważ przydzielają one zakres dostępu do poszczególnych plików i zawężają dostęp do określonych funkcji, których potrzebuje aplikacja.
Interfejs Google Workspace Event API korzysta z zakresów aplikacji Google Workspace, które obsługują subskrypcje. Jeśli Twoja aplikacja korzysta już z zakresów wymaganych w przypadku Twojej subskrypcji, nie musisz dodawać dodatkowych zakresów, aby korzystać z interfejsu Google Workspace Event API.
W tabeli poniżej znajdziesz zakresy obsługiwane przez interfejs Google Workspace Event API:
| Kod zakresu | Opis | Wykorzystanie | ||
|---|---|---|---|---|
| Google Chat, | ||||
https://www.googleapis.com/auth/chat.bot |
Pozwala aplikacjom Google Chat wyświetlać czaty i wysyłać wiadomości. Daje dostęp do wszystkich funkcji dostępnych dla aplikacji do obsługi czatu. | Niewrażliwe | ||
https://www.googleapis.com/auth/chat.memberships |
Wyświetlanie, dodawanie i usuwanie uczestników rozmów w Google Chat. | Drażliwe |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
Wyświetlanie uczestników rozmów w Google Chat. | Drażliwe |
||
https://www.googleapis.com/auth/chat.spaces |
Tworzenie rozmów i pokoi oraz wyświetlanie i aktualizowanie metadanych (w tym ustawień historii) w Google Chat. | Poufne | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
Wyświetlanie czatu i pokoi w Google Chat. | Drażliwe |
||
https://www.googleapis.com/auth/chat.messages |
Wyświetlanie, tworzenie, wysyłanie, aktualizowanie i usuwanie wiadomości oraz dodawanie, wyświetlanie i usuwanie reakcji na wiadomości. | Z ograniczeniem | ||
https://www.googleapis.com/auth/chat.messages.readonly |
Wyświetlanie wiadomości i reakcji w Google Chat. | Ograniczone |
||
https://www.googleapis.com/auth/chat.messages.reaction s |
Wyświetlanie, dodawanie i usuwanie reakcji na wiadomości w Google Chat. | Ograniczone |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
Wyświetlanie reakcji na wiadomość w Google Chat. | Ograniczone |
||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
Zezwalaj aplikacjom na tworzenie, modyfikowanie i odczytywanie metadanych sal konferencyjnych utworzonych przez Twoją aplikację. | Drażliwe |
||
https://www.googleapis.com/auth/meetings.space.readonly |
Zezwalaj aplikacjom na odczytywanie metadanych dotyczących wszystkich miejsc spotkań, do których użytkownik ma dostęp. | Drażliwe |
||
Kolumna „Użycie” w poprzedniej tabeli podaje poufność każdego zakresu zgodnie z tymi definicjami:
Niewrażliwe – te zakresy zapewniają najmniejszy zakres uprawnień do autoryzacji i wymagają tylko podstawowej weryfikacji aplikacji. Informacje na ten temat znajdziesz w artykule Czynności, które musisz wykonać, aby przygotować się do weryfikacji.
Poufne – te zakresy zapewniają dostęp do określonych danych użytkownika Google autoryzowanych przez użytkownika na potrzeby Twojej aplikacji. Wymagają dodatkowej weryfikacji aplikacji. Informacje na ten temat znajdziesz w sekcji Czynności, które należy wykonać w przypadku aplikacji żądających dostępu do poufnych danych.
Z ograniczonym dostępem – te zakresy zapewniają szeroki dostęp do danych użytkownika Google i wymagają przejścia procesu weryfikacji zakresu z ograniczeniami. Informacje na temat tego wymogu znajdziesz w artykułach Usługi interfejsu API Google: zasady dotyczące danych użytkownika i Dodatkowe wymagania dotyczące określonych zakresów interfejsu API. Jeśli przechowujesz dane z zakresu ograniczonego dostępu na serwerach (lub je przesyłasz), musisz przejść ocenę bezpieczeństwa.
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 o korzystaniu z protokołu OAuth 2.0 do uzyskiwania dostępu do interfejsów API Google.
Więcej informacji o konkretnych zakresach protokołu OAuth 2.0 znajdziesz w artykule Zakresy OAuth 2.0 dla interfejsów API Google.
Weryfikacja OAuth
Korzystanie z niektórych zakresów OAuth może wymagać przejścia aplikacji przez proces weryfikacji OAuth Google. Przeczytaj Najczęstsze pytania na temat weryfikacji interfejsu OAuth API, aby określić, kiedy aplikacja powinna przejść weryfikację i jaki typ weryfikacji jest wymagany. Zapoznaj się też z Dodatkowymi warunkami korzystania z Dysku Google.
Rodzaje wymaganego uwierzytelniania
W tej sekcji wyjaśniamy, które typy uwierzytelniania są wymagane lub obsługiwane, a także przedstawiamy obsługiwane zakresy poszczególnych metod interfejsu Google Workspace Event API.
W przypadku subskrypcji zdarzeń w Google Chat interfejs Google Workspace Event API obsługuje uwierzytelnianie użytkowników i aplikacji w celu wywoływania niektórych metod. Jeśli metoda interfejsu API obsługuje oba dane logowania, to typ danych logowania użytych w wywołaniu wpływa na zwracany wynik. Jeśli na przykład wywołujesz metodę subscriptions.list() z uwierzytelnianiem użytkownika, interfejs API zwróci listę subskrypcji, do których ma dostęp uwierzytelniony użytkownik. Jeśli użyjesz uwierzytelniania aplikacji, interfejs API zwróci listę subskrypcji, do których aplikacja ma dostęp. Więcej informacji o typach uwierzytelniania w Google Chat znajdziesz w artykule Uwierzytelnianie i autoryzowanie aplikacji Google Chat oraz żądań do interfejsu Google Chat API.
W tabeli poniżej znajdziesz zakresy i typy uwierzytelniania wymagane lub obsługiwane w przypadku poszczególnych metod interfejsu Google Workspace Event API:
| Metoda | Wymagane lub obsługiwane uwierzytelnianie użytkownika | Uwierzytelnianie aplikacji (tylko aplikacje Google Chat) | Obsługiwane zakresy autoryzacji | |
|---|---|---|---|---|
| Tworzenie subskrypcji | — |
Wymaga obsługiwanego zakresu w przypadku każdego typu zdarzenia:
|
||
| Kupowanie subskrypcji |
W przypadku uwierzytelniania użytkownika ta metoda wymaga zakresu, który obsługuje co najmniej 1 typ zdarzenia w ramach subskrypcji.
Z uwierzytelnianiem aplikacji (tylko w przypadku aplikacji Google Chat):
|
|||
| Wyświetlanie listy subskrypcji |
W przypadku uwierzytelniania użytkownika ta metoda wymaga zakresu, który obsługuje co najmniej 1 typ zdarzenia w ramach subskrypcji.
Z uwierzytelnianiem aplikacji (tylko w przypadku aplikacji Google Chat):
|
|||
| Aktualizowanie subskrypcji | — |
Wymaga obsługiwanego zakresu w przypadku każdego typu zdarzenia:
|
||
| Ponowne aktywowanie subskrypcji | — |
Wymaga obsługiwanego zakresu w przypadku każdego typu zdarzenia:
|
||
| Usuwanie subskrypcji |
W przypadku uwierzytelniania użytkownika ta metoda wymaga zakresu, który obsługuje co najmniej 1 typ zdarzenia w ramach subskrypcji.
Z uwierzytelnianiem aplikacji (tylko w przypadku aplikacji Google Chat):
|
|||
Zakresy według typu zdarzenia
Gdy wywołujesz interfejs Google Workspace Event API za pomocą uwierzytelniania użytkownika, musisz określić co najmniej 1 zakres odpowiadający typom zdarzeń subskrypcji.
W tabeli poniżej znajdziesz zakresy autoryzacji obsługiwane w przypadku poszczególnych typów zdarzeń:
| Zdarzenia | Typy zdarzeń | Obsługiwane zakresy autoryzacji | ||||||
|---|---|---|---|---|---|---|---|---|
| Google Chat, | ||||||||
| Wiadomość została opublikowana lub zaktualizowana. |
|
|
||||||
| Dodano lub usunięto reakcję, a także zmieniono wiele reakcji. |
|
|
||||||
| Subskrypcja zostanie utworzona, zaktualizowana lub usunięta, a także zmieni się wiele subskrypcji. |
|
|
||||||
| Pokój zostanie zaktualizowany lub usunięty. |
|
|
||||||
| Google Meet | ||||||||
| Początek lub koniec konferencji. |
|
|
||||||
| uczestnik dołącza do rozmowy lub ją opuszcza; |
|
|
||||||
| Wygenerowano nagranie. |
|
|
||||||
| Wygenerowano transkrypcję. |
|
|
||||||