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

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

Если вы являетесь администратором Google Workspace, вы можете вызвать метод update() , чтобы обновить членство в любом пространстве в вашей организации Google Workspace.

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

Предпосылки

Node.js

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

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

  • Укажите область полномочий:
  • Вызовите метод UpdateMembership() .
  • Передайте membership как пример Membership со следующим:
    • Поле name , в котором указывается обновляемое членство, которое включает идентификатор пространства и идентификатор участника.
    • Поля членства, которые необходимо обновить, задаются новыми значениями.
  • Передайте updateMask , чтобы указать аспекты членства, которые необходимо обновить. Он включает в себя следующее:
    • role : роль пользователя в чат-пространстве, определяющая его разрешённые действия в нём. Возможные значения:
      • ROLE_MEMBER : Участник чата. Пользователь имеет базовые разрешения, например, право отправлять сообщения в чат. В индивидуальных и неименованных групповых чатах эта роль есть у всех.
      • ROLE_MANAGER : Менеджер пространства. Пользователь имеет все основные разрешения, а также административные разрешения, позволяющие ему управлять пространством, например, добавлять или удалять участников. Поддерживается только в пространствах, где spaceType — SPACE (именованные пространства).

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

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

Node.js

chat/client-libraries/cloud/update-membership-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.memberships'];

// This sample shows how to update a membership with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    membership: {
      // Replace SPACE_NAME and MEMBER_NAME here
      name: 'spaces/SPACE_NAME/members/MEMBER_NAME',
      // Replace ROLE_NAME here with ROLE_MEMBER or ROLE_MANAGER
      role: 'ROLE_NAME'
    },
    updateMask: {
      // The field paths to update.
      paths: ['role']
    }
  };

  // Make the request
  const response = await chatClient.updateMembership(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

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

  • SPACE_NAME : идентификатор из name пространства. Идентификатор можно получить, вызвав метод ListSpaces() или указав URL пространства.
  • MEMBER_NAME : идентификатор из name участника. Идентификатор можно получить, вызвав метод ListMemberships() или из тела ответа, возвращаемого после асинхронного создания участника с помощью API чата.
  • ROLE_NAME : обновленная роль, ROLE_MANAGER .

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

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

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

Node.js

chat/client-libraries/cloud/update-membership-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.memberships'];

// This sample shows how to update a membership with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    membership: {
      // Replace SPACE_NAME and MEMBER_NAME here
      name: 'spaces/SPACE_NAME/members/MEMBER_NAME',
      // Replace ROLE_NAME here with ROLE_MEMBER or ROLE_MANAGER
      role: 'ROLE_NAME'
    },
    updateMask: {
      // The field paths to update.
      paths: ['role']
    }
  };

  // Make the request
  const response = await chatClient.updateMembership(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

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

  • SPACE_NAME : идентификатор из name пространства. Идентификатор можно получить, вызвав метод ListSpaces() или указав URL пространства.
  • MEMBER_NAME : идентификатор из name участника. Идентификатор можно получить, вызвав метод ListMemberships() или из тела ответа, возвращаемого после асинхронного создания участника с помощью API чата.
  • ROLE_NAME : обновленная роль, ROLE_MEMBER .

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

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

Аутентификация приложения требует однократного одобрения администратора .

Напишите скрипт, который вызывает API чата

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

Питон

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

  2. Включите следующий код в chat_membership_update_to_manager_app.py :

    from google.oauth2 import service_account
from apiclient.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.app.memberships"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then updates a specified space member to change
    it from a regular member to a space manager.
    '''

    # Specify service account details.
    creds = (
        service_account.Credentials.from_service_account_file('credentials.json')
        .with_scopes(SCOPES)
    )

    # 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 в API чата или из URL-адреса пространства.

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

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

    python3 chat_membership_update_to_manager_app.py

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

Аутентификация приложения требует однократного одобрения администратора .

Напишите скрипт, который вызывает API чата

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

Питон

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

  2. Включите следующий код в chat_membership_update_to_member_app.py :

    from google.oauth2 import service_account
from apiclient.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.app.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.
    '''

    # Specify service account details.
    creds = (
        service_account.Credentials.from_service_account_file('credentials.json')
        .with_scopes(SCOPES)
    )

    # 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 в API чата или из URL-адреса пространства.

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

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

    python3 chat_membership_update_to_member_app.py

Обновите членство как администратор Google Workspace

Если вы являетесь администратором Google Workspace, вы можете вызвать метод update() для обновления членства в любом пространстве в вашей организации Google Workspace.

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

Дополнительную информацию и примеры см. в статье Управление пространствами Google Chat в качестве администратора Google Workspace .