Method: spaces.messagePins.list

Отображает список закрепленных сообщений в пространстве. Пользователи могут закреплять важные сообщения в пространстве для быстрого доступа. Для получения дополнительной информации см. раздел «Закрепление или открепление беседы в Google Chat» .

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

  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces

HTTP-запрос

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

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

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

Параметры
parent

string

Обязательно. Родительское пространство, которому принадлежит коллекция закрепленных элементов. Формат: spaces/{space}

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

Параметры
pageSize

integer

Необязательный параметр. Максимальное количество возвращаемых PIN-кодов сообщений. Сервис может вернуть меньше сообщений, чем это значение. Максимальное значение — 100. Если вы используете значение больше 100, оно автоматически изменяется на 100. Если значение не указано, будет возвращено не более 100 PIN-кодов сообщений. Отрицательные значения приводят к ошибке INVALID_ARGUMENT .

pageToken

string

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

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

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

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

Ответный текст

Ответное сообщение для отображения списка закрепленных сообщений.

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

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

object ( MessagePin )

Закрепленные сообщения из указанного пространства.

nextPageToken

string

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

Области полномочий

Требуется один из следующих диапазонов аутентификации OAuth:

  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly

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