Ten dokument zawiera informacje o autoryzacji i uwierzytelnianiu w interfejsie Google Workspace Events API. Zanim przeczytasz ten dokument, zapoznaj się z ogólnymi informacjami o uwierzytelnianiu i autoryzacji w Google Workspace, które znajdziesz na stronie 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 Google Workspace Events 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.
W miarę możliwości zalecamy używanie zakresów nieobejmujących informacji poufnych, ponieważ przyznają one zakres dostępu do poszczególnych plików i ograniczają dostęp do konkretnych funkcji potrzebnych aplikacji.
Interfejs Google Workspace Events API korzysta z zakresów aplikacji Google Workspace, które obsługują subskrypcje. Jeśli Twoja aplikacja używa już zakresów wymaganych w przypadku subskrypcji, nie musisz dodawać dodatkowych zakresów, aby korzystać z interfejsu Google Workspace Events API.
W tabeli poniżej znajdziesz obsługiwane zakresy interfejsu Google Workspace Events API:
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. Przyznaje dostęp do wszystkich funkcji dostępnych dla aplikacji do obsługi czatu. | Niepoufne | ||
https://www.googleapis.com/auth/chat.memberships |
Wyświetlanie, dodawanie i usuwanie uczestników rozmów w Google Chat. | Poufne |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
Wyświetlanie uczestników rozmów w Google Chat. | Poufne |
||
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. | Poufne |
||
https://www.googleapis.com/auth/chat.messages.reaction s |
Wyświetlanie, dodawanie i usuwanie reakcji na wiadomości w Chat. | Poufne |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
Wyświetlanie reakcji na wiadomość w Chat. | Poufne |
||
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 ograniczeniami |
||
Dysk Google | ||||
https://www.googleapis.com/auth/drive.file |
tworzyć nowe pliki na Dysku lub modyfikować istniejące pliki otwierane w aplikacji lub udostępniane jej przez użytkownika podczas korzystania z interfejsu Google Picker API lub selektora plików aplikacji; | Niepoufne | ||
https://www.googleapis.com/auth/drive |
Wyświetlaj wszystkie pliki na Dysku i zarządzaj nimi. | Z ograniczeniem | ||
https://www.googleapis.com/auth/drive.readonly |
wyświetlać i pobierać wszystkie pliki na Dysku; | Z ograniczeniem | ||
https://www.googleapis.com/auth/drive.metadata |
Wyświetlanie metadanych plików na Dysku i zarządzanie nimi. | Z ograniczeniem | ||
https://www.googleapis.com/auth/drive.metadata.readonly |
Wyświetlaj metadane plików na Dysku. | Z ograniczeniem | ||
Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
Zezwalanie aplikacjom na tworzenie, modyfikowanie i odczytywanie metadanych dotyczących miejsc spotkań utworzonych przez Twoją aplikację. | Poufne |
||
https://www.googleapis.com/auth/meetings.space.readonly |
Zezwalaj aplikacjom na odczytywanie metadanych dowolnej przestrzeni spotkań, do której użytkownik ma dostęp. | Poufne |
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 do autoryzacji i wymagają tylko podstawowej weryfikacji aplikacji. Więcej informacji o tym wymaganiu znajdziesz w artykule Wymagania dotyczące weryfikacji.
Wrażliwe: te zakresy zapewniają dostęp do określonych danych użytkownika Google, które zostały autoryzowane przez użytkownika na potrzeby Twojej aplikacji. Wymagają one dodatkowej weryfikacji aplikacji. Więcej informacji o tym wymaganiu znajdziesz w artykule Wymagania dotyczące zakresu wrażliwych i objętych ograniczeniami danych.
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 zakresów z ograniczeniami na serwerach (lub je przesyłasz), musisz przejść ocenę zabezpieczeń.
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 zakresów OAuth może wymagać przejścia przez Centrum pomocy dotyczące weryfikacji aplikacji OAuth. Przeczytaj najczęstsze pytania dotyczące aplikacji OAuth, aby dowiedzieć się, kiedy aplikacja powinna przejść weryfikację i jakiego rodzaju weryfikacja jest wymagana. Zobacz też Warunki korzystania z usługi Dysk Google.
Rodzaje wymaganego uwierzytelniania
W tej sekcji znajdziesz informacje o typach uwierzytelniania, które są wymagane lub obsługiwane, oraz o zakresach obsługiwanych w przypadku każdej metody interfejsu Google Workspace Events API.
W przypadku subskrypcji zdarzeń w Google Chat interfejs Google Workspace Events API obsługuje uwierzytelnianie użytkownika i aplikacji, aby wywoływać niektóre z jego metod. Jeśli metoda interfejsu API obsługuje oba rodzaje danych logowania, typ danych logowania użytych w wywołaniu wpływa na zwracany wynik. Jeśli na przykład wywołasz 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żywasz uwierzytelniania aplikacji, interfejs API zwraca 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 informacje o tym, jakie zakresy i typy uwierzytelniania są wymagane lub obsługiwane w przypadku poszczególnych metod interfejsu Google Workspace Events API:
Metoda | Uwierzytelnianie użytkownika jest wymagane lub obsługiwane | Obsługiwane 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żytkowników ta metoda wymaga zakresu, który obsługuje co najmniej 1 typ zdarzenia w przypadku subskrypcji.
W przypadku uwierzytelniania aplikacji (tylko aplikacje Google Chat):
|
|||
Wyświetlanie listy subskrypcji |
W przypadku uwierzytelniania użytkowników ta metoda wymaga zakresu, który obsługuje co najmniej 1 typ zdarzenia w przypadku subskrypcji.
W przypadku uwierzytelniania aplikacji (tylko aplikacje Google Chat):
|
|||
Aktualizowanie subskrypcji | – |
Wymaga obsługiwanego zakresu dla każdego typu zdarzenia:
|
||
Ponowne aktywowanie subskrypcji | – |
Wymaga obsługiwanego zakresu dla każdego typu zdarzenia:
|
||
Usuwanie subskrypcji |
W przypadku uwierzytelniania użytkowników ta metoda wymaga zakresu, który obsługuje co najmniej 1 typ zdarzenia w przypadku subskrypcji.
W przypadku uwierzytelniania aplikacji (tylko aplikacje Google Chat):
|
Zakresy według typu zdarzenia
Gdy wywołujesz interfejs Google Workspace Events 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ść zostanie opublikowana lub zaktualizowana. |
|
|
||||||
dodanie lub usunięcie reakcji albo zmiana kilku reakcji; |
|
|
||||||
Subskrypcja została utworzona, zaktualizowana lub usunięta albo zmieniono wiele subskrypcji. |
|
|
||||||
Pokój został zaktualizowany lub usunięty. |
|
|
||||||
Dysk Google | ||||||||
Plik zostanie utworzony, zmieniony, przeniesiony, usunięty, przeniesiony do kosza lub usunięty z kosza. |
|
|
||||||
W przypadku pliku utworzono lub rozwiązano propozycję dostępu. |
|
|
||||||
Google Meet | ||||||||
Konferencja się rozpoczyna lub kończy. |
|
|
||||||
Uczestnik dołącza do konferencji lub ją opuszcza. |
|
|
||||||
Wygenerowano nagranie. |
|
|
||||||
Wygenerowano transkrypcję. |
|
|