Method: spaces.messages.list

Wyświetla listę wiadomości w pokoju, którego użytkownikiem jest wywołujący, w tym wiadomości od zablokowanych użytkowników i z zablokowanych pokoi. Nie są uwzględniane wiadomości systemowe, np. te, które informują o nowych członkach pokoju. Jeśli wyświetlisz listę wiadomości z pokoju, w którym nie ma żadnych wiadomości, odpowiedź będzie pustym obiektem. W przypadku korzystania z interfejsu REST/HTTP odpowiedź zawiera pusty obiekt JSON, {}. Przykład znajdziesz w artykule Wyświetlanie listy wiadomości.

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z zatwierdzeniem przez administratora w zakresie autoryzacji:

    • https://www.googleapis.com/auth/chat.app.messages.readonly W przypadku używania tego zakresu uwierzytelniania ta metoda zwraca tylko wiadomości publiczne na czacie. Nie obejmuje to wiadomości prywatnych.

  • Uwierzytelnianie użytkownika z jednym z tych zakresów autoryzacji:

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (tylko pokoje w trybie importowania)

Żą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

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

Jeśli nie podano tego argumentu, zwracanych jest maksymalnie 25 wyników.

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ć następną stronę.

Podczas stronicowania wszystkie inne podane parametry powinny być zgodne z wywołaniem, które dostarczyło token strony. Przekazywanie innych wartości do pozostałych parametrów może prowadzić do nieoczekiwanych wyników.
filter

string

Opcjonalnie. filtr zapytania,

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

Aby filtrować wiadomości według daty ich utworzenia, podaj createTime ze znacznikiem czasu w formacie RFC-3339 i cudzysłowem. Na przykład: "2023-04-21T11:30:00-04:00". Możesz użyć operatora większości >, aby wyświetlić listę wiadomości utworzonych po sygnaturze czasowej, lub operatora mniejszości <, aby wyświetlić listę wiadomości utworzonych przed sygnaturą czasową. Aby filtrować wiadomości w przedziale czasu, użyj operatora AND między dwoma sygnaturami czasowymi.

Aby filtrować według wątku, podaj thread.name w formacie spaces/{space}/threads/{thread}. W każdym zapytaniu 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

Nieprawidłowe zapytania są odrzucane przez serwer z błędem INVALID_ARGUMENT.
orderBy

string

Opcjonalnie. Określa kolejność wyświetlania listy wiadomości. Określ wartość, według której ma być wykonane sortowanie. Prawidłowe wartości operacji zamawiania:

  • ASC – rosnąco.

  • DESC – malejąco.

Domyślna kolejność to createTime ASC.
showDeleted

boolean

Opcjonalnie. Czy uwzględniać usunięte wiadomości. Usunięte wiadomości zawierają czas usunięcia i metadane dotyczące usunięcia, ale treść wiadomości jest niedostępna.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Wiadomość odpowiedzi dotycząca wiadomości na liście.

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
  • https://www.googleapis.com/auth/chat.app.messages.readonly

Więcej informacji znajdziesz w przewodniku po autoryzacji.