Обновить членство пользователя в чате Google,Обновить членство пользователя в чате Google

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

Ресурс Membership указывает, приглашен ли пользователь или приложение Google Chat в пространство, участвует в нем или отсутствует в нем.

Питон

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

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

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

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

• Авторизация настроена для приложения Чат. Для обновления членства требуется аутентификация пользователя с областью chat.memberships или, при импорте данных в Chat , областью chat.import .

Node.js

• Node.js и npm

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

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

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

• Авторизация настроена для приложения Чат. Для обновления членства требуется аутентификация пользователя с областью chat.memberships или, при импорте данных в Chat , областью chat.import .

Скрипт приложений

• Аккаунт Google Workspace с доступом к Google Chat .
• Опубликованное приложение чата. Чтобы создать приложение Chat, следуйте этому краткому руководству .
• Авторизация настроена для приложения Чат. Для обновления членства требуется аутентификация пользователя с областью chat.memberships или, при импорте данных в Chat , областью chat.import .

Обновить членство

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

• Укажите область авторизации chat.memberships .
• Вызовите метод patch для ресурса Membership и передайте name обновляемого членства, а также updateMask и body , определяющее обновленные атрибуты членства.
• updateMask определяет аспекты членства, которые необходимо обновить, и включает в себя следующее:
  • role : роль пользователя в пространстве чата, которая определяет его разрешенные действия в пространстве. Возможные значения:
    • ROLE_MEMBER : член пространства. У пользователя есть базовые разрешения, такие как отправка сообщений в пространство. В беседах 1:1 и неназванных групповых беседах эта роль есть у каждого.
    • ROLE_MANAGER : менеджер пространства. Пользователь имеет все основные разрешения, а также административные разрешения, которые позволяют ему управлять пространством, например добавлять или удалять участников. Поддерживается только в пространствах, где spaceType — SPACE (именованные пространства).

Сделать обычного участника пространства менеджером пространства

В следующем примере обычный участник пространства становится менеджером пространства, указав role ROLE_MANAGER в body , которое указывает обновленные атрибуты членства:

Питон

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

2. Включите следующий код chat_membership_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.memberships"]
   
   def main():
       '''
       Authenticates with Chat API via user credentials,
       then updates a specified space member to change
       it from a regular member to a space manager.
       '''
   
       # 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().members().patch(
   
           # The membership to update, and the updated role.
           #
           # Replace SPACE with a space name.
           # Obtain the space name from the spaces resource of Chat API,
           # or from a space's URL.
           #
           # Replace MEMBERSHIP with a membership name.
           # Obtain the membership name from the membership of Chat API.
           name='spaces/SPACE/members/MEMBERSHIP',
           updateMask='role',
           body={'role': 'ROLE_MANAGER'}
   
         ).execute()
   
       # Prints details about the updated membership.
       print(result)
   
   if __name__ == '__main__':
       main()
   

3. В коде замените следующее:

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

   • MEMBERSHIP : имя участника, которое можно получить с помощью метода spaces.members.list в Chat API.

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

   python3 chat_membership_update.py
   

Node.js

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

2. Включите следующий код chat_membership_update.js :

   const chat = require('@googleapis/chat');
   const {authenticate} = require('@google-cloud/local-auth');
   
   /**
   * Updates a membership in a Chat space to change it from
   * a space member to a space manager.
   * @return {!Promise<!Object>}
   */
   async function updateSpace() {
   
     /**
     * Authenticate with Google Workspace
     * and get user authorization.
     */
     const scopes = [
       'https://www.googleapis.com/auth/chat.memberships',
     ];
   
     const authClient =
         await authenticate({scopes, keyfilePath: 'client_secrets.json'});
   
     /**
     * Build a service endpoint for Chat API.
     */
     const chatClient = await chat.chat({version: 'v1', auth: authClient});
   
     /**
     * Use the service endpoint to call Chat API.
     */
     return await chatClient.spaces.patch({
   
       /**
       * The membership to update, and the updated role.
       *
       * Replace SPACE with a space name.
       * Obtain the space name from the spaces resource of Chat API,
       * or from a space's URL.
       *
       * Replace MEMBERSHIP with a membership name.
       * Obtain the membership name from the membership of Chat API.
       */
       name: 'spaces/SPACE/members/MEMBERSHIP',
       updateMask: 'role',
       requestBody: {
         role: 'ROLE_MANAGER'
       }
     });
   }
   
   /**
   * Use the service endpoint to call Chat API.
   */
   updateSpace().then(console.log);
   

3. В коде замените следующее:

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

   • MEMBERSHIP : имя участника, которое можно получить с помощью метода spaces.members.list в Chat API.

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

   python3 chat_membership_update.js
   

Скрипт приложений

В этом примере API чата вызывается с помощью Advanced Chat Service .

1. Добавьте область авторизации chat.memberships в файл appsscript.json проекта Apps Script:

   "oauthScopes": [
     "https://www.googleapis.com/auth/chat.memberships"
   ]
   

2. Добавьте такую ​​функцию в код проекта Apps Script:

   /**
    * Updates a membership from space member to space manager.
    * @param {string} memberName The resource name of the membership.
   */
   function updateMembershipToSpaceManager(memberName) {
     try {
       const body = {'role': 'ROLE_MANAGER'};
       Chat.Spaces.Members.patch(memberName, body);
     } catch (err) {
       // TODO (developer) - Handle exception
       console.log('Failed to create message with error %s', err.message);
     }
   }
   

API Google Chat изменяет указанное членство на менеджера пространства и возвращает экземпляр Membership с подробным описанием изменения.

Сделайте менеджера пространства постоянным участником

В следующем примере менеджер пространства становится обычным участником пространства, указав role как ROLE_MEMBER в body , которое указывает обновленные атрибуты членства:

Питон

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

2. Включите следующий код chat_membership_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.memberships"]
   
   def main():
       '''
       Authenticates with Chat API via user credentials,
       then updates a specified space member to change
       it from a regular member to a space manager.
       '''
   
       # 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().members().patch(
   
           # The membership to update, and the updated role.
           #
           # Replace SPACE with a space name.
           # Obtain the space name from the spaces resource of Chat API,
           # or from a space's URL.
           #
           # Replace MEMBERSHIP with a membership name.
           # Obtain the membership name from the membership of Chat API.
           name='spaces/SPACE/members/MEMBERSHIP',
           updateMask='role',
           body={'role': 'ROLE_MEMBER'}
   
         ).execute()
   
       # Prints details about the updated membership.
       print(result)
   
   if __name__ == '__main__':
       main()
   

3. В коде замените следующее:

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

   • MEMBERSHIP : имя участника, которое можно получить с помощью метода spaces.members.list в Chat API.

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

   python3 chat_membership_update.py
   

Node.js

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

2. Включите следующий код chat_membership_update.js :

   const chat = require('@googleapis/chat');
   const {authenticate} = require('@google-cloud/local-auth');
   
   /**
   * Updates a membership in a Chat space to change it from
   * a space manager to a space member.
   * @return {!Promise<!Object>}
   */
   async function updateSpace() {
   
     /**
     * Authenticate with Google Workspace
     * and get user authorization.
     */
     const scopes = [
       'https://www.googleapis.com/auth/chat.memberships',
     ];
   
     const authClient =
         await authenticate({scopes, keyfilePath: 'client_secrets.json'});
   
     /**
     * Build a service endpoint for Chat API.
     */
     const chatClient = await chat.chat({version: 'v1', auth: authClient});
   
     /**
     * Use the service endpoint to call Chat API.
     */
     return await chatClient.spaces.patch({
   
       /**
       * The membership to update, and the updated role.
       *
       * Replace SPACE with a space name.
       * Obtain the space name from the spaces resource of Chat API,
       * or from a space's URL.
       *
       * Replace MEMBERSHIP with a membership name.
       * Obtain the membership name from the membership of Chat API.
       */
       name: 'spaces/SPACE/members/MEMBERSHIP',
       updateMask: 'role',
       requestBody: {
         role: 'ROLE_MEMBER'
       }
     });
   }
   
   /**
   * Use the service endpoint to call Chat API.
   */
   updateSpace().then(console.log);
   

3. В коде замените следующее:

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

   • MEMBERSHIP : имя участника, которое можно получить с помощью метода spaces.members.list в Chat API.

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

   python3 chat_membership_update.js
   

Скрипт приложений

В этом примере API чата вызывается с помощью Advanced Chat Service .

1. Добавьте область авторизации chat.memberships в файл appsscript.json проекта Apps Script:

   "oauthScopes": [
     "https://www.googleapis.com/auth/chat.memberships"
   ]
   

2. Добавьте такую ​​функцию в код проекта Apps Script:

   /**
    * Updates a membership from space manager to space member.
    * @param {string} memberName The resource name of the membership.
   */
   function updateMembershipToSpaceMember(memberName) {
     try {
       const body = {'role': 'ROLE_MEMBER'};
       Chat.Spaces.Members.patch(memberName, body);
     } catch (err) {
       // TODO (developer) - Handle exception
       console.log('Failed to create message with error %s', err.message);
     }
   }
   

API Google Chat изменяет указанное членство на менеджера пространства и возвращает экземпляр Membership с подробным описанием изменения.

похожие темы

• Пригласите или добавьте пользователя или приложение Google Chat в пространство .
• Получите подробную информацию о членстве пользователя или приложения Chat .
• Список участников в пространстве .
• Удаление пользователя или приложения Chat из пространства .