Получить подробную информацию о пространстве

В этом руководстве объясняется, как использовать метод get в ресурсе Space API Google Chat, чтобы просмотреть подробную информацию о пространстве, например его отображаемое имя, описание и рекомендации.

Ресурс Space представляет собой место, где люди и приложения чата могут отправлять сообщения, обмениваться файлами и сотрудничать. Есть несколько типов помещений:

• Прямые сообщения (DM) — это разговоры между двумя пользователями или пользователем и приложением чата.
• Групповые чаты — это разговоры между тремя или более пользователями и приложениями чата.
• Именованные пространства — это постоянные места, где люди отправляют сообщения, обмениваются файлами и сотрудничают.

Аутентификация с помощью аутентификации приложения позволяет приложению Chat получать пространства, к которым приложение Chat имеет доступ в Google Chat (например, пространства, участником которых является приложение). Аутентификация с аутентификацией пользователя позволяет вам получить пространства, к которым имеет доступ аутентифицированный пользователь.

Предварительные условия

Питон

• Python 3.6 или выше
• Инструмент управления пакетами pip

• Новейшие клиентские библиотеки Google для Python. Чтобы установить или обновить их, выполните следующую команду в интерфейсе командной строки:

  pip3 install --upgrade google-api-python-client google-auth-oauthlib google-auth
  

• Проект Google Cloud с включенным и настроенным API Google Chat. Инструкции см. в разделе Создание приложения Google Chat .

• Авторизация настроена для приложения Чат. Получение пространства поддерживает оба следующих метода аутентификации:

  • Аутентификация пользователя с областью авторизации chat.spaces.readonly или chat.spaces .
  • Аутентификация приложения с областью авторизации chat.bot .

Node.js

• Node.js и npm

• Новейшие клиентские библиотеки Google для Node.js. Чтобы установить их, выполните следующую команду в интерфейсе командной строки:

  npm install @google-cloud/local-auth @googleapis/chat
  

• Проект Google Cloud с включенным и настроенным API Google Chat. Инструкции см. в разделе Создание приложения Google Chat .

• Авторизация настроена для приложения Чат. Получение пространства поддерживает оба следующих метода аутентификации:

  • Аутентификация пользователя с областью авторизации chat.spaces.readonly или chat.spaces .
  • Аутентификация приложения с областью авторизации chat.bot .

Получите место

Чтобы получить место в Google Chat, передайте в запросе следующее:

• При аутентификации приложения укажите область авторизации chat.bot . При аутентификации пользователя укажите chat.spaces.readonly авторизацииchat.spaces.readonly chat.spaces .
• Вызовите метод get ресурса Space , передав name пространства, которое требуется получить. Получите название пространства из ресурса пространств Google Chat или из URL-адреса пространства.

Получите подробную информацию о пространстве с помощью аутентификации пользователя

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

Питон

1. В своем рабочем каталоге создайте файл с chat_space_get_user.py .

2. Включите следующий код 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()
   

3. В коде замените SPACE именем пространства, которое можно получить с помощью метода spaces.list в Chat API или из URL-адреса пространства.

4. В своем рабочем каталоге соберите и запустите пример:

   python3 chat_space_get_user.py
   

Node.js

1. В своем рабочем каталоге создайте файл с именем get-space.js .

2. Включите следующий код в 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);
   

3. В коде замените SPACE именем пространства, которое можно получить с помощью метода spaces.list в Chat API или из URL-адреса пространства.

4. В своем рабочем каталоге запустите образец:

   node get-space.js
   

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

Получите подробную информацию о пространстве с помощью аутентификации приложения

Вот как получить подробную информацию о пространстве с помощью аутентификации приложения :

Питон

1. В своем рабочем каталоге создайте файл с chat_space_get_app.py .

2. Включите следующий код в 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)
   

3. В коде замените SPACE именем пространства, которое можно получить с помощью метода spaces.list() в Chat API или из URL-адреса пространства.

4. В своем рабочем каталоге соберите и запустите пример:

   python3 chat_space_get_app.py
   

Node.js

1. В своем рабочем каталоге создайте файл с именем app-get-space.js .

2. Включите следующий код в 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);
   

3. В коде замените SPACE именем пространства, которое можно получить с помощью метода spaces.list в Chat API или из URL-адреса пространства.

4. В своем рабочем каталоге запустите образец:

   node app-get-space.js
   

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

похожие темы

• Создайте пространство .
• Обустройте пространство .
• Перечислите пространства .
• Обновите пространство .
• Удалить пробел .
• Найдите место для прямых сообщений .