В этом руководстве объясняется, как использовать метод get
в ресурсе Space
API Google Chat, чтобы просмотреть подробную информацию о пространстве, например его отображаемое имя, описание и рекомендации.
Ресурс Space
представляет собой место, где люди и приложения чата могут отправлять сообщения, обмениваться файлами и сотрудничать. Есть несколько типов помещений:
- Прямые сообщения (DM) — это разговоры между двумя пользователями или пользователем и приложением чата.
- Групповые чаты — это разговоры между тремя или более пользователями и приложениями чата.
- Именованные пространства — это постоянные места, где люди отправляют сообщения, обмениваются файлами и сотрудничают.
Аутентификация с помощью аутентификации приложения позволяет приложению Chat получать пространства, к которым приложение Chat имеет доступ в Google Chat (например, пространства, участником которых является приложение). Аутентификация с аутентификацией пользователя позволяет вам получить пространства, к которым имеет доступ аутентифицированный пользователь.
Предварительные условия
Питон
- Аккаунт Google Workspace для бизнеса или предприятия с доступом к Google Chat .
- Python 3.6 или выше
- Инструмент управления пакетами pip
- Новейшие клиентские библиотеки Google. Чтобы установить или обновить их, выполните следующую команду в интерфейсе командной строки:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- Настройте свою среду:
- Создайте проект Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat, указав имя, значок и описание для вашего приложения Chat.
- Создайте учетные данные доступа в зависимости от того, как вы хотите пройти аутентификацию в запросе к API Google Chat:
- Чтобы пройти аутентификацию в качестве пользователя Chat, создайте учетные данные идентификатора клиента OAuth и сохраните их в виде файла JSON с именем
client_secrets.json
в локальном каталоге. - Для аутентификации в приложении Chat создайте учетные данные сервисной учетной записи .
- Чтобы пройти аутентификацию в качестве пользователя Chat, создайте учетные данные идентификатора клиента OAuth и сохраните их в виде файла JSON с именем
- Выберите область авторизации в зависимости от того, хотите ли вы пройти аутентификацию как пользователь или приложение Chat.
Node.js
- Аккаунт Google Workspace для бизнеса или предприятия с доступом к Google Chat .
- Node.js 14 или более поздней версии
- Инструмент управления пакетами npm
- Новейшие клиентские библиотеки Google. Чтобы установить или обновить их, выполните следующую команду в интерфейсе командной строки:
npm install @google-cloud/local-auth @googleapis/chat
- Настройте свою среду:
- Создайте проект Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat, указав имя, значок и описание для вашего приложения Chat.
- Создайте учетные данные доступа в зависимости от того, как вы хотите пройти аутентификацию в запросе к API Google Chat:
- Чтобы пройти аутентификацию в качестве пользователя Chat, создайте учетные данные идентификатора клиента OAuth и сохраните их в виде файла JSON с именем
client_secrets.json
в локальном каталоге. - Для аутентификации в приложении Chat создайте учетные данные сервисной учетной записи .
- Чтобы пройти аутентификацию в качестве пользователя Chat, создайте учетные данные идентификатора клиента OAuth и сохраните их в виде файла JSON с именем
- Выберите область авторизации в зависимости от того, хотите ли вы пройти аутентификацию как пользователь или приложение Chat.
Получите место
Чтобы получить место в Google Chat, передайте в запросе следующее:
- При аутентификации приложения укажите область авторизации
chat.bot
. При аутентификации пользователя укажите областьchat.spaces.readonly
chat.spaces
. - Вызовите метод
get
ресурсаSpace
, передавname
пространства, которое требуется получить. Получите название пространства из ресурса пространств Google Chat или из URL-адреса пространства.
Получите подробную информацию о пространстве с помощью аутентификации пользователя
Вот как получить подробную информацию о пространстве с помощью аутентификации пользователя :
Питон
- В своем рабочем каталоге создайте файл с
chat_space_get_user.py
. Включите следующий код в
chat_space_get_user.py
:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.spaces.readonly"] def main(): ''' Authenticates with Chat API via user credentials, then gets details about a specified space. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Use the service endpoint to call Chat API. result = chat.spaces().get( # The space to get. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='spaces/SPACE' ).execute() # Prints details about the space. print(result) if __name__ == '__main__': main()
В коде замените
SPACE
именем пространства, которое можно получить с помощью методаspaces.list
в Chat API или из URL-адреса пространства.В своем рабочем каталоге соберите и запустите пример:
python3 chat_space_get_user.py
Node.js
- В своем рабочем каталоге создайте файл с именем
get-space.js
. Включите следующий код в
get-space.js
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Gets details about a Chat space by name. * @return {!Object} */ async function getSpace() { const scopes = [ 'https://www.googleapis.com/auth/chat.spaces.readonly', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.get({name: 'spaces/SPACE'}); } getSpace().then(console.log);
В коде замените
SPACE
именем пространства, которое можно получить с помощью методаspaces.list
в Chat API или из URL-адреса пространства.В своем рабочем каталоге запустите образец:
node get-space.js
API чата возвращает экземпляр Space
с подробной информацией об указанном пространстве.
Получите подробную информацию о пространстве с помощью аутентификации приложения
Вот как получить подробную информацию о пространстве с помощью аутентификации приложения :
Питон
- В своем рабочем каталоге создайте файл с
chat_space_get_app.py
. Включите следующий код в
chat_space_get_app.py
:from google.oauth2 import service_account from apiclient.discovery import build # Specify required scopes. SCOPES = ['https://www.googleapis.com/auth/chat.bot'] # Specify service account details. CREDENTIALS = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build the URI and authenticate with the service account. chat = build('chat', 'v1', credentials=CREDENTIALS) # Use the service endpoint to call Chat API. result = chat.spaces().get( # The space to get. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='spaces/SPACE' ).execute() print(result)
В коде замените
SPACE
именем пространства, которое можно получить с помощью методаspaces.list()
в Chat API или из URL-адреса пространства.В своем рабочем каталоге соберите и запустите пример:
python3 chat_space_get_app.py
Node.js
- В своем рабочем каталоге создайте файл с именем
app-get-space.js
. Включите следующий код в
app-get-space.js
:const chat = require('@googleapis/chat'); /** * Gets details about a Chat space by name. * @return {!Promise<!Object>} */ async function getSpace() { const scopes = [ 'https://www.googleapis.com/auth/chat.bot', ]; const auth = new chat.auth.GoogleAuth({ scopes, keyFilename: 'credentials.json', }); const authClient = await auth.getClient(); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.get({name: 'spaces/SPACE'}); } getSpace().then(console.log);
В коде замените
SPACE
именем пространства, которое можно получить с помощью методаspaces.list
в Chat API или из URL-адреса пространства.В своем рабочем каталоге запустите образец:
node app-get-space.js
API чата возвращает экземпляр Space
с подробной информацией об указанном пространстве.
Связанные темы
- Создайте пространство .
- Обустройте пространство .
- Перечислите пространства .
- Обновите пространство .
- Удалить пробел .
- Найдите место для прямых сообщений .