Создайте пространство

В этом руководстве объясняется, как использовать метод create ресурса Space API Google Chat для создания именованного пространства.

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

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

Именованное пространство — это место, где люди отправляют сообщения, обмениваются файлами и сотрудничают. Именованные пространства могут включать приложения чата. Именованные пространства включают дополнительные функции, которых нет в неименованных групповых беседах и прямых сообщениях, например менеджеры пространств, которые могут применять административные настройки, описания, а также добавлять или удалять людей и приложения. После создания именованного пространства единственным участником пространства является прошедший проверку подлинности пользователь. Пространство не включает в себя других людей или приложения; даже приложение чата, которое его создает. Чтобы добавить людей, создайте членство в пространстве, вызвав метод create ресурса Member . Чтобы узнать, как это сделать, см. Создание членства .

Чтобы создать именованное пространство с несколькими участниками (безымянный групповой чат между тремя или более людьми или прямой разговор между двумя людьми или человеком и приложением Chat, вызывающим Chat API), вместо этого создайте пространство .

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

Питон

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

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

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
  • Проект Google Cloud с включенным и настроенным API Google Chat. Инструкции см. в разделе Создание приложения Google Chat .

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

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.create или chat.spaces .

Создать именованное пространство

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

  • Укажите область авторизации chat.spaces.create или chat.spaces .
  • Вызовите метод create для ресурса Space .
  • Установите для spaceType значение SPACE .
  • Задайте displayName имя пространства, видимое пользователю. В следующем примере displayName установлено значение API-made .
  • При необходимости установите другие атрибуты пространства, например spaceDetails (видимое пользователю описание и набор рекомендаций для пространства).

Вот как создать именованное пространство:

Питон

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

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

def main():
    '''
    Authenticates with Chat API via user credentials,
    then creates a Chat 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().create(

      # Details about the space to create.
      body = {

        # To create a named space, set spaceType to SPACE.
        'spaceType': 'SPACE',

        # The user-visible name of the space.
        'displayName': 'API-made'
      }

      ).execute()

    # Prints details about the created membership.
    print(result)

if __name__ == '__main__':
    main()

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

    python3 chat_space_create_named.py

Node.js

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

  2. Включите следующий код в create-space.js :

    const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* Creates a new chat space.
* @return {!Promise<!Object>}
*/
async function createSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.spaces.create',
  ];

  const authClient =
      await authenticate({scopes, keyfilePath: 'client_secrets.json'});

  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.create(
      {requestBody: {spaceType: 'SPACE', displayName: 'API-made'}});
}

createSpace().then(console.log);

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

    node create-space.js

Создается именованное пространство. Чтобы перейти к пространству, используйте идентификатор ресурса пространства для создания URL-адреса пространства. Идентификатор ресурса можно найти по name пространства в теле ответа Google Chat. Например, если name вашей темы — spaces/1234567 , вы можете перейти к ней по следующему URL-адресу: https://mail.google.com/chat/u/0/#chat/space/1234567 .