Method: spaces.spaceEvents.list

Wyświetla listę zdarzeń z pokoju Google Chat. W przypadku każdego zdarzenia payload zawiera najnowszą wersję zasobu Google Chat. Jeśli na przykład wyświetlisz listę zdarzeń dotyczących nowych członków pokoju, serwer zwróci zasoby Membership, które zawierają najnowsze informacje o członkostwie. Jeśli w wybranym okresie zostali usunięci nowi użytkownicy, ładunek zdarzenia będzie zawierał pusty zasób Membership.

Wymaga uwierzytelniania użytkownika. Aby wyświetlić listę zdarzeń, uwierzytelniony użytkownik musi być członkiem pokoju.

Przykładowe informacje znajdziesz w artykule Wyświetlanie listy zdarzeń z pokoju Google Chat.

Żądanie HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/spaceEvents

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

To pole jest wymagane. Nazwa zasobu pokoju Google Chat, w którym wystąpiły zdarzenia.

Format: spaces/{space}.

Parametry zapytania

Parametry
pageSize

integer

Opcjonalnie. Maksymalna liczba zwróconych zdarzeń dotyczących pokoju. Usługa może zwrócić mniejszą wartość od tej wartości.

Wartości ujemne zwracają błąd INVALID_ARGUMENT.
pageToken

string

Token strony odebrany z poprzedniego wywołania zdarzeń związanych z listą. Podaj je, aby pobrać kolejną stronę.

W przypadku podziału na strony wszystkie pozostałe parametry dostarczone do wyświetlenia listy zdarzeń pokoju muszą odpowiadać wywołaniu, które podało token strony. Przekazywanie różnych wartości do pozostałych parametrów może prowadzić do nieoczekiwanych wyników.
filter

string

To pole jest wymagane. Filtr zapytania.

Musisz określić co najmniej 1 typ zdarzenia (eventType) przy użyciu operatora zawiera :. Aby filtrować według wielu typów zdarzeń, użyj operatora OR. Pomiń w filtrze typy zdarzeń zbiorczych. Żądanie automatycznie zwraca wszystkie powiązane zdarzenia zbiorcze. Jeśli na przykład przefiltrujesz dane według nowych reakcji (google.workspace.chat.reaction.v1.created), serwer zwróci też zbiorczo nowe zdarzenia reakcji (google.workspace.chat.reaction.v1.batchCreated). Listę obsługiwanych typów zdarzeń znajdziesz w dokumentacji referencyjnej dotyczącej SpaceEvents.

Opcjonalnie możesz też filtrować dane według godziny rozpoczęcia (startTime) i godziny zakończenia (endTime):

  • startTime: unikalna sygnatura czasowa, od której należy rozpocząć wyświetlanie zdarzeń pokoju. Możesz wyświetlić listę zdarzeń, które miały miejsce maksymalnie 28 dni temu. Jeśli nie określono inaczej, wyświetlane są zdarzenia dla pokoju z ostatnich 28 dni.
  • endTime: sygnatura czasowa uwzględniająca do chwili wyświetlenia zdarzenia dla pokoju. Jeśli nie określono inaczej, wyświetla listę zdarzeń do czasu żądania.

Aby podać godzinę rozpoczęcia lub zakończenia, użyj operatora równości = i formatu w RFC-3339. Aby filtrować według zarówno startTime, jak i endTime, użyj operatora AND.

Prawidłowe są np. te zapytania:

startTime="2023-08-23T19:20:33+00:00" AND
endTime="2023-08-23T19:21:54+00:00"

startTime="2023-08-23T19:20:33+00:00" AND
(eventTypes:"google.workspace.chat.space.v1.updated" OR
eventTypes:"google.workspace.chat.message.v1.created")

Te zapytania są nieprawidłowe:

startTime="2023-08-23T19:20:33+00:00" OR
endTime="2023-08-23T19:21:54+00:00"

eventTypes:"google.workspace.chat.space.v1.updated" AND
eventTypes:"google.workspace.chat.message.v1.created"

Nieprawidłowe zapytania zostały odrzucone przez serwer z błędem INVALID_ARGUMENT.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Wiadomość z odpowiedzią dotyczącą wyświetlania listy wydarzeń w pokoju.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "spaceEvents": [
    {
      object (SpaceEvent)
    }
  ],
  "nextPageToken": string
}
Pola
spaceEvents[]

object (SpaceEvent)

Wyniki są zwracane w porządku chronologicznym (najpierw najstarsze zdarzenia).
nextPageToken

string

Token kontynuacji używany do pobierania kolejnych zdarzeń. Jeśli pominiesz to pole, nie będzie kolejnych stron.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Więcej informacji znajdziesz w przewodniku po autoryzacji.