Обновить пространство

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

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

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

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

Питон

  • 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 .

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 .

Обновить пространство

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

  • Укажите область авторизации chat.spaces .
  • Вызовите метод patch для ресурса Space и передайте name обновляемого пространства, а также updateMask и body , определяющее обновленные атрибуты пространства.
  • updateMask определяет аспекты пространства для обновления и включает в себя следующее:
    • displayName : обновляет удобочитаемое имя пространства, отображаемое в пользовательском интерфейсе Google Chat. Поддерживается изменение отображаемого имени пространства только с типом SPACE или при включении маски spaceType для изменения типа пространства GROUP_CHAT на SPACE . Попытка обновить отображаемое имя пространства GROUP_CHAT или DIRECT_MESSAGE приводит к ошибке недопустимого аргумента.
    • spaceType : обновляет тип пространства, но поддерживает только изменение типа пространства GROUP_CHAT на SPACE . Включите displayName вместе с spaceType в маску обновления и убедитесь, что указанное пространство имеет непустое displayName и тип пространства SPACE . Если существующее пространство уже имеет тип SPACE , включая маску spaceType и тип SPACE в указанном пространстве, при обновлении отображаемого имени является необязательным. Попытка обновить тип пространства другими способами приводит к ошибке недопустимого аргумента.
    • spaceDetails : Подробная информация о пространстве, включая описание и правила.
    • spaceHistoryState : поддерживает включение и отключение истории для пространства, если организация позволяет пользователям изменять настройки истории . Взаимоисключающее со всеми другими путями полей.

Вот как обновить spaceDetails существующего пространства:

Питон

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

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

def main():
    '''
    Authenticates with Chat API via user credentials,
    then updates the specified space description and guidelines.
    '''

    # 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().patch(

      # The space to update, and the updated space details.
      #
      # 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',
      updateMask='spaceDetails',
      body={

        'spaceDetails': {
          'description': 'This description was updated with Chat API!',
          'guidelines': 'These guidelines were updated with Chat API!'
        }

      }

    ).execute()

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

if __name__ == '__main__':
    main()

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

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

    python3 chat_space_update.py

Node.js

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

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

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

/**
* Updates a Chat space with the description and guidelines.
* @return {!Promise<!Object>}
*/
async function updateSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.spaces',
  ];

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

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

  return await chatClient.spaces.patch({
    name: 'spaces/SPACE',
    updateMask: 'spaceDetails',
    requestBody: {
      spaceDetails: {
        description: 'This description was updated with Chat API!',
        guidelines: 'These guidelines were updated with Chat API!'
      },
    }
  });
}

updateSpace().then(console.log);

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

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

    node update-space.js

API Google Chat возвращает экземпляр ресурса Space , отражающий обновления.