В этом руководстве объясняется, как использовать метод get
ресурса Message
API Google Chat для возврата сведений о текстовом сообщении или сообщении на карточке.
В API чата сообщение чата представлено ресурсом Message
. Хотя пользователи чата могут отправлять только текстовые сообщения, приложения чата могут использовать множество других функций обмена сообщениями, включая отображение статических или интерактивных пользовательских интерфейсов, сбор информации от пользователей и частную доставку сообщений. Дополнительную информацию о функциях обмена сообщениями, доступных для Chat API, см. в обзоре сообщений Google Chat .
Предварительные условия
Питон
- Аккаунт Google Workspace для бизнеса или предприятия с доступом к Google Chat .
- Настройте свою среду:
- Создайте проект Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat, указав имя, значок и описание для вашего приложения Chat.
- Установите клиентскую библиотеку Python Google API .
- Создайте учетные данные доступа в зависимости от того, как вы хотите пройти аутентификацию в запросе к API Google Chat:
- Чтобы пройти аутентификацию в качестве пользователя Chat, создайте учетные данные идентификатора клиента OAuth и сохраните их в виде файла JSON с именем
client_secrets.json
в локальном каталоге. - Чтобы пройти аутентификацию в качестве приложения Chat, создайте учетные данные учетной записи службы и сохраните их в виде файла JSON с именем
credentials.json
.
- Чтобы пройти аутентификацию в качестве пользователя Chat, создайте учетные данные идентификатора клиента OAuth и сохраните их в виде файла JSON с именем
- Выберите область авторизации в зависимости от того, хотите ли вы пройти аутентификацию как пользователь или приложение Chat.
Получить сообщение с аутентификацией пользователя
Чтобы получить подробную информацию о сообщении с аутентификацией пользователя , передайте в запросе следующее:
- Укажите область авторизацииchat.messages.readonly
chat.messages.readonly
chat.messages
- Вызовите метод
get
ресурсаMessage
. - Задайте
name
как имя ресурса сообщения, которое нужно получить.
В следующем примере возвращается сообщение с аутентификацией пользователя :
Питон
- В своем рабочем каталоге создайте файл с
chat_message_get_user.py
. Включите следующий код в
chat_message_get_user.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.messages.readonly"] def main(): ''' Authenticates with Chat API via user credentials, then gets a message. ''' # 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().messages().get( # The message 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 MESSAGE with a message name. # Obtain the message name from the response body returned # after creating a message asynchronously with Chat REST API. name = 'spaces/SPACE/messages/MESSAGE' ).execute() # Prints details about the message. print(result) if __name__ == '__main__': main()
В коде замените следующее:
-
SPACE
: имя пространства, которое можно получить с помощью методаspaces.list
в Chat API или из URL-адреса пространства. -
MESSAGE
: имя сообщения, которое вы можете получить из тела ответа, возвращенного после асинхронного создания сообщения с помощью Chat API, или с помощью пользовательского имени , назначенного сообщению при создании.
-
В своем рабочем каталоге соберите и запустите пример:
python3 chat_message_get_user.py
API чата возвращает экземпляр Message
с подробным описанием указанного сообщения.
Получить сообщение с аутентификацией приложения
Чтобы получить подробную информацию о сообщении с аутентификацией приложения , передайте в запросе следующее:
- Укажите область авторизации
chat.bot
. - Вызовите метод
get
ресурсаMessage
. - Задайте
name
как имя ресурса сообщения, которое нужно получить.
В следующем примере возвращается сообщение с аутентификацией приложения :
Питон
- В своем рабочем каталоге создайте файл с
chat_get_message_app.py
. Включите следующий код в
chat_get_message_app.py
:from google.oauth2 import service_account from apiclient.discovery import build # Specify required scopes. SCOPES = ['https://www.googleapis.com/auth/chat.bot'] # Specify service account details. CREDENTIALS = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build the URI and authenticate with the service account. chat = build('chat', 'v1', credentials=CREDENTIALS) # Get a Chat message. result = chat.spaces().messages().get( # The message 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 MESSAGE with a message name. # Obtain the message name from the response body returned # after creating a message asynchronously with Chat REST API. name='spaces/SPACE/messages/MESSAGE' ).execute() # Print Chat API's response in your command line interface. print(result)
В коде замените следующее:
SPACE
:name
пространства, в котором публикуется сообщение, которое можно получить с помощью методаspaces.list
в Chat API или из URL-адреса пространства.MESSAGE
: имя сообщения, которое вы можете получить из тела ответа, возвращенного после асинхронного создания сообщения с помощью Chat API, или с помощью пользовательского имени , назначенного сообщению при создании.
В своем рабочем каталоге соберите и запустите пример:
python3 chat_get_message_app.py
API чата возвращает экземпляр Message
с подробным описанием указанного сообщения.
Связанные темы
- Отформатируйте сообщение .
- Удалить сообщение .
- Список сообщений в пространстве .
- Обновить сообщение .
- Отправить сообщение .