Ten dokument zawiera informacje na temat autoryzacji i uwierzytelniania w interfejsie Google Workspace Events API. Zanim zaczniesz czytać ten dokument, zapoznaj się z ogólnymi informacjami o uwierzytelnianiu i autoryzacji w Google Workspace, które znajdziesz w artykule Więcej informacji o uwierzytelnianiu i autoryzacji.
Konfigurowanie OAuth 2.0 na potrzeby autoryzacji
Konfigurowanie ekranu zgody OAuth i wybieranie zakresów, aby określić, jakie informacje są wyświetlane użytkownikom i sprawdzającym aplikację, oraz zarejestrować aplikację, aby można ją było opublikować.
Zakresy Google Workspace Events API
Aby określić poziom dostępu przyznanego aplikacji, musisz zidentyfikować i zadeklarować zakresy autoryzacji. Zakres autoryzacji to ciąg znaków URI OAuth 2, który zawiera nazwę aplikacji Google Workspace, rodzaj danych, do których ma dostęp, oraz poziom dostępu. Zakresy to żądania aplikacji dotyczące danych Google Workspace, w tym danych z konta Google użytkowników.
Po zainstalowaniu aplikacji użytkownik musi zatwierdzić zakresy używane przez aplikację. Zazwyczaj należy wybrać jak najbardziej ograniczony zakres i unikać żądania zakresów, których aplikacja nie wymaga. Użytkownicy chętniej udzielają dostępu do ograniczonych, jasno opisanych zakresów.
Zalecamy, aby w miarę możliwości używać zakresów dostępu bez danych wrażliwych, ponieważ przyznają one dostęp na poziomie pliku i ograniczają dostęp do określonych funkcji potrzebnych aplikacji.
Interfejs Events API w Google Workspace używa zakresów aplikacji Google Workspace, które obsługują subskrypcje. Jeśli Twoja aplikacja korzysta już z zakresów wymaganych w Twoim abonamencie, nie musisz dodawać dodatkowych zakresów, aby korzystać z interfejsu Events API Google Workspace.
Tabela poniżej zawiera obsługiwane zakresy interfejsu Events API w Google Workspace:
| Kod zakresu | Opis | Wykorzystanie | ||
|---|---|---|---|---|
| Google Chat | ||||
https://www.googleapis.com/auth/chat.bot |
Umożliwia aplikacjom Google Chat wyświetlanie czatów i wysyłanie wiadomości. Daje dostęp do wszystkich funkcji dostępnych w aplikacjach Google Chat. | Niepoufne | ||
https://www.googleapis.com/auth/chat.memberships |
Wyświetlanie, dodawanie i usuwanie uczestników rozmów w Google Chat. | Wrażliwe |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
Wyświetlanie uczestników rozmów w Google Chat. | Wraż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 czatów i pokoju w Google Chat. | Wrażliwe |
||
https://www.googleapis.com/auth/chat.messages.reaction s |
Wyświetlanie, dodawanie i usuwanie reakcji na wiadomości w Google Chat. | Wrażliwe |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
Wyświetlanie reakcji na wiadomość w Google Chat. | Wraż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. | Z ograniczonym dostępem |
||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
Zezwalanie aplikacjom na tworzenie, modyfikowanie i odczytywanie metadanych dotyczących sal spotkań utworzonych przez aplikację. | Wrażliwe |
||
https://www.googleapis.com/auth/meetings.space.readonly |
Zezwalanie aplikacjom na odczyt metadanych dotyczących dowolnego pokoju na spotkanie, do którego użytkownik ma dostęp. | Wrażliwe |
||
Kolumna „Użycie” w poprzedniej tabeli wskazuje czułość każdego zakresu według tych definicji:
Niewrażliwe – te zakresy zapewniają najmniejszy zakres dostępu autoryzowanego i wymagają tylko podstawowej weryfikacji aplikacji. Więcej informacji o tym wymaganiu znajdziesz w artykule Przygotowanie do weryfikacji.
Wrażliwe – te zakresy zapewniają dostęp do określonych danych użytkownika Google, które zostały autoryzowane przez użytkownika w Twojej aplikacji. Wymaga to dodatkowej weryfikacji aplikacji. Informacje o tym wymaganiu znajdziesz w artykule Kroki dla aplikacji wymagających dostępu do zakresów wrażliwych.
Z ograniczeniami – te zakresy zapewniają szeroki dostęp do danych użytkownika Google i wymagają przejścia procesu weryfikacji zakresu 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 konkretnych zakresów interfejsu API. Jeśli przechowujesz dane z ograniczonym zakresem 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 Używanie protokołu OAuth 2.0 na potrzeby dostępu do interfejsów API Google.
Więcej informacji o określonych zakresach OAuth 2.0 znajdziesz w artykule Zakresy OAuth 2.0 dla interfejsów API Google.
Weryfikacja OAuth
Korzystanie z określonych zakresów OAuth może wymagać przejścia przez proces weryfikacji OAuth w Google. Przeczytaj najczęstsze pytania dotyczące weryfikacji OAuth API, aby dowiedzieć się, kiedy aplikacja powinna przejść weryfikację i jakiego typu weryfikacja jest wymagana. Zobacz też Dodatkowe warunki korzystania z Dysku Google.
Typy wymaganego uwierzytelniania
W tej sekcji wyjaśniono, które typy uwierzytelniania są wymagane lub obsługiwane, oraz podano obsługiwane zakresy dla każdej metody interfejsu Events API Google Workspace.
W przypadku subskrypcji zdarzeń Google Chat interfejs Events API w Google Workspace obsługuje uwierzytelnianie zarówno użytkownika, jak i aplikacji, aby wywołać niektóre z jego metod. Jeśli metoda interfejsu API obsługuje obie metody uwierzytelniania, typ metody uwierzytelniania użytej w wywołaniu wpływa na zwracany wynik. Jeśli na przykład wywołasz metodę subscriptions.list() z uwierzytelnieniem użytkownika, interfejs API zwraca listę subskrypcji, do których ma dostęp uwierzytelniony użytkownik. Jeśli używasz uwierzytelniania aplikacji, interfejs API zwraca listę subskrypcji, do których ma dostęp aplikacja. 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 informacje o tym, które zakresy i typy uwierzytelniania są wymagane lub obsługiwane w przypadku poszczególnych metod interfejsu Events API Google Workspace:
| Metoda | Wymagana lub obsługiwana weryfikacja tożsamości użytkownika | Uwierzytelnianie aplikacji (tylko aplikacje Google Chat) | Obsługiwane zakresy autoryzacji | |
|---|---|---|---|---|
| Tworzenie subskrypcji | – |
Wymaga obsługiwanego zakresu dla każdego typu zdarzenia:
|
||
| Kup subskrypcję |
W przypadku uwierzytelniania użytkownika ta metoda wymaga zakresu, który obsługuje co najmniej 1 typ zdarzenia dla subskrypcji.
Za pomocą uwierzytelniania aplikacji (dotyczy tylko 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 dla subskrypcji.
Za pomocą uwierzytelniania aplikacji (dotyczy tylko aplikacji Google Chat):
|
|||
| Aktualizowanie subskrypcji | – |
Wymaga obsługiwanego zakresu dla każdego typu zdarzenia:
|
||
| Wznawianie subskrypcji | – |
Wymaga obsługiwanego zakresu dla każdego typu zdarzenia:
|
||
| Usuwanie subskrypcji |
W przypadku uwierzytelniania użytkownika ta metoda wymaga zakresu, który obsługuje co najmniej 1 typ zdarzenia dla subskrypcji.
Za pomocą uwierzytelniania aplikacji (dotyczy tylko aplikacji Google Chat):
|
|||
Zakresy według typu zdarzenia
Gdy wywołujesz interfejs Events API w Google Workspace za pomocą uwierzytelniania użytkownika, musisz określić co najmniej 1 zakres, który odpowiada typom zdarzeń subskrypcji.
W tabeli poniżej znajdziesz informacje o tym, które zakresy autoryzacji są obsługiwane w przypadku poszczególnych typów zdarzeń:
| Zdarzenia | Typy zdarzeń | Obsługiwane zakresy autoryzacji | ||||||
|---|---|---|---|---|---|---|---|---|
| Google Chat | ||||||||
| opublikowano lub zaktualizowano wiadomość. |
|
|
||||||
| dodano lub usunięto reakcję albo zmieniono kilka reakcji; |
|
|
||||||
| Subskrypcja została utworzona, zaktualizowana lub usunięta albo zmieniono kilka subskrypcji. |
|
|
||||||
| Pokój został zaktualizowany lub usunięty. |
|
|
||||||
| Google Meet | ||||||||
| Konferencja się rozpoczyna lub kończy. |
|
|
||||||
| Uczestnik dołącza do konferencji lub ją opuszcza. |
|
|
||||||
| Wygenerowano nagranie. |
|
|
||||||
| Wygenerowano transkrypcję. |
|
|
||||||