В этом руководстве объясняется, как использовать метод patch
в ресурсе Message
API Google Chat для обновления текстового сообщения или сообщения-карточки в пространстве. Обновите сообщение, чтобы изменить атрибуты сообщения, например, его содержание или содержимое карточки. Вы также можете добавить текстовое сообщение к сообщению с карточкой или добавить карточку к текстовому сообщению.
Chat API также поддерживает метод update
, но мы настоятельно рекомендуем вызывать метод patch
, поскольку он использует HTTP-запрос PATCH
, а update
использует HTTP-запрос PUT
. Дополнительную информацию см. в разделе PATCH
и PUT
AIP-134 .
В API чата сообщение чата представлено ресурсом Message
. Хотя пользователи чата могут отправлять только текстовые сообщения, приложения чата могут использовать множество других функций обмена сообщениями, включая отображение статических или интерактивных пользовательских интерфейсов, сбор информации от пользователей и частную доставку сообщений. Дополнительную информацию о функциях обмена сообщениями, доступных для Chat API, см. в обзоре сообщений Google 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.
Обновите текстовое сообщение или добавьте текстовое сообщение к сообщению карты с аутентификацией пользователя.
Чтобы обновить текстовое сообщение с аутентификацией пользователя , передайте в запросе следующее:
- Область авторизации
chat.messages
. -
name
сообщения, которое необходимо обновить. -
updateMask='text'
-
body
, определяющее обновленное сообщение.
Если обновленное сообщение представляет собой сообщение с карточкой , то текстовое сообщение добавляется к сообщению с карточкой (которое продолжает отображаться).
Вот как обновить текстовое сообщение или добавить текстовое сообщение к сообщению карты с аутентификацией пользователя :
Питон
- В своем рабочем каталоге создайте файл с
chat_update_text_message_user.py
. Включите следующий код в
chat_update_text_message_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"] def main(): ''' Authenticates with Chat API via user credentials, then updates 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) # Update a Chat message. result = chat.spaces().messages().patch( # The message to update, and the updated message. # # 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', updateMask='text', body={'text': 'Updated message!'} ).execute() # Prints details about the updated message. print(result) if __name__ == '__main__': main()
В коде замените следующее:
-
SPACE
: имя пространства, которое можно получить с помощью методаspaces.list
в Chat API или из URL-адреса пространства. -
MESSAGE
: имя сообщения, которое вы можете получить из тела ответа, возвращенного после асинхронного создания сообщения с помощью Chat API, или с помощью пользовательского имени , назначенного сообщению при создании.
-
В своем рабочем каталоге соберите и запустите пример:
python3 chat_update_text_message_user.py
Обновите текстовое сообщение или добавьте текстовое сообщение к сообщению карты с помощью аутентификации приложения.
Чтобы обновить текстовое сообщение с помощью аутентификации приложения , передайте в запросе следующее:
- Область авторизации
chat.bot
. -
name
сообщения, которое необходимо обновить. -
updateMask='text'
-
body
, определяющее обновленное сообщение.
Если обновленное сообщение представляет собой сообщение с карточкой , то текстовое сообщение добавляется к сообщению с карточкой (которое продолжает отображаться).
Вот как можно преобразовать текстовое сообщение в текстовое сообщение или добавить текстовое сообщение к сообщению с картой с помощью аутентификации приложения :
Питон
- В своем рабочем каталоге создайте файл с
chat_update_text_message_app.py
. Включите следующий код в
chat_update_text_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) # Update a Chat message. result = chat.spaces().messages().patch( # The message to update, and the updated message. # # 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', updateMask='text', body={'text': 'Updated message!'} ).execute() # Print Chat API's response in your command line interface. print(result)
В коде замените следующее:
-
SPACE
: имя пространства, которое можно получить с помощью методаspaces.list
в Chat API или из URL-адреса пространства. -
MESSAGE
: имя сообщения, которое вы можете получить из тела ответа, возвращенного после асинхронного создания сообщения с помощью Chat API, или с помощью пользовательского имени , назначенного сообщению при создании.
-
В своем рабочем каталоге соберите и запустите пример:
python3 chat_update_text_message_app.py
Обновите сообщение с карточкой или добавьте сообщение с картой в текстовое сообщение.
Чтобы обновить сообщение карты , передайте в запросе следующее:
- Область авторизации
chat.bot
. Обновление сообщения карты требует аутентификации в приложении . -
name
сообщения, которое необходимо обновить. -
updateMask='cardsV2'
-
body
, определяющее обновленное сообщение.
Если обновленное сообщение является текстовым сообщением , к текстовому сообщению добавляется карточка (которая продолжает отображаться). Если обновленное сообщение само по себе является карточкой , то отображаемая карточка обновляется.
Вот как можно обновить сообщение до сообщения карты :
Питон
- В своем рабочем каталоге создайте файл с
chat_update_card_message.py
. Включите следующий код
chat_update_card_message.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) # Update a Chat message. result = chat.spaces().messages().patch( # The message to update, and the updated message. # # 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', updateMask='cardsV2', body= { 'cardsV2': [{ 'cardId': 'updateCardMessage', 'card': { 'header': { 'title': 'An Updated Card Message!', 'subtitle': 'Updated with Chat REST API', 'imageUrl': 'https://developers.google.com/chat/images/chat-product-icon.png', 'imageType': 'CIRCLE' }, 'sections': [ { 'widgets': [ { 'buttonList': { 'buttons': [ { 'text': 'Read the docs!', 'onClick': { 'openLink': { 'url': 'https://developers.google.com/chat' } } } ] } } ] } ] } }] } ).execute() # Print Chat API's response in your command line interface. print(result)
В коде замените следующее:
SPACE
: имя пространства, которое можно получить с помощью методаspaces.list
в Chat API или из URL-адреса пространства.MESSAGE
: имя сообщения, которое вы можете получить из тела ответа, возвращенного после асинхронного создания сообщения с помощью Chat API, или с помощью пользовательского имени , назначенного сообщению при создании.
В своем рабочем каталоге соберите и запустите пример:
python3 chat_update_card_message.py
API чата возвращает экземпляр Message
с подробным описанием обновленного сообщения.
Обновление сообщения с несколькими путями к полям одновременно
При обновлении сообщения вы можете одновременно обновить несколько путей к полям сообщения. Например, в запросе на обновление сообщения вы можете одновременно указать изменение путей к полям text
и cardsv2
, что приведет к обновлению как текста сообщения, так и карточки. Если сообщение содержит только текст и не содержит карточки, к сообщению добавляется карточка. Дополнительные сведения о поддерживаемых путях к полям см. в разделе Параметры updateMask
.
Чтобы обновить text
и card
сообщения с аутентификацией пользователя , передайте в своем запросе следующее:
- Область авторизации
chat.messages
. -
name
сообщения, которое необходимо обновить. updateMask
, указывающий пути к полям сообщений для обновления, разделенные запятыми:updateMask='text', 'cardsV2'
.body
, определяющее обновленное сообщение, включая все обновленные пути к полям.
Вот как обновить пути к полям text
и cardsV2
в сообщении с аутентификацией пользователя :
Питон
- В своем рабочем каталоге создайте файл с
chat_update_text_message_user.py
. Включите следующий код в
chat_update_text_message_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"] def main(): ''' Authenticates with Chat API via user credentials, then updates 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) # Update a Chat message. result = chat.spaces().messages().patch( # The message to update, and the updated message. # # 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', updateMask='text,cardsV2', body= {'text': 'Updated message!', 'cardsV2': [{ 'cardId': 'updateCardMessage', 'card': { 'header': { 'title': 'An Updated Card Message!', 'subtitle': 'Updated with Chat REST API', 'imageUrl': 'https://developers.google.com/chat/images/chat-product-icon.png', 'imageType': 'CIRCLE' }, 'sections': [ { 'widgets': [ { 'buttonList': { 'buttons': [ { 'text': 'Read the docs!', 'onClick': { 'openLink': { 'url': 'https://developers.google.com/chat' } } } ] } } ] } ] } }] } ).execute() # Prints details about the updated message. print(result) if __name__ == '__main__': main()
В коде замените следующее:
-
SPACE
: имя пространства, которое можно получить с помощью методаspaces.list
в Chat API или из URL-адреса пространства. -
MESSAGE
: имя сообщения, которое вы можете получить из тела ответа, возвращенного после асинхронного создания сообщения с помощью Chat API, или с помощью пользовательского имени , назначенного сообщению при создании.
-
В своем рабочем каталоге соберите и запустите пример:
python3 chat_update_text_message_user.py
Связанные темы
- Отформатируйте сообщение .
- Удалить сообщение .
- Получите подробную информацию о сообщении .
- Список сообщений в пространстве .
- Отправить сообщение .