Method: spaces.messages.list

Wyświetla listę wiadomości w pokoju, do którego należy rozmówca, w tym wiadomości od zablokowanych użytkowników i pokoi. Przykładem może być 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 wyświetlane są 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 wznawiam od poprzedniego zapytania.

Token strony odebrany z poprzedniego wywołania komunikatów listy. Podaj ten parametr, aby pobrać kolejną stronę.

W przypadku podziału na strony wszystkie pozostałe parametry powinny być zgodne z wywołaniem, które dostarczyło token strony. Przekazywanie różnych wartości do pozostałych parametrów może prowadzić do nieoczekiwanych wyników.
filter

string

Filtr zapytania.

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

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

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

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

Prawidłowe są np. 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

Nieprawidłowe zapytania zostały odrzucone przez serwer z błędem INVALID_ARGUMENT.
orderBy

string

Opcjonalne, jeśli wznawiam od poprzedniego zapytania.

Jak jest uporządkowana lista wiadomości. Określ wartość do sortowania według operacji sortowania. Prawidłowe wartości operacji sortowania są następujące:

  • ASC – rosnąco.

  • DESC – malejąco.

Domyślna kolejność to createTime ASC.
showDeleted

boolean

Określa, czy uwzględnić usunięte wiadomości. Usunięte wiadomości zawierają czas i metadane dotyczące usunięcia, ale treść wiadomości jest niedostępna.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Wiadomość z odpowiedzią na listę 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

Możesz wysłać token jako pageToken, aby pobrać następną stronę wyników. Jeśli ta wartość jest pusta, nie ma kolejnych stron.

Zakresy autoryzacji

Wymaga jednego z tych zakresów 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 po autoryzacji.