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 osób w pokoju, serwer zwróci zasoby Membership, które zawierają najnowsze szczegóły członkostwa. Jeśli w wybranym okresie nowi użytkownicy zostali usunięci, ł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ład 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

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ń dla pokoju. Usługa może zwrócić mniej niż ta wartość.

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

string

Token strony otrzymany z poprzedniego wywołania zdarzeń w pokoju listy. Podaj go, aby pobrać kolejną stronę.

Podczas dzielenia na strony wszystkie pozostałe parametry służące do wyświetlania listy zdarzeń pokoju muszą być zgodne z wywołaniem, które dostarczyło token strony. Przekazywanie innych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników.
filter

string

Wymagane. Filtr zapytania.

Musisz określić co najmniej 1 typ zdarzenia (eventType) za pomocą 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 filtrujesz według nowych reakcji (google.workspace.chat.reaction.v1.created), serwer zwraca też zdarzenia zbiorczo nowe reakcje (google.workspace.chat.reaction.v1.batchCreated). Listę obsługiwanych typów zdarzeń znajdziesz w dokumentacji SpaceEvents.

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

  • startTime: unikalna sygnatura czasowa, od której rozpoczyna się wyświetlanie listy zdarzeń dotyczących pokoju. Możesz wymienić zdarzenia, które miały miejsce maksymalnie 28 dni temu. Jeśli nie określono inaczej, wyświetlana jest lista zdarzeń dotyczących pokoju z ostatnich 28 dni.
  • endTime: sygnatura czasowa uwzględniająca, do której zdarzeń dotyczących pokoju są wymienione. Jeśli nie określono inaczej, wyświetla listę zdarzeń do momentu przesłania żądania.

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

Prawidłowe są na przykład 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 są odrzucane przez serwer z błędem INVALID_ARGUMENT.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Komunikat z odpowiedzią na listę zdarzeń 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 kolejności chronologicznej (od najstarszych zdarzeń).
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 protokołu 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 na temat autoryzacji.