Wybierz zakresy interfejsu Google Workspace Events API

Ten dokument zawiera informacje o autoryzacji dla interfejsu Google Workspace Events API oraz dane uwierzytelniające. Przed przeczytaniem tego dokumentu koniecznie zapoznaj się z Ogólne informacje dotyczące uwierzytelniania i autoryzacji Google Workspace dostępne na stronie Więcej informacji o uwierzytelnianiu i autoryzowaniu

Konfigurowanie autoryzacji OAuth 2.0

Skonfiguruj ekran zgody OAuth i wybierz zakresy aby określić, jakie informacje mają być wyświetlane użytkownikom i weryfikatorom aplikacji, aby opublikować ją później.

Zakresy interfejsu Google Workspace Events API

Aby określić poziom dostępu przyznanego aplikacji, musisz określić zadeklarować zakresy autoryzacji. Zakres autoryzacji jest ciągiem znaków URI OAuth 2.0 zawierające nazwę aplikacji Google Workspace oraz rodzaj danych, do których uzyskuje dostęp; poziom dostępu. Zakresy to żądania aplikacji dotyczące pracy z danymi Google Workspace, w tym użytkowników dane na koncie Google.

Gdy Twoja aplikacja zostanie zainstalowana, użytkownik zostanie poproszony o sprawdzenie używanych zakresów przez aplikację. Ogólnie zalecamy wybranie najwęższego zakresu, i unikaj próśb o zakresy, których aplikacja nie wymaga. Więcej użytkowników umożliwiać łatwe przyznawanie dostępu do ograniczonych, jasno opisanych zakresów.

Jeśli to możliwe, zalecamy korzystanie z zakresów niewrażliwych, ponieważ przydzielają one poszczególnym plikom dostępu do określonych funkcji wymaganych przez aplikację.

Interfejs Google Workspace Events API używa zakresów z Google Workspace w aplikacjach obsługujących subskrypcje. Jeśli Twoja aplikacja używa już zakresów które są wymagane w przypadku subskrypcji, nie musisz dodawać do korzystania z interfejsu Google Workspace Events API.

W tabeli poniżej znajdziesz obsługiwane zakresy dla Interfejs Google Workspace Events API:

Kod zakresu Opis Wykorzystanie
Google Chat,  
https://www.googleapis.com/auth/chat.bot Pozwala aplikacjom Google Chat na wyświetlanie czatów i wysyłanie wiadomości. Daje dostęp do wszystkich funkcji aplikacji Google Chat. Nie o charakterze kontrowersyjnym
https://www.googleapis.com/auth/chat.memberships Wyświetlanie, dodawanie i usuwanie uczestników rozmów w Google Chat.
Czuła
https://www.googleapis.com/auth/chat.memberships.readonly Wyświetlanie uczestników rozmów w Google Chat.
Czuła
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.
Czuła
https://www.googleapis.com/auth/chat.messages.reaction s Wyświetlanie, dodawanie i usuwanie reakcji na wiadomości w Google Chat.
Czuła
https://www.googleapis.com/auth/chat.messages.reactions.readonly Wyświetlanie reakcji na wiadomość w Google Chat.
Czuła
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 Zezwalaj aplikacjom na tworzenie, modyfikowanie i odczytywanie metadanych sal konferencyjnych utworzone przez Twoją aplikację.
Czuła
https://www.googleapis.com/auth/meetings.space.readonly Zezwalaj aplikacjom na odczytywanie metadanych o dowolnym miejscu spotkań, do którego ma dostęp użytkownik.
Czuła

Kolumna Użycie w poprzedniej tabeli wskazuje czułość każdego zakresu, zgodnie z tymi definicjami:

Jeśli aplikacja wymaga dostępu do innych interfejsów API Google, możesz dodać te zakresy . Więcej informacji o zakresach interfejsów API Google znajdziesz w artykule Używanie protokołu OAuth 2.0 do Dostęp 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

Korzystanie z niektórych zakresów protokołu OAuth może wymagać, aby aplikacja przeszła Weryfikacja OAuth . Przeczytaj artykuł Weryfikacja interfejsu OAuth API Najczęstsze pytania aby ustalić, kiedy aplikacja powinna przejść weryfikację i jaki typ weryfikacja jest wymagana. Zobacz też Dodatkowe warunki korzystania z Dysku Google Usługa.

Rodzaje wymaganego uwierzytelniania

W tej sekcji dowiesz się, które typy uwierzytelniania są wymagane lub obsługiwane i wskazuje obsługiwane zakresy dla każdej metody metody Interfejs Google Workspace Events API.

W przypadku subskrypcji zdarzeń w Google Chat interfejs Google Workspace Events API obsługuje uwierzytelnianie użytkowników i aplikacji, aby móc wywoływać niektóre metody. Jeśli interfejs API obsługuje oba typy danych logowania, czyli typ danych logowania używany w wywołaniu wpływa na zwracany wynik. Na przykład jeśli wywołasz funkcję subscriptions.list() z uwierzytelnianiem użytkownika, interfejs API zwraca listę subskrypcji, które do którego ma dostęp uwierzytelniony użytkownik. Jeśli korzystasz z uwierzytelniania aplikacji, interfejs API zwraca listę subskrypcji, do których aplikacja ma dostęp. Aby dowiedzieć się więcej o: wybierz typy uwierzytelniania w Google Chat: Uwierzytelnianie i autoryzacja Aplikacje do obsługi czatu i interfejs Google Chat API .

W tabeli poniżej znajdziesz zakresy i typy uwierzytelnianie jest wymagane lub obsługiwane w przypadku każdego interfejsu Google Workspace Events API :

Metoda Wymagane lub obsługiwane uwierzytelnianie użytkownika Obsługa uwierzytelniania aplikacji (tylko aplikacje Google Chat) Obsługiwane zakresy autoryzacji
Tworzenie subskrypcji

Wymaga obsługiwanego zakresu w przypadku każdego typu zdarzenia:

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • meetings.space.created
  • meetings.space.readonly
Kupowanie subskrypcji W przypadku uwierzytelniania użytkownika ta metoda wymaga zakresu, który obsługuje co najmniej 1 typ zdarzenia w przypadku subskrypcji.

Po włączeniu uwierzytelniania aplikacji (tylko w przypadku aplikacji Google Chat):

  • chat.bot
Lista subskrypcji W przypadku uwierzytelniania użytkownika ta metoda wymaga zakresu, który obsługuje co najmniej 1 typ zdarzenia w przypadku subskrypcji.

Po włączeniu uwierzytelniania aplikacji (tylko w przypadku aplikacji Google Chat):

  • chat.bot
Aktualizowanie subskrypcji

Wymaga obsługiwanego zakresu w przypadku każdego typu zdarzenia:

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • meetings.space.created
  • meetings.space.readonly
Ponowne aktywowanie subskrypcji

Wymaga obsługiwanego zakresu w przypadku każdego typu zdarzenia:

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • meetings.space.created
  • meetings.space.readonly
Usuwanie subskrypcji W przypadku uwierzytelniania użytkownika ta metoda wymaga zakresu, który obsługuje co najmniej 1 typ zdarzenia w przypadku subskrypcji.

Po włączeniu uwierzytelniania aplikacji (tylko w przypadku aplikacji Google Chat):

  • chat.bot

Zakresy według typu zdarzenia

Gdy wywołujesz interfejs Google Workspace Events API za pomocą uwierzytelniania użytkownika, musi określać co najmniej jeden zakres odpowiadający typom zdarzeń funkcji subskrypcji.

W tabeli poniżej znajdziesz zakresy autoryzacji obsługiwane w przypadku poszczególnych zakresów typ zdarzenia:

Zdarzenia Typy zdarzeń Obsługiwane zakresy autoryzacji
Google Chat,  
Wiadomość została opublikowana lub zaktualizowana.
  • google.workspace.chat.message.v1.created
  • google.workspace.chat.message.v1.updated
  • chat.messages
  • chat.messages.readonly
Reakcja zostanie dodana lub usunięta albo zmieniono wiele reakcji.
  • google.workspace.chat.reaction.v1.created
  • google.workspace.chat.reaction.v1.deleted
  • google.workspace.chat.reaction.v1.batchChanged
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.messages
  • chat.messages.readonly
Subskrypcja została utworzona, zaktualizowana lub usunięta, albo wiele członków są zmieniane.
  • google.workspace.chat.membership.v1.created
  • google.workspace.chat.membership.v1.updated
  • google.workspace.chat.membership.v1.deleted
  • google.workspace.chat.membership.v1.batchChanged
  • chat.memberships
  • chat.memberships.readonly
Pokój został zaktualizowany lub usunięty.
  • google.workspace.chat.space.v1.updated
  • google.workspace.chat.space.v1.deleted
  • chat.spaces
  • chat.spaces.readonly
Google Meet  
Rozmowa wideo rozpoczyna się lub kończy.
  • google.workspace.meet.conference.v2.started
  • google.workspace.meet.conference.v2.ended
  • meetings.space.created
  • meetings.space.readonly
uczestnik dołącza do konferencji lub ją opuszcza.
  • google.workspace.meet.participant.v2.joined
  • google.workspace.meet.participant.v2.left
  • meetings.space.created
  • meetings.space.readonly
Wygenerowano nagranie.
  • google.workspace.meet.recording.v2.fileGenerated
  • meetings.space.created
  • meetings.space.readonly
Wygenerowano transkrypcję.
  • google.workspace.meet.transcript.v2.fileGenerated
  • meetings.space.created
  • meetings.space.readonly