В этом руководстве объясняется, как использовать метод update()
ресурса Membership
API Google Chat для изменения атрибутов членства, например изменения члена пространства на менеджера пространства или изменения менеджера пространства на участника пространства.
Если вы администратор Google Workspace, вы можете вызвать метод update()
, чтобы обновить членство любого пространства в вашей организации Google Workspace.
Ресурс Membership
указывает, приглашен ли пользователь или приложение Google Chat в пространство, участвует в нем или отсутствует в нем.
Предварительные условия
Node.js
- Аккаунт Google Workspace для бизнеса или предприятия с доступом к Google Chat .
- Настройте свою среду:
- Создайте проект Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat , указав имя, значок и описание для вашего приложения Chat.
- Установите облачную клиентскую библиотеку Node.js.
- Создайте учетные данные доступа в зависимости от того, как вы хотите пройти аутентификацию в запросе к API Google Chat:
- Чтобы пройти аутентификацию в качестве пользователя Chat, создайте учетные данные идентификатора клиента OAuth и сохраните их в виде файла JSON с именем
client_secrets.json
в локальном каталоге. - Чтобы пройти аутентификацию в качестве приложения Chat, создайте учетные данные сервисной учетной записи и сохраните их в виде файла JSON с именем
credentials.json
.
- Чтобы пройти аутентификацию в качестве пользователя Chat, создайте учетные данные идентификатора клиента OAuth и сохраните их в виде файла JSON с именем
- Выберите область авторизации в зависимости от того, хотите ли вы пройти аутентификацию как пользователь или приложение Chat.
Обновить членство
Чтобы обновить членство в пространстве, передайте в запросе следующее:
- Укажите область авторизации:
- При аутентификации пользователя укажите область
chat.memberships
. - При использовании аутентификации приложения (доступной в Developer Preview ) укажите область
chat.app.memberships
. При обновлении членства с помощью аутентификации приложения вы можете обновлять членство только в пространствах, созданных приложениями чата. Для аутентификации приложения требуется однократное одобрение администратора .
- При аутентификации пользователя укажите область
- Вызовите метод
UpdateMembership()
. - Передайте
membership
как экземплярMembership
со следующим:- В поле
name
указано членство, которое необходимо обновить, включая идентификатор пространства и идентификатор участника. - Поля членства, которые необходимо обновить, имеют новые значения.
- В поле
- Передайте
updateMask
, чтобы указать обновляемые аспекты членства. Он включает в себя следующее:-
role
: роль пользователя в пространстве чата, которая определяет его разрешенные действия в пространстве. Возможные значения:-
ROLE_MEMBER
: член пространства. У пользователя есть базовые разрешения, такие как отправка сообщений в пространство. В беседах 1:1 и неназванных групповых беседах эта роль есть у каждого. -
ROLE_MANAGER
: менеджер пространства. Пользователь имеет все основные разрешения, а также административные разрешения, которые позволяют ему управлять пространством, например добавлять или удалять участников. Поддерживается только в пространствах, гдеspaceType
—SPACE
(именованные пространства).
-
-
Сделать обычного участника пространства менеджером пространства в качестве пользователя.
В следующем примере вызывается Chat API с использованием аутентификации пользователя , чтобы сделать обычного участника пространства менеджером пространства, указав role
ROLE_MANAGER
:
Node.js
Чтобы запустить образец, замените следующее:
-
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
Чтобы запустить образец, замените следующее:
-
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 вашего приложения и выполните следующие действия:
- В консоли Google Cloud выберите > API и службы > Учетные данные .
- Нажмите Создать учетные данные > Ключ API .
- Отобразится ваш новый ключ API.
- Нажмите «Копировать , чтобы скопировать ключ API для использования в коде вашего приложения. Ключ API также можно найти в разделе «Ключи API» учетных данных вашего проекта.
- Нажмите «Ограничить ключ» , чтобы обновить дополнительные настройки и ограничить использование вашего ключа API. Дополнительные сведения см. в разделе «Применение ограничений ключей API» .
Напишите скрипт, вызывающий API чата.
В следующем примере вызывается API Chat с использованием проверки подлинности приложения , чтобы сделать обычного участника пространства менеджером пространства, указав role
ROLE_MANAGER
в body
, которое указывает обновленные атрибуты членства:
Питон
- В своем рабочем каталоге создайте файл с
chat_membership_update_to_manager_app.py
. Включите следующий код в
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()
В коде замените следующее:
API_KEY
: ключ API, который вы создали для создания конечной точки службы для Chat API.SPACE
: имя пространства, которое можно получить с помощью методаspaces.list
в Chat API или из URL-адреса пространства.MEMBERSHIP
: имя участника, которое можно получить с помощью методаspaces.members.list
в Chat API.
В своем рабочем каталоге соберите и запустите пример:
python3 chat_membership_update_to_manager_app.py
Сделайте менеджера пространства постоянным участником с помощью приложения чата.
Для аутентификации приложения требуется однократное одобрение администратора .
Создайте ключ API
Чтобы вызвать метод API Developer Preview, необходимо использовать закрытую предварительную версию документа обнаружения API для разработчиков. Для аутентификации запроса необходимо передать ключ API.
Чтобы создать ключ API, откройте проект Google Cloud вашего приложения и выполните следующие действия:
- В консоли Google Cloud выберите > API и службы > Учетные данные .
- Нажмите Создать учетные данные > Ключ API .
- Отобразится ваш новый ключ API.
- Нажмите «Копировать , чтобы скопировать ключ API для использования в коде вашего приложения. Ключ API также можно найти в разделе «Ключи API» учетных данных вашего проекта.
- Нажмите «Ограничить ключ» , чтобы обновить дополнительные настройки и ограничить использование вашего ключа API. Дополнительные сведения см. в разделе «Применение ограничений ключей API» .
Напишите скрипт, вызывающий API чата.
В следующем примере вызывается API Chat с использованием аутентификации приложения , чтобы сделать менеджера пространства обычным участником пространства, указав role
как ROLE_MEMBER
в body
, которое указывает обновленные атрибуты членства:
Питон
- В своем рабочем каталоге создайте файл с
chat_membership_update_to_member_app.py
. Включите следующий код в
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()
В коде замените следующее:
API_KEY
: ключ API, который вы создали для создания конечной точки службы для Chat API.SPACE
: имя пространства, которое можно получить с помощью методаspaces.list
в Chat API или из URL-адреса пространства.MEMBERSHIP
: имя участника, которое можно получить с помощью методаspaces.members.list
в Chat API.
В своем рабочем каталоге соберите и запустите пример:
python3 chat_membership_update_to_member_app.py
Обновите членство в качестве администратора Google Workspace
Если вы администратор Google Workspace, вы можете вызвать метод update()
, чтобы обновить членство в любом пространстве в вашей организации Google Workspace.
Чтобы вызвать этот метод от имени администратора Google Workspace, выполните следующие действия:
- Вызовите метод, используя аутентификацию пользователя, и укажите область авторизации , которая поддерживает вызов метода с правами администратора .
- В своем запросе укажите для параметра запроса
useAdminAccess
значениеtrue
.
Дополнительную информацию и примеры см. в разделе «Управление пространствами Google Chat от имени администратора Google Workspace» .
Связанные темы
- Пригласите или добавьте пользователя или приложение Google Chat в пространство .
- Получите подробную информацию о членстве пользователя или приложения Chat .
- Список участников в пространстве .
- Удаление пользователя или приложения Chat из пространства .