В этом руководстве объясняется, как использовать метод list()
ресурса Space
API Google Chat для составления списка пространств. При перечислении пространств возвращается фильтруемый список пространств с разбивкой на страницы.
Ресурс Space
представляет собой место, где люди и приложения чата могут отправлять сообщения, обмениваться файлами и сотрудничать. Есть несколько типов помещений:
- Прямые сообщения (DM) — это разговоры между двумя пользователями или пользователем и приложением чата.
- Групповые чаты — это разговоры между тремя или более пользователями и приложениями чата.
- Именованные пространства — это постоянные места, где люди отправляют сообщения, обмениваются файлами и сотрудничают.
В списке пространств с аутентификацией приложения перечислены пространства, к которым приложение Chat имеет доступ. В списке пространств с аутентификацией пользователя перечислены пространства, к которым имеет доступ аутентифицированный пользователь.
Предварительные условия
Node.js
- Аккаунт Google Workspace для бизнеса или предприятия с доступом к Google Chat .
- Настройте свою среду:
- Создайте проект Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat , указав имя, значок и описание для вашего приложения Chat.
- Установите облачную клиентскую библиотеку Node.js.
- Создайте учетные данные доступа в зависимости от того, как вы хотите пройти аутентификацию в запросе к API Google Chat:
- Чтобы пройти аутентификацию в качестве пользователя Chat, создайте учетные данные идентификатора клиента OAuth и сохраните их в виде файла JSON с именем
client_secrets.json
в локальном каталоге. - Чтобы пройти аутентификацию в качестве приложения Chat, создайте учетные данные учетной записи службы и сохраните их в виде файла JSON с именем
credentials.json
.
- Чтобы пройти аутентификацию в качестве пользователя Chat, создайте учетные данные идентификатора клиента OAuth и сохраните их в виде файла JSON с именем
- Выберите область авторизации в зависимости от того, хотите ли вы пройти аутентификацию как пользователь или приложение Chat.
Питон
- Аккаунт Google Workspace для бизнеса или предприятия с доступом к Google Chat .
- Настройте свою среду:
- Создайте проект Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat , указав имя, значок и описание для вашего приложения Chat.
- Установите облачную клиентскую библиотеку Python.
- Создайте учетные данные доступа в зависимости от того, как вы хотите пройти аутентификацию в запросе к API Google Chat:
- Чтобы пройти аутентификацию в качестве пользователя Chat, создайте учетные данные идентификатора клиента OAuth и сохраните их в виде файла JSON с именем
client_secrets.json
в локальном каталоге. - Чтобы пройти аутентификацию в качестве приложения Chat, создайте учетные данные учетной записи службы и сохраните их в виде файла JSON с именем
credentials.json
.
- Чтобы пройти аутентификацию в качестве пользователя Chat, создайте учетные данные идентификатора клиента OAuth и сохраните их в виде файла JSON с именем
- Выберите область авторизации в зависимости от того, хотите ли вы пройти аутентификацию как пользователь или приложение Chat.
Ява
- Аккаунт Google Workspace для бизнеса или предприятия с доступом к Google Chat .
- Настройте свою среду:
- Создайте проект Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat , указав имя, значок и описание для вашего приложения Chat.
- Установите облачную клиентскую библиотеку Java.
- Создайте учетные данные доступа в зависимости от того, как вы хотите пройти аутентификацию в запросе к API Google Chat:
- Чтобы пройти аутентификацию в качестве пользователя Chat, создайте учетные данные идентификатора клиента OAuth и сохраните их в виде файла JSON с именем
client_secrets.json
в локальном каталоге. - Чтобы пройти аутентификацию в качестве приложения Chat, создайте учетные данные учетной записи службы и сохраните их в виде файла JSON с именем
credentials.json
.
- Чтобы пройти аутентификацию в качестве пользователя Chat, создайте учетные данные идентификатора клиента OAuth и сохраните их в виде файла JSON с именем
- Выберите область авторизации в зависимости от того, хотите ли вы пройти аутентификацию как пользователь или приложение Chat.
Скрипт приложений
- Аккаунт Google Workspace для бизнеса или предприятия с доступом к Google Chat .
- Настройте свою среду:
- Создайте проект Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat , указав имя, значок и описание для вашего приложения Chat.
- Создайте автономный проект Apps Script и включите расширенную службу чата .
- В этом руководстве вы должны использовать аутентификацию пользователя или приложения . Для аутентификации в качестве приложения Chat создайте учетные данные сервисной учетной записи. Инструкции см. в разделе Аутентификация и авторизация в качестве приложения Google Chat .
- Выберите область авторизации в зависимости от того, хотите ли вы пройти аутентификацию как пользователь или приложение Chat.
Пространства списка с аутентификацией пользователя
Чтобы перечислить пространства в Google Chat, передайте в запросе следующее:
- При аутентификации пользователя укажите область
chat.spaces.readonly
chat.spaces
. - Вызовите метод
ListSpaces()
.
В следующем примере перечислены именованные пространства (но не групповые чаты и прямые сообщения, которые отфильтровываются), видимые аутентифицированному пользователю:
Node.js
Питон
Ява
Скрипт приложений
Chat API возвращает разбитый на страницы список пробелов .
Список пространств с аутентификацией приложения
Чтобы перечислить пространства в Google Chat, передайте в запросе следующее:
- При аутентификации приложения укажите область авторизации
chat.bot
. - Вызовите метод
ListSpaces()
.
В следующем примере перечислены именованные пространства (но не групповые чаты и прямые сообщения), видимые в приложении «Чат»:
Node.js
Питон
Ява
Скрипт приложений
Chat API возвращает разбитый на страницы список пробелов .
Настройте нумерацию страниц или отфильтруйте список
Чтобы составить список пространств в Google Chat, передайте следующие дополнительные параметры запроса, чтобы настроить нумерацию страниц или отфильтровать перечисленные пространства:
-
pageSize
: максимальное количество возвращаемых пробелов. Служба может вернуть меньше этого значения. Если не указано, возвращается не более 100 пробелов. Максимальное значение — 1000; значения выше 1000 автоматически изменяются на 1000. -
pageToken
: токен страницы, полученный в результате предыдущего вызова пространств списка. Предоставьте этот токен для получения следующей страницы. При разбиении на страницы значение фильтра должно соответствовать вызову, который предоставил токен страницы. Передача другого значения может привести к неожиданным результатам. -
filter
: фильтр запроса. Подробные сведения о поддерживаемых запросах см. в справочникеListSpacesRequest
.
Связанные темы
- Создайте пространство .
- Обустройте пространство .
- Получите подробную информацию о помещении .
- Обновите пространство .
- Удалить пробел .
- Найдите место для прямых сообщений .