Method: spaces.messages.list

Wyświetla wiadomości w pokoju, którego użytkownik jest członkiem, w tym wiadomości od zablokowanych użytkowników i z zablokowanych pokoi. Jeśli wyświetlasz listę wiadomości z pokoju, w którym nie ma wiadomości, odpowiedź będzie pustym obiektem. W przypadku interfejsu REST/HTTP odpowiedź zawiera pusty obiekt JSON, {}. Przykładem jest artykuł Lista 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

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

Jeśli nie podano tej wartości, zwracana jest maksymalna liczba 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

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

Podczas podziału na strony wszystkie inne parametry powinny być takie same jak w wywołaniu, które dostarczyło token strony. Przekazywanie różnych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników.
filter

string

Opcjonalnie: 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, określ createTime za pomocą sygnatury czasowej w formacie RFC-3339 i podwójnych cudzysłowów. Na przykład: "2023-04-21T11:30:00-04:00". Możesz użyć operatora większego >, aby wyświetlić wiadomości utworzone po podanej sygnaturze czasowej, lub operatora mniejszego <, aby wyświetlić wiadomości utworzone przed podaną sygnaturą czasową. Aby odfiltrować wiadomości w okresie czasu, użyj operatora AND między dwoma sygnaturami czasowymi.

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

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

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

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

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

  • ASC w kolejności rosnącej.

  • DESC w kolejności malejącej.

Domyślne sortowanie to createTime ASC.
showDeleted

boolean

Opcjonalnie: Czy uwzględnić usunięte wiadomości. Usuwane wiadomości zawierają czas usunięcia i metadane dotyczące ich usunięcia, ale ich treść 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 jest puste, 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 dotyczącym autoryzacji.