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 w artykule Informacje 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 mają być wyświetlane użytkownikom i recenzentom aplikacji, oraz zarejestruj 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 identyfikatora URI OAuth 2.0, 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 pracy z danymi Google Workspace, w tym danymi na koncie Google użytkowników.
Po zainstalowaniu aplikacji użytkownik jest proszony o zweryfikowanie zakresów, których ona używa. Ogólnie należy wybrać jak najwęższy zakres i unikać żądania zakresów, których aplikacja nie wymaga. Użytkownicy chętniej przyznają dostęp do ograniczonych, jasno opisanych zakresów.
Interfejs Google Workspace Events API używa zakresów z aplikacji Google Workspace, które obsługują subskrypcje. Jeśli Twoja aplikacja korzysta już z zakresów wymaganych przez subskrypcję, nie musisz dodawać zakresów, aby korzystać z interfejsu Google Workspace Events API. Jeśli dodasz zakresy, wybierz najmniej wrażliwy zakres, który nadal umożliwia działanie aplikacji. Szczegółowe informacje o kategoriach zakresów znajdziesz w artykule Kategorie zakresów.
W tabeli poniżej znajdziesz listę obsługiwanych zakresów interfejsu Google Workspace Events API:
| Kod zakresu | Opis | Wykorzystanie | ||
|---|---|---|---|---|
| Google Chat | ||||
https://www.googleapis.com/auth/chat.bot |
Umożliwia aplikacjom do Google Chat wyświetlanie czatów i wysyłanie wiadomości. Zapewnia 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. | 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.app.memberships |
Wyświetlanie, dodawanie, aktualizowanie i usuwanie uczestników rozmów i pokoi w Google Chat jako aplikacja do Google Chat. Wymaga zatwierdzenia przez administratora. Ten zakres obsługuje tylko uwierzytelnianie aplikacji za pomocą kont usługi. Nie możesz uwierzytelniać się za pomocą danych logowania użytkownika ani przekazywania dostępu w całej domenie przy użyciu tego zakresu. |
Wrażliwe |
||
https://www.googleapis.com/auth/chat.app.memberships.readonly |
Wyświetlanie uczestników rozmów i pokoi w Google Chat jako aplikacja do Google Chat. Wymaga zatwierdzenia przez administratora. Ten zakres obsługuje tylko uwierzytelnianie aplikacji za pomocą kont usługi. Nie możesz uwierzytelniać się za pomocą danych logowania użytkownika ani przekazywania dostępu w całej domenie przy użyciu tego zakresu. |
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 czatu i pokoi w Google Chat. | Wrażliwe |
||
https://www.googleapis.com/auth/chat.app.spaces |
Tworzenie rozmów i pokoi oraz wyświetlanie i aktualizowanie metadanych (w tym ustawień historii) w Google Chat jako aplikacja do Google Chat. Wymaga zatwierdzenia przez administratora. Ten zakres obsługuje tylko uwierzytelnianie aplikacji za pomocą kont usługi. Nie możesz uwierzytelniać się za pomocą danych logowania użytkownika ani przekazywania dostępu w całej domenie przy użyciu tego zakresu. |
Wrażliwe |
||
https://www.googleapis.com/auth/chat.app.spaces.readonly |
Wyświetlanie metadanych (w tym ustawień historii) w Google Chat jako aplikacja do Google Chat. Wymaga zatwierdzenia przez administratora. Ten zakres obsługuje tylko uwierzytelnianie aplikacji za pomocą kont usługi. Nie możesz uwierzytelniać się za pomocą danych logowania użytkownika ani przekazywania dostępu w całej domenie przy użyciu tego zakresu. |
Wrażliwe |
||
https://www.googleapis.com/auth/chat.messages.reactions |
Wyświetlanie, dodawanie i usuwanie reakcji na wiadomości w Google Chat. | Wrażliwe |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
wyświetlać reakcje 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 ograniczonym dostępem | ||
https://www.googleapis.com/auth/chat.messages.readonly |
Wyświetlanie wiadomości i reakcji w Google Chat. | Z ograniczonym dostępem |
||
https://www.googleapis.com/auth/chat.app.messages.readonly |
Wyświetlanie wiadomości i reakcji w Google Chat jako aplikacja do Google Chat. Wymaga zatwierdzenia przez administratora. Ten zakres obsługuje tylko uwierzytelnianie aplikacji za pomocą kont usługi. Nie możesz uwierzytelniać się za pomocą danych logowania użytkownika ani przekazywania dostępu w całej domenie przy użyciu tego zakresu. |
Z ograniczonym dostępem |
||
https://www.googleapis.com/auth/chat.users.readstate |
Wyświetlanie i aktualizowanie stanu odczytu użytkownika w Google Chat. | Wrażliwe |
||
https://www.googleapis.com/auth/chat.users.readstate.readonly |
Wyświetlanie stanu odczytania wiadomości przez użytkownika w Google Chat. | Wrażliwe |
||
https://www.googleapis.com/auth/chat.users.availability |
Wyświetlanie i zmienianie stanu dostępności w Google Chat. | Wrażliwe |
||
https://www.googleapis.com/auth/chat.users.availability.readonly |
wyświetlanie stanu dostępności w Google Chat; | Wrażliwe |
||
https://www.googleapis.com/auth/chat.app.all.spaces.readonly |
Wyświetlanie metadanych wszystkich pokoi i rozmów w Google Chat w całej organizacji Google Workspace, nawet jeśli aplikacja Google Chat nie jest użytkownikiem. Ten zakres jest obsługiwany tylko w przypadku subskrypcji klientów. Wymaga zatwierdzenia przez administratora. Ten zakres obsługuje tylko uwierzytelnianie aplikacji za pomocą kont usługi. Nie możesz uwierzytelniać się za pomocą danych logowania użytkownika ani przekazywania dostępu w całej domenie przy użyciu tego zakresu. |
Z ograniczonym dostępem | ||
https://www.googleapis.com/auth/chat.app.all.memberships.readonly |
wyświetlanie wszystkich członków w pokojach i rozmowach w Google Chat w całej organizacji Google Workspace, nawet jeśli aplikacja Google Chat nie jest członkiem; Ten zakres jest obsługiwany tylko w przypadku subskrypcji klientów. Wymaga zatwierdzenia przez administratora. Ten zakres obsługuje tylko uwierzytelnianie aplikacji za pomocą kont usługi. Nie możesz uwierzytelniać się za pomocą danych logowania użytkownika ani przekazywania dostępu w całej domenie przy użyciu tego zakresu. |
Z ograniczonym dostępem | ||
https://www.googleapis.com/auth/chat.app.all.messages.readonly |
wyświetlanie wszystkich wiadomości i reakcji w całej organizacji Google Workspace, nawet jeśli aplikacja do Google Chat nie jest użytkownikiem pokoju ani uczestnikiem rozmowy; Ten zakres jest obsługiwany tylko w przypadku subskrypcji klientów. Wymaga zatwierdzenia przez administratora. Ten zakres obsługuje tylko uwierzytelnianie aplikacji za pomocą kont usługi. Nie możesz uwierzytelniać się za pomocą danych logowania użytkownika ani przekazywania dostępu w całej domenie przy użyciu tego zakresu. |
Z ograniczonym dostępem | ||
https://www.googleapis.com/auth/chat.app.all.users.readstate.readonly |
Wyświetlanie czasu ostatniego odczytu wszystkich użytkowników we wszystkich pokojach i rozmowach w całej organizacji Google Workspace, nawet jeśli aplikacja do Google Chat nie jest użytkownikiem. Ten zakres jest obsługiwany tylko w przypadku subskrypcji klientów. Wymaga zatwierdzenia przez administratora. Ten zakres obsługuje tylko uwierzytelnianie aplikacji za pomocą kont usługi. Nie możesz uwierzytelniać się za pomocą danych logowania użytkownika ani przekazywania dostępu w całej domenie przy użyciu tego zakresu. |
Z ograniczonym dostępem | ||
| Dysk Google | ||||
https://www.googleapis.com/auth/drive.file |
Tworzenie nowych plików na Dysku lub modyfikowanie istniejących plików, które otwierasz w aplikacji lub które użytkownik udostępnia aplikacji podczas korzystania z interfejsu Google Picker API lub okna wyboru plików w aplikacji. | Niepoufne | ||
https://www.googleapis.com/auth/drive |
Wyświetlanie wszystkich plików na Dysku i zarządzanie nimi. | Z ograniczonym dostępem | ||
https://www.googleapis.com/auth/drive.readonly |
Wyświetlanie i pobieranie wszystkich plików na Dysku. | Z ograniczonym dostępem | ||
https://www.googleapis.com/auth/drive.metadata |
Wyświetlanie metadanych plików na Dysku i zarządzanie nimi. | Z ograniczonym dostępem | ||
https://www.googleapis.com/auth/drive.metadata.readonly |
Wyświetlanie metadanych plików na Dysku. | Z ograniczonym dostępem | ||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
Zezwalaj aplikacjom na tworzenie, modyfikowanie i odczytywanie metadanych dotyczących pokoi utworzonych przez Twoją aplikację. | Wrażliwe |
||
https://www.googleapis.com/auth/meetings.space.readonly |
Zezwalaj aplikacjom na odczytywanie metadanych dotyczących dowolnego pokoju spotkań, do którego użytkownik ma dostęp. | Wrażliwe |
||
Kolumna „Użycie” w powyższej tabeli wskazuje poziom poufności każdego zakresu:
Niewrażliwe: te zakresy zapewniają najmniejszy zakres dostępu autoryzacyjnego i wymagają tylko podstawowej weryfikacji aplikacji. Informacje o tym wymaganiu znajdziesz w artykule Wymagania dotyczące weryfikacji.
Poufne: te zakresy zapewniają dostęp do określonych danych użytkownika Google, które zostały autoryzowane przez użytkownika dla Twojej aplikacji. Wymaga to dodatkowej weryfikacji aplikacji. Informacje o tym wymaganiu znajdziesz w artykule Wymagania dotyczące zakresów poufnych i ograniczonych.
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 artykułach Zasady dotyczące danych użytkownika w usługach interfejsu API Google i Dodatkowe wymagania dotyczące określonych zakresów interfejsu API. Jeśli przechowujesz dane z zakresu z ograniczeniami 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 dodać również 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 konkretnych zakresach protokołu OAuth 2.0 znajdziesz w artykule Zakresy protokołu OAuth 2.0 dla interfejsów API Google.
Weryfikacja OAuth
Używanie niektórych zakresów protokołu OAuth może wymagać przejścia przez Centrum pomocy weryfikacji aplikacji OAuth. Przeczytaj najczęstsze pytania dotyczące aplikacji OAuth, aby dowiedzieć się, kiedy aplikacja powinna przejść weryfikację i jakiego typu weryfikacja jest wymagana. Zobacz też Warunki korzystania z Dysku.
Typy wymaganych metod uwierzytelniania
W tej sekcji wyjaśniamy, jakie typy uwierzytelniania są wymagane lub obsługiwane, oraz podajemy obsługiwane zakresy dla każdej metody interfejsu Google Workspace Events API.
W przypadku subskrypcji zdarzeń w Google Chat interfejs Google Workspace Events API obsługuje zarówno uwierzytelnianie użytkowników, jak i aplikacji, aby wywoływać niektóre metody. Jeśli metoda interfejsu API obsługuje oba rodzaje danych uwierzytelniających, rodzaj danych uwierzytelniających 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 uwierzytelniony użytkownik ma dostęp. 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 na temat uwierzytelniania i autoryzowania aplikacji Google Chat oraz żądań do interfejsu Chat API.
W tabeli poniżej znajdziesz zakresy i typy uwierzytelniania, które są wymagane lub obsługiwane w przypadku poszczególnych metod interfejsu Google Workspace Events API:
| Metoda | Uwierzytelnianie użytkowników jest wymagane lub obsługiwane | Obsługiwane uwierzytelnianie aplikacji (tylko aplikacje do Google Chat) | Obsługiwane zakresy autoryzacji | |
|---|---|---|---|---|
| Tworzenie subskrypcji | – |
W przypadku uwierzytelniania użytkownika wymagany jest obsługiwany zakres dla każdego typu zdarzenia:
W przypadku uwierzytelniania aplikacji i zatwierdzania przez administratora (tylko aplikacje Google Chat) wymagany jest obsługiwany zakres dla każdego typu zdarzenia:
|
||
| Kupowanie subskrypcji |
W przypadku uwierzytelniania użytkownika ta metoda wymaga zakresu, który obsługuje co najmniej 1 typ zdarzenia dla subskrypcji.
Uwierzytelnianie aplikacji (tylko aplikacje do obsługi czatu):
|
|||
| Wyświetlanie listy subskrypcji |
W przypadku uwierzytelniania użytkownika ta metoda wymaga zakresu, który obsługuje co najmniej 1 typ zdarzenia dla subskrypcji.
Uwierzytelnianie aplikacji (tylko aplikacje do obsługi czatu):
|
|||
| Aktualizowanie subskrypcji | – |
W przypadku uwierzytelniania użytkownika wymagany jest obsługiwany zakres dla każdego typu zdarzenia:
W przypadku uwierzytelniania aplikacji i zatwierdzania przez administratora (tylko aplikacje Google Chat) wymagany jest obsługiwany zakres dla każdego typu zdarzenia:
|
||
| Ponowne aktywowanie subskrypcji | – |
W przypadku uwierzytelniania użytkownika wymagany jest obsługiwany zakres dla każdego typu zdarzenia:
W przypadku uwierzytelniania aplikacji i zatwierdzania przez administratora (tylko aplikacje do obsługi czatu) wymagany jest obsługiwany zakres 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.
Uwierzytelnianie aplikacji (tylko aplikacje do obsługi czatu):
|
|||
Zakresy według typu zdarzenia
Gdy wywołujesz interfejs Google Workspace Events API przy użyciu uwierzytelniania użytkownika, musisz określić co najmniej 1 zakres, który odpowiada 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 | ||||||
|---|---|---|---|---|---|---|---|---|
| Czat | ||||||||
| Wiadomość została opublikowana lub zaktualizowana. |
|
W przypadku uwierzytelniania użytkownika:
|
||||||
| dodano lub usunięto reakcję albo zmieniono kilka reakcji; |
|
W przypadku uwierzytelniania użytkownika:
|
||||||
| Subskrypcja została utworzona, zaktualizowana lub usunięta albo zmieniono kilka subskrypcji. |
|
W przypadku uwierzytelniania użytkownika:
|
||||||
| Pokój został zaktualizowany lub usunięty. |
|
W przypadku uwierzytelniania użytkownika:
|
||||||
| Stan odczytu pokoju lub stan odczytu wątku użytkownika został zaktualizowany. |
|
W przypadku uwierzytelniania użytkownika:
|
||||||
| Zaktualizowano dostępność. |
|
W przypadku uwierzytelniania użytkownika:
|
||||||
| Dysk | ||||||||
| Plik został utworzony, zmieniony, przeniesiony, usunięty, przeniesiony do kosza, usunięty z kosza lub zmieniono jego nazwę. |
|
|
||||||
| Zostanie utworzona lub rozpatrzona prośba o dostęp do pliku. |
|
|
||||||
| Zatwierdzenie zostało anulowane, ukończone, utworzone lub zresetowane albo zmieniono osoby zatwierdzające lub osoby zatwierdzające odpowiedziały na prośbę o zatwierdzenie pliku. |
|
|
||||||
| Komentarz został utworzony, usunięty, zmodyfikowany, ponownie otwarty lub rozwiązany w pliku. |
|
|
||||||
| Odpowiedź została utworzona, usunięta lub zmodyfikowana w pliku. |
|
|
||||||
| Uprawnienie do pliku zostało utworzone, usunięte lub zmodyfikowane. |
|
|
||||||
| Meet | ||||||||
| Rozpoczyna się lub kończy rozmowa. |
|
|
||||||
| Uczestnik dołącza do konferencji lub ją opuszcza. |
|
|
||||||
| Wygenerowano nagranie. |
|
|
||||||
| Wygenerowano transkrypcję. |
|
|
||||||