Method: spaces.spaceEvents.list

Wyświetla zdarzenia z pokoju Google Chat. W przypadku każdego zdarzenia ładunek zawiera najnowszą wersję zasobu czatu. 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 okresie objętym prośbą o dane nowi członkowie zostali usunięci, ładunek zdarzenia zawiera pusty zasób Membership.

Wymaga uwierzytelniania użytkownika z zakresem autoryzacji odpowiednim do odczytu żądanych danych:

  • 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świetlić listę wydarzeń, 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 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 zdarzenia listy. Podaj ten parametr, aby pobrać kolejną stronę.

Podczas podziału na strony wszystkie inne parametry podawane do zdarzeń listowania miejsc na stronie 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ń typy zdarzeń zbiorczych w filtrze. Żą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 dotyczące nowych reakcji (google.workspace.chat.reaction.v1.batchCreated). Listę obsługiwanych typów zdarzeń znajdziesz w SpaceEvents dokumentacji referencyjnej.

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

  • startTime: sygnatura czasowa, od której należy zacząć wyświetlać wydarzenia dotyczące miejsca. 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, do której są wyświetlane zdarzenia w pokoju. Jeśli nie określono tego parametru, lista 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.

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"

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

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na wyświetlanie 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 (najpierw najstarsze zdarzenie). Uwaga: w przypadku żądań listy pole permissionSettings nie jest zwracane w obiekcie pokoju.
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 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 dotyczącym autoryzacji.