Method: spaces.spaceEvents.list

Wyświetla listę zdarzeń z pokoju Google Chat. W przypadku każdego zdarzenia ładunek zawiera najnowszą wersję zasobu Google Chat. Jeśli na przykład wyświetlasz listę zdarzeń dotyczących nowych członków pokoju, serwer zwraca zasoby Membership, które zawierają najnowsze informacje o członkostwie. 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: 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 zdarzenia dotyczącego miejsca na liście. Podaj ten parametr, 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 różnych 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 has :. 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 zaczyna się wyświetlanie listy zdarzeń dotyczących pokoju. Możesz wyświetlić zdarzenia, które miały miejsce do 28 dni temu. Jeśli nie jest określone, wyświetla się lista zdarzeń w czasie rzeczywistym z ostatnich 28 dni.
  • endTime: sygnatura czasowa uwzględniająca, do której zdarzeń z pokoju należą zdarzenia. Jeśli nie podasz daty, lista będzie zawierać zdarzenia do momentu wysłania żądania.

Aby określić czas rozpoczęcia lub zakończenia, użyj operatora równa się = i formatu RFC-3339. Aby filtrować według właściwości startTime 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"

Serwer odrzuca nieprawidłowe zapytania, zwracając błąd INVALID_ARGUMENT.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na prośbę o wyświetlenie 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ń). Uwaga: pole permissionSettings nie jest zwracane w obiekcie Space w przypadku żądań listy.
nextPageToken

string

Token kontynuacji służący 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.