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 w artykule 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 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 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 na kontach 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ć proszenia o zakresy, których aplikacja nie potrzebuje. Użytkownicy chętniej przyznają dostęp do ograniczonych, jasno opisanych zakresów.
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 Twojego abonamentu, nie musisz dodawać zakresów, aby korzystać z interfejsu Google Workspace Events API. Jeśli dodasz zakresy, wybierz najmniej newralgiczny zakres, który nadal umożliwia działanie aplikacji. Szczegółowe informacje o kategoriach zakresów znajdziesz w sekcji 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 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 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.app.memberships |
Wyświetlanie, dodawanie, aktualizowanie i usuwanie uczestników rozmów i pokoi w Chat jako aplikacji Chat. Wymaga zatwierdzenia przez administratora. Ten zakres obsługuje tylko uwierzytelnianie aplikacji za pomocą kont usługi. W tym zakresie nie możesz uwierzytelniać się za pomocą danych logowania użytkownika ani przekazywania dostępu w całej domenie. |
Poufne |
||
https://www.googleapis.com/auth/chat.app.memberships.readonly |
Wyświetlanie uczestników rozmów i pokoi w Google Chat jako aplikacja Google Chat. Wymaga zatwierdzenia przez administratora. Ten zakres obsługuje tylko uwierzytelnianie aplikacji za pomocą kont usługi. W tym zakresie nie możesz uwierzytelniać się za pomocą danych logowania użytkownika ani przekazywania dostępu w całej domenie. |
Poufne |
||
https://www.googleapis.com/auth/chat.spaces |
Tworzenie rozmów i pokoi oraz wyświetlanie i aktualizowanie metadanych (w tym ustawień historii) w 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.app.spaces |
Tworzenie rozmów i pokoi oraz wyświetlanie i aktualizowanie metadanych (w tym ustawień historii) w Chat jako aplikacja Chat. Wymaga zatwierdzenia przez administratora. Ten zakres obsługuje tylko uwierzytelnianie aplikacji za pomocą kont usługi. W tym zakresie nie możesz uwierzytelniać się za pomocą danych logowania użytkownika ani przekazywania dostępu w całej domenie. |
Poufne |
||
https://www.googleapis.com/auth/chat.app.spaces.readonly |
Wyświetlanie metadanych (w tym ustawień historii) w Google Chat jako aplikacja Google Chat. Wymaga zatwierdzenia przez administratora. Ten zakres obsługuje tylko uwierzytelnianie aplikacji za pomocą kont usługi. W tym zakresie nie możesz uwierzytelniać się za pomocą danych logowania użytkownika ani przekazywania dostępu w całej domenie. |
Poufne |
||
https://www.googleapis.com/auth/chat.messages.reactions |
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 ograniczonym dostępem | ||
https://www.googleapis.com/auth/chat.messages.readonly |
wyświetlać wiadomości i reakcje w Chat; | Ograniczone |
||
https://www.googleapis.com/auth/chat.app.messages.readonly |
Wyświetlanie wiadomości i reakcji w Google Chat jako aplikacji Chat. Wymaga zatwierdzenia przez administratora. Ten zakres obsługuje tylko uwierzytelnianie aplikacji za pomocą kont usługi. W tym zakresie nie możesz uwierzytelniać się za pomocą danych logowania użytkownika ani przekazywania dostępu w całej domenie. |
Ograniczone |
||
https://www.googleapis.com/auth/chat.users.readstate |
Wyświetlanie i aktualizowanie stanu przeczytania wiadomości przez użytkownika w Google Chat. ( wersja przedpremierowa dla programistów) | Poufne |
||
https://www.googleapis.com/auth/chat.users.readstate.readonly |
Wyświetlanie stanu odczytu użytkownika w Google Chat. ( wersja przedpremierowa dla programistów) | Poufne |
||
| 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 okna wyboru plików aplikacji. | Niepoufne | ||
https://www.googleapis.com/auth/drive |
wyświetlać wszystkie pliki na Dysku i zarządzać nimi; | Z ograniczonym dostępem | ||
https://www.googleapis.com/auth/drive.readonly |
wyświetlać i pobierać wszystkie pliki 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świetlaj metadane 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 pokoi 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 poufności każdego zakresu:
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 sekcji 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 sekcji Wymagania dotyczące zakresów o charakterze kontrowersyjnym i z ograniczonym dostępem.
Z ograniczeniami: te zakresy zapewniają szeroki dostęp do danych użytkowników 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 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 typu weryfikacja jest wymagana. Zapoznaj się też z Warunkami korzystania z usługi Dysk.
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 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 Uwierzytelnianie i autoryzowanie aplikacji do obsługi czatu oraz żądań do interfejsu Chat API.
W tabeli poniżej znajdziesz informacje o zakresach i typach uwierzytelniania, które 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 do obsługi czatu) | Obsługiwane zakresy autoryzacji | |
|---|---|---|---|---|
| Tworzenie subskrypcji | – |
W przypadku uwierzytelniania użytkownika wymaga obsługiwanego zakresu dla każdego typu zdarzenia:
Wersja przedpremierowa dla programistów: w przypadku uwierzytelniania aplikacji i zatwierdzania przez administratora (tylko aplikacje Google Chat) 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 do obsługi czatu):
|
|||
| 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 do obsługi czatu):
|
|||
| Aktualizowanie subskrypcji | – |
W przypadku uwierzytelniania użytkownika wymaga obsługiwanego zakresu dla każdego typu zdarzenia:
Wersja przedpremierowa dla programistów: w przypadku uwierzytelniania aplikacji i zatwierdzania przez administratora (tylko aplikacje Google Chat) wymaga obsługiwanego zakresu dla każdego typu zdarzenia:
|
||
| Ponowne aktywowanie subskrypcji | – |
W przypadku uwierzytelniania użytkownika wymaga obsługiwanego zakresu 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żytkowników ta metoda wymaga zakresu, który obsługuje co najmniej 1 typ zdarzenia w przypadku subskrypcji.
W przypadku uwierzytelniania aplikacji (tylko aplikacje do obsługi czatu):
|
|||
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 informacje o zakresach autoryzacji obsługiwanych w przypadku poszczególnych typów zdarzeń:
| Zdarzenia | Typy zdarzeń | Obsługiwane zakresy autoryzacji | ||||||
|---|---|---|---|---|---|---|---|---|
| Czat | ||||||||
| Wiadomość jest publikowana lub aktualizowana. |
|
W przypadku uwierzytelniania użytkownika:
|
||||||
| Dodano lub usunięto reakcję albo zmieniono kilka reakcji. |
|
|
||||||
| Subskrypcja zostaje utworzona, zaktualizowana lub usunięta albo zmienionych zostaje kilka subskrypcji. |
|
W przypadku uwierzytelniania użytkownika:
|
||||||
| Pokój został zaktualizowany lub usunięty. |
|
W przypadku uwierzytelniania użytkownika:
|
||||||
| Zaktualizowany zostaje stan przeczytania przestrzeni lub stan przeczytania wątku użytkownika. ( wersja przedpremierowa dla programistów) |
|
W przypadku uwierzytelniania użytkownika:
|
||||||
| Dysk | ||||||||
| Plik został utworzony, zmieniony, przeniesiony, usunięty, zmieniono jego nazwę, został przeniesiony do kosza lub usunięty z kosza. |
|
|
||||||
| W przypadku pliku zostanie utworzona lub rozwiązana prośba o dostęp. |
|
|
||||||
| Zatwierdzenie zostało anulowane, zakończone, utworzone, zresetowane, zmieniono recenzentów lub recenzenci odpowiedzieli na plik. |
|
|
||||||
| Komentarz został utworzony, usunięty, zmodyfikowany, ponownie otwarty lub zamknięty w pliku. |
|
|
||||||
| Odpowiedź została utworzona, usunięta lub zmodyfikowana w pliku. |
|
|
||||||
| Uprawnienie zostało utworzone, usunięte lub zmodyfikowane w pliku. |
|
|
||||||
| Meet | ||||||||
| Konferencja się rozpoczyna lub kończy. |
|
|
||||||
| Uczestnik dołącza do konferencji lub ją opuszcza. |
|
|
||||||
| Wygenerowano nagranie. |
|
|
||||||
| Wygenerowano transkrypcję. |
|
|
||||||