Method: spaces.messages.list

Wyświetla listę wiadomości z pokoju, do którego należy rozmówca, w tym wiadomości od zablokowanych użytkowników i pokoi. Jeśli wyświetlisz wiadomości z pokoju, w którym nie ma żadnych wiadomości, odpowiedź będzie pustym obiektem. W przypadku interfejsu REST/HTTP odpowiedź zawiera pusty obiekt JSON, {}. Przykład: Wyświetlanie listy wiadomości.

Wymaga uwierzytelniania użytkownika.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

Wymagane. Nazwa zasobu pokoju, z którego mają być wyświetlane wiadomości.

Format: spaces/{space}

Parametry zapytania

Parametry
pageSize

integer

Maksymalna liczba zwróconych wiadomości. Usługa może zwrócić mniej wiadomości niż ta wartość.

Jeśli nie określono inaczej, zwracanych jest maksymalnie 25.

Maksymalna wartość to 1000. Jeśli użyjesz wartości większej niż 1000, zostanie ona automatycznie zmieniona na 1000.

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

string

Opcjonalne, jeśli wznawiasz działanie po poprzednim zapytaniu.

Token strony otrzymany z poprzedniego wywołania listy wiadomości. Podaj ten parametr, aby pobrać kolejną stronę.

Podczas dzielenia na strony wszystkie pozostałe parametry powinny 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

Filtr zapytania.

Możesz filtrować wiadomości według daty (createTime) i wątku (thread.name).

Aby filtrować wiadomości według daty ich utworzenia, wpisz createTime z sygnaturą czasową w formacie RFC-3339 i cudzysłowami podwójnymi. Na przykład: "2023-04-21T11:30:00-04:00". Możesz użyć operatora większego niż >, aby wyświetlić listę wiadomości, które zostały utworzone po określonej sygnaturze czasowej, lub operatora mniej niż <, aby wyświetlić wiadomości, które zostały utworzone przed sygnaturą czasową. Aby filtrować wiadomości w określonym przedziale czasu, między 2 sygnaturami czasowymi użyj operatora AND.

Aby filtrować według wątku, podaj element thread.name w formacie spaces/{space}/threads/{thread}. W przypadku każdej kwerendy możesz określić tylko 1 element thread.name.

Aby filtrować wyniki zarówno według wątku, jak i daty, użyj w zapytaniu operatora AND.

Prawidłowe są na przykład te zapytania:

createTime > "2012-04-21T11:30:00-04:00"

createTime > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

createTime > "2012-04-21T11:30:00+00:00" AND

createTime < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

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

string

Opcjonalne, jeśli wznawiasz działanie po poprzednim zapytaniu.

Określ kolejność wyświetlania wiadomości. Określ wartość do posortowania za pomocą operacji sortowania. Prawidłowe wartości operacji sortowania:

  • ASC w kolejności rosnącej.

  • DESC malejąco.

Domyślna kolejność to createTime ASC.
showDeleted

boolean

Określa, czy mają być uwzględniane usunięte wiadomości. Usunięte wiadomości zawierają informacje o czasie usunięcia i metadane dotyczące jego usunięcia, ale treść wiadomości jest niedostępna.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na wiadomość o wyświetleniu wiadomości.

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

Zapis JSON 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string
}
Pola
messages[]

object (Message)

Lista wiadomości.
nextPageToken

string

Aby pobrać następną stronę wyników, możesz wysłać token jako pageToken. Jeśli pole jest puste, nie ma kolejnych stron.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.