Method: spaces.spaceEvents.list

Wyświetla listę wydarzeń z pokoju Google Chat. W przypadku każdego zdarzenia ładunek zawiera najnowszą wersję zasobu czatu. Jeśli na przykład wymienisz wydarzenia dotyczące nowych członków przestrzeni, serwer zwróci zasoby Membership zawierające najnowsze informacje o członkostwie. Jeśli w okresie objętym żądaniem usunięto nowych członków, ładunek zdarzenia zawiera pusty zasób Membership.

Obsługuje te typy uwierzytelniania z zakresem autoryzacji odpowiednim do odczytywania żądanych danych:

  • Uwierzytelnianie aplikacji z zatwierdzeniem przez administratora w wersji przedpremierowej z jednym z tych zakresów autoryzacji:

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

  • Uwierzytelnianie użytkownika z jednym z tych zakresów autoryzacji:

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

Aby wyświetlać listę zdarzeń, uwierzytelniony wywołujący musi być członkiem pokoju.

Przykład znajdziesz w artykule Wyświetlanie listy wydarzeń z pokoju w 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 zwracanych zdarzeń dotyczących przestrzeni. Usługa może zwrócić mniej niż ta wartość.

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

string

Opcjonalnie. Token strony otrzymany z poprzedniego wywołania listy wydarzeń w przestrzeni. Podaj ten token, aby pobrać kolejną stronę.

Podczas paginacji wszystkie inne parametry przekazane do zdarzeń przestrzeni listy 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 wsadowe. Jeśli na przykład zastosujesz filtr nowych reakcji (google.workspace.chat.reaction.v1.created), serwer zwróci też zdarzenia dotyczące nowych reakcji w pakietach (google.workspace.chat.reaction.v1.batchCreated). Listę obsługiwanych typów zdarzeń znajdziesz w SpaceEvents dokumentacji.

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

  • startTime: Wyłączna sygnatura czasowa, od której należy rozpocząć wyświetlanie wydarzeń w przestrzeni. Możesz wyświetlać wydarzenia, które miały miejsce maksymalnie 28 dni temu. Jeśli nie podasz żadnej wartości, wyświetli listę wydarzeń związanych z przestrzenią z ostatnich 28 dni.
  • endTime: sygnatura czasowa, do której włącznie są wymienione wydarzenia w pokoju. Jeśli nie określono tego parametru, wyświetlane są zdarzenia do momentu wysłania żądania.

Aby określić godzinę rozpoczęcia lub zakończenia, użyj operatora równości = i formatu RFC-3339. Aby filtrować według obu tych wartości, użyj operatora AND.startTimeendTime

Na przykład te zapytania są prawidłowe:

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

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

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 (najpierw najstarsze zdarzenie). Uwaga: pole permissionSettings nie jest zwracane w obiekcie Space w przypadku żądań listy.
nextPageToken

string

Token kontynuacji używany do pobierania większej liczby 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.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • 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.