Method: spaces.messages.list

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

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

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

    • 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

Для получения более подробной информации см. руководство по авторизации .

,

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

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

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

    • 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

Для получения более подробной информации см. руководство по авторизации .