Masz 5 minut? Pomóż nam ulepszać dokumentację Google Chat dla deweloperów, wypełniając krótką ankietę.

Method: spaces.messages.list

Wyświetla wiadomości w pokoju, do którego należy rozmówca, w tym wiadomości od zablokowanych użytkowników i pokoi. Przykład: zobacz Wyświetlanie 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

Wymagany. 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 wartość nie zostanie podana, zostanie zwróconych maksymalnie 25.

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

Wartości ujemne oznaczają błąd INVALID_ARGUMENT.

pageToken

string

Opcjonalne, jeśli jest wznawiane z poprzedniego zapytania.

Token strony otrzymany z poprzedniego wywołania wiadomości. Podaj ten parametr w celu pobrania następnej strony.

W podziale na strony wszystkie pozostałe podane parametry powinny być zgodne z wywołaniem dostarczonym przez token strony. Przekazywanie różnych wartości innym parametrom może prowadzić do nieoczekiwanych wyników.

filter

string

Filtr zapytań.

Możesz filtrować wiadomości 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 cudzysłowami. Na przykład: "2023-04-21T11:30:00-04:00". Aby wyświetlić listę wiadomości utworzonych przed sygnaturą czasową, możesz użyć operatora większe niż > lub operatora mniejszego niż <. Aby filtrować wiadomości w danym przedziale czasu, użyj operatora AND między 2 sygnaturami czasowymi.

Aby filtrować według wątku, podaj thread.name w formacie spaces/{space}/threads/{thread}. Możesz podać tylko 1 thread.name na zapytanie.

Aby filtrować według wątku 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 jest wznawiane z poprzedniego zapytania.

Jak jest uporządkowana lista wiadomości. Podaj wartość, którą chcesz zamówić. Prawidłowe wartości zamówienia są następujące:

  • ASC (rosnąco).

  • DESC (malejąco).

Domyślna kolejność to createTime ASC.

showDeleted

boolean

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

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

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. Brak wartości oznacza, że 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.