Method: spaces.messages.list

Выводит список сообщений в спейсе, участником которого является вызывающий, включая сообщения от заблокированных участников и спейсов. Системные сообщения, например, о новых участниках спейса, не включаются. Если вывести список сообщений из спейса, в котором нет сообщений, ответ будет пустым. При использовании интерфейса REST/HTTP ответ содержит пустой JSON-объект {} . Пример см. в разделе Список сообщений .

Поддерживает следующие типы аутентификации :

  • Аутентификация приложения с одобрением администратора в Developer Preview с областью авторизации:

    • https://www.googleapis.com/auth/chat.app.messages.readonly . При использовании этой области аутентификации этот метод возвращает только публичные сообщения в чат-группе. Он не включает личные сообщения.

  • Аутентификация пользователя с одной из следующих областей авторизации:

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (только пространство в режиме импорта)

HTTP-запрос

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

URL использует синтаксис перекодировки gRPC .

Параметры пути

Параметры
parent

string

Обязательно. Имя ресурса пространства, из которого нужно вывести список сообщений.

Формат: spaces/{space}

Параметры запроса

Параметры
pageSize

integer

Необязательно. Максимальное количество возвращаемых сообщений. Сервис может вернуть меньше сообщений, чем это значение.

Если не указано иное, возвращается не более 25.

Максимальное значение — 1000. Если вы используете значение больше 1000, оно автоматически изменится на 1000.

Отрицательные значения возвращают ошибку INVALID_ARGUMENT .

pageToken

string

Необязательный. Токен страницы, полученный из предыдущего вызова списка сообщений. Укажите этот параметр для получения следующей страницы.

При пагинации все остальные предоставленные параметры должны соответствовать вызову, предоставившем токен страницы. Передача других значений другим параметрам может привести к неожиданным результатам.

filter

string

Необязательно. Фильтр запроса.

Вы можете фильтровать сообщения по дате ( createTime ) и теме ( thread.name ).

Чтобы отфильтровать сообщения по дате создания, укажите время createTime с временной меткой в формате RFC-3339 и двойными кавычками. Например, "2023-04-21T11:30:00-04:00" . Для отображения сообщений, созданных после определённой временной метки, можно использовать оператор "больше > , а для отображения сообщений, созданных до неё, — оператор "меньше < . Чтобы отфильтровать сообщения в заданном интервале времени, используйте оператор AND между двумя временными метками.

Для фильтрации по потоку укажите thread.name в формате spaces/{space}/threads/{thread} . Для одного запроса можно указать только одно thread.name .

Чтобы отфильтровать по теме и дате, используйте в запросе оператор AND .

Например, следующие запросы являются допустимыми:

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

Недействительные запросы отклоняются сервером с ошибкой INVALID_ARGUMENT .

orderBy

string

Необязательно. Как упорядочивается список сообщений. Укажите значение для упорядочивания по операции упорядочивания. Допустимые значения операции упорядочивания:

  • ASC — по возрастанию.

  • DESC по убыванию.

Порядок по умолчанию — createTime ASC .

showDeleted

boolean

Необязательно. Включать ли удалённые сообщения. У удалённых сообщений указывается время удаления и метаданные об их удалении, но содержание сообщения недоступно.

Текст запроса

Тело запроса должно быть пустым.

Тело ответа

Ответное сообщение для листинга сообщений.

В случае успеха тело ответа содержит данные со следующей структурой:

JSON-представление 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string
}
Поля
messages[]

object ( Message )

Список сообщений.

nextPageToken

string

Вы можете отправить токен pageToken для получения следующей страницы результатов. Если значение пусто, последующих страниц нет.

Области авторизации

Требуется одна из следующих областей 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

Более подробную информацию смотрите в Руководстве по авторизации .