В этом руководстве объясняется, как использовать метод get
ресурса membership
API Google Chat, чтобы получить подробную информацию о членстве в пространстве.
Ресурс Membership
указывает, приглашен ли пользователь или приложение Google Chat в пространство, участвует в нем или отсутствует в нем.
Аутентификация с помощью аутентификации приложения позволяет приложению Chat получать членство в пространствах, к которым у него есть доступ в Google Chat (например, в пространствах, участником которых оно является), но исключает членство в приложении Chat, включая собственное. Аутентификация с проверкой подлинности пользователя возвращает членство в пространствах, к которым имеет доступ аутентифицированный пользователь.
Предварительные условия
Питон
- Аккаунт Google Workspace для бизнеса или предприятия с доступом к Google Chat .
- Настройте свою среду:
- Создайте проект Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat, указав имя, значок и описание для вашего приложения Chat.
- Создайте учетные данные доступа в зависимости от того, как вы хотите пройти аутентификацию в запросе к API Google Chat:
- Чтобы пройти аутентификацию в качестве пользователя Chat, создайте учетные данные идентификатора клиента OAuth и сохраните их в виде файла JSON с именем
client_secrets.json
в локальном каталоге. - Чтобы пройти аутентификацию в качестве приложения Chat, создайте учетные данные учетной записи службы и сохраните их в виде файла JSON с именем
credentials.json
.
- Чтобы пройти аутентификацию в качестве пользователя Chat, создайте учетные данные идентификатора клиента OAuth и сохраните их в виде файла JSON с именем
- Выберите область авторизации в зависимости от того, хотите ли вы пройти аутентификацию как пользователь или приложение Chat.
Получить подробную информацию о членстве
Чтобы получить подробную информацию о членстве в Google Chat, передайте в своем запросе следующее:
- При аутентификации приложения укажите область авторизации
chat.bot
. При аутентификации пользователя укажите областьchat.memberships.readonly
chat.memberships
. Рекомендуется выбирать наиболее ограничительную область, которая по-прежнему позволяет вашему приложению функционировать. - Вызовите метод
get
ресурсаmembership
. - Передайте
name
членства, которое нужно получить. Получите имя участника на ресурсе членства Google Chat.
Вот как получить членство с аутентификацией пользователя :
Питон
- В своем рабочем каталоге создайте файл с
chat_membership_get.py
. Включите следующий код
chat_membership_get.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.readonly"] def main(): ''' Authenticates with Chat API via user credentials, then gets details about a specified membership. ''' # 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().get( # The membership to get. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MEMBER with a membership name. # Obtain the membership name from the memberships resource of # Chat API. name='spaces/SPACE/members/MEMBER' ).execute() # Prints details about the membership. print(result) if __name__ == '__main__': main()
В коде замените следующее:
-
SPACE
: имя пространства, которое можно получить с помощью методаspaces.list
в Chat API или из URL-адреса пространства. -
MEMBER
: имя участника, которое можно получить с помощью методаspaces.members.list
в Chat API.
-
В своем рабочем каталоге соберите и запустите пример:
python3 chat_membership_get.py
API чата возвращает экземпляр membership
с подробным описанием указанного членства.
Связанные темы
- Список участников в пространстве .
- Пригласите или добавьте пользователя или приложение чата в пространство .
- Обновите членство пользователя в чате Google .
- Удаление пользователя или приложения Chat из пространства .