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

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

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

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

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

Node.js

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

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

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

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

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

Node.js

чат/клиент-библиотеки/облако/обновление-членство-пользователь-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() или из тела ответа, возвращаемого после асинхронного создания членства с помощью Chat API.
  • ROLE_NAME : обновленная роль ROLE_MANAGER .

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

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

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

Node.js

чат/клиент-библиотеки/облако/обновление-членство-пользователь-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() или из тела ответа, возвращаемого после асинхронного создания членства с помощью Chat API.
  • ROLE_NAME : обновленная роль ROLE_MEMBER .

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

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

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

Создайте ключ API

Чтобы вызвать метод API Developer Preview, необходимо использовать закрытую предварительную версию документа обнаружения API для разработчиков. Для аутентификации запроса необходимо передать ключ API.

Чтобы создать ключ API, откройте проект Google Cloud вашего приложения и выполните следующие действия:

  1. В консоли Google Cloud выберите > API и службы > Учетные данные .

    Перейти к учетным данным

  2. Нажмите Создать учетные данные > Ключ API .
  3. Отобразится ваш новый ключ API.
    • Нажмите «Копировать , чтобы скопировать ключ API для использования в коде вашего приложения. Ключ API также можно найти в разделе «Ключи API» учетных данных вашего проекта.
    • Нажмите «Ограничить ключ» , чтобы обновить дополнительные настройки и ограничить использование вашего ключа API. Дополнительные сведения см. в разделе «Применение ограничений ключей API» .

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

В следующем примере вызывается API Chat с использованием проверки подлинности приложения , чтобы сделать обычного участника пространства менеджером пространства, указав 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, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY')

    # 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. В коде замените следующее:

    • API_KEY : ключ API, который вы создали для создания конечной точки службы для Chat API.

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

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

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

    python3 chat_membership_update_to_manager_app.py

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

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

Создайте ключ API

Чтобы вызвать метод API Developer Preview, необходимо использовать закрытую предварительную версию документа обнаружения API для разработчиков. Для аутентификации запроса необходимо передать ключ API.

Чтобы создать ключ API, откройте проект Google Cloud вашего приложения и выполните следующие действия:

  1. В консоли Google Cloud выберите > API и службы > Учетные данные .

    Перейти к учетным данным

  2. Нажмите Создать учетные данные > Ключ API .
  3. Отобразится ваш новый ключ API.
    • Нажмите «Копировать , чтобы скопировать ключ API для использования в коде вашего приложения. Ключ API также можно найти в разделе «Ключи API» учетных данных вашего проекта.
    • Нажмите «Ограничить ключ» , чтобы обновить дополнительные настройки и ограничить использование вашего ключа API. Дополнительные сведения см. в разделе «Применение ограничений ключей API» .

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

В следующем примере вызывается API Chat с использованием аутентификации приложения , чтобы сделать менеджера пространства обычным участником пространства, указав 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, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY')

    # 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. В коде замените следующее:

    • API_KEY : ключ API, который вы создали для создания конечной точки службы для Chat API.

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

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

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

    python3 chat_membership_update_to_member_app.py

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

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

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

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