Z tego przewodnika dowiesz się, jak używać metody patch
w zasobie Message
interfejsu Google Chat API do aktualizowania wiadomości tekstowej lub karty w pokoju. Zaktualizuj wiadomość, aby zmienić jej atrybuty, np. jej treść lub zawartość karty. Możesz też dołączyć SMS-a do wiadomości
na karcie lub dodać kartę do SMS-a.
Interfejs Chat API obsługuje też metodę update
, ale zdecydowanie zalecamy wywoływanie metody patch
, ponieważ korzysta ona z żądania HTTP PATCH
, a update
używa żądania HTTP PUT
. Więcej informacji znajdziesz w sekcji dotyczącej znaczników PATCH
i PUT
w AIP-134.
Zasób Message
reprezentuje wiadomość w Google Chat lub tekst lub kartę. Możesz
create
, get
, update
lub delete
wysłać wiadomość w Google Chat API, wywołując odpowiednie metody. Więcej informacji o SMS-ach i kartach znajdziesz w artykule Omówienie wiadomości w Google Chat.
Wymagania wstępne
Python
- Python 3.6 lub nowszy
- Narzędzie do zarządzania pakietami pip
Najnowsze biblioteki klienta Google dla języka Python. Aby je zainstalować lub zaktualizować, uruchom w interfejsie wiersza poleceń to polecenie:
pip3 install --upgrade google-api-python-client google-auth-oauthlib google-auth
- Projekt Google Cloud z włączonym i skonfigurowanym interfejsem Google Chat API. Instrukcje znajdziesz w artykule Tworzenie aplikacji Google Chat.
Autoryzacja skonfigurowana dla aplikacji Google Chat:
- Aktualizowanie SMS-a obsługuje obie te metody uwierzytelniania:
- Uwierzytelnianie użytkowników z zakresem autoryzacji
chat.messages
może aktualizować wiadomości utworzone przez tego użytkownika. - Uwierzytelnianie aplikacji z użyciem zakresu autoryzacji
chat.bot
może aktualizować wiadomości utworzone przez tę aplikację.
- Uwierzytelnianie użytkowników z zakresem autoryzacji
- Aktualizacja wiadomości karty wymaga uwierzytelniania aplikacji z użyciem zakresu autoryzacji
chat.bot
.
- Aktualizowanie SMS-a obsługuje obie te metody uwierzytelniania:
Zaktualizuj SMS-a lub dołącz SMS-a na początku wiadomości na karcie z uwierzytelnianiem użytkownika
Aby zaktualizować wiadomość tekstową z użyciem uwierzytelniania użytkownika, przekaż w żądaniu te informacje:
- Zakres autoryzacji
chat.messages
. name
wiadomości do aktualizacji.updateMask='text'
body
, który określa zaktualizowaną wiadomość.
Jeśli zaktualizowana wiadomość jest kartą, SMS zostanie dołączony do wiadomości na karcie (która będzie się nadal wyświetlać).
Aby zaktualizować SMS-a lub dodać SMS-a na karcie za pomocą uwierzytelniania użytkownika:
Python
- W katalogu roboczym utwórz plik o nazwie
chat_update_text_message_user.py
. Umieść ten kod w elemencie
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()
Zastąp w nim ten fragment kodu:
SPACE
: nazwa pokoju, którą możesz uzyskać za pomocą metodyspaces.list
w interfejsie Chat API lub z adresu URL pokoju.MESSAGE
: nazwa wiadomości, którą można uzyskać z treści odpowiedzi zwróconej po asynchronicznym utworzeniu wiadomości za pomocą interfejsu Chat API lub z niestandardową nazwą przypisaną do wiadomości w momencie jej utworzenia.
W katalogu roboczym skompiluj i uruchom przykład:
python3 chat_update_text_message_user.py
Zaktualizuj SMS-a lub dołącz SMS-a na początku wiadomości na karcie za pomocą uwierzytelniania w aplikacji
Aby zaktualizować SMS-a przez uwierzytelnienie aplikacji, przekaż w żądaniu ten kod:
- Zakres autoryzacji
chat.bot
. name
wiadomości do aktualizacji.updateMask='text'
body
, który określa zaktualizowaną wiadomość.
Jeśli zaktualizowana wiadomość to wiadomość na karcie, jest ona dołączana na początku do wiadomości na karcie (którą nadal się wyświetla).
Jak zaktualizować SMS-a jako SMS-a lub dodać SMS-a na początku wiadomości na karcie i włączyć uwierzytelnianie aplikacji:
Python
- W katalogu roboczym utwórz plik o nazwie
chat_update_text_message_app.py
. Umieść ten kod w elemencie
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)
Zastąp w nim ten fragment kodu:
SPACE
: nazwa pokoju, którą możesz uzyskać za pomocą metodyspaces.list
w interfejsie Chat API lub z adresu URL pokoju.MESSAGE
: nazwa wiadomości, którą można uzyskać z treści odpowiedzi zwróconej po asynchronicznym utworzeniu wiadomości za pomocą interfejsu Chat API lub z niestandardową nazwą przypisaną do wiadomości w momencie jej utworzenia.
W katalogu roboczym skompiluj i uruchom przykład:
python3 chat_update_text_message_app.py
Zaktualizuj wiadomość na karcie lub dołącz wiadomość na karcie do SMS-a
Aby zaktualizować wiadomość na karcie, podaj w prośbie:
- Zakres autoryzacji
chat.bot
. Zaktualizowanie wiadomości na karcie wymaga uwierzytelniania aplikacji. name
wiadomości do aktualizacji.updateMask='cardsV2'
body
, który określa zaktualizowaną wiadomość.
Jeśli zaktualizowana wiadomość jest SMS-em, do wiadomości zostanie dodana karta (która będzie się nadal wyświetlać). Jeśli zaktualizowana wiadomość jest kartą, wyświetlana karta zostanie zaktualizowana.
Aby zmienić wiadomość w wiadomość na karcie:
Python
- W katalogu roboczym utwórz plik o nazwie
chat_update_card_message.py
. Umieść ten kod w elemencie
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)
Zastąp w nim ten fragment kodu:
SPACE
: nazwa pokoju, którą możesz uzyskać za pomocą metodyspaces.list
w interfejsie Chat API lub z adresu URL pokoju.MESSAGE
: nazwa wiadomości, którą można uzyskać z treści odpowiedzi zwróconej po asynchronicznym utworzeniu wiadomości za pomocą interfejsu Chat API lub z niestandardową nazwą przypisaną do wiadomości w momencie jej utworzenia.
W katalogu roboczym skompiluj i uruchom przykład:
python3 chat_update_card_message.py
Interfejs Chat API zwraca wystąpienie Message
zawierające szczegóły zaktualizowanej wiadomości.
Aktualizowanie wiadomości z użyciem wielu ścieżek pól jednocześnie
Po zaktualizowaniu wiadomości możesz jednocześnie zaktualizować wiele ścieżek pól wiadomości. Na przykład w prośbie o aktualizację wiadomości możesz podać jednoczesną zmianę ścieżek pól text
i cardsv2
, co spowoduje zaktualizowanie zarówno tekstu, jak i karty. Jeśli wiadomość zawiera tylko tekst, ale nie zawiera karty, do wiadomości zostanie dodana karta. Więcej informacji o obsługiwanych ścieżkach pól znajdziesz w artykule o parametrach updateMask
.
Aby zaktualizować text
i card
wiadomości z funkcją uwierzytelniania użytkownika, przekaż w żądaniu to polecenie:
- Zakres autoryzacji
chat.messages
. name
wiadomości do aktualizacji.Element
updateMask
określający rozdzielone przecinkami ścieżki pól wiadomości do zaktualizowania:updateMask='text', 'cardsV2'
.body
, który określa zaktualizowaną wiadomość, w tym wszystkie zaktualizowane ścieżki pól.
Aby zaktualizować ścieżki pól text
i cardsV2
w wiadomości za pomocą uwierzytelniania użytkownika:
Python
- W katalogu roboczym utwórz plik o nazwie
chat_update_text_message_user.py
. Umieść ten kod w elemencie
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()
Zastąp w nim ten fragment kodu:
SPACE
: nazwa pokoju, którą możesz uzyskać za pomocą metodyspaces.list
w interfejsie Chat API lub z adresu URL pokoju.MESSAGE
: nazwa wiadomości, którą można uzyskać z treści odpowiedzi zwróconej po asynchronicznym utworzeniu wiadomości za pomocą interfejsu Chat API lub z niestandardową nazwą przypisaną do wiadomości w momencie jej utworzenia.
W katalogu roboczym skompiluj i uruchom przykład:
python3 chat_update_text_message_user.py
Powiązane artykuły
- Formatowanie wiadomości
- Usuwanie wiadomości
- Sprawdzanie szczegółów wiadomości
- Wyświetlanie listy wiadomości w pokoju
- Wyślij wiadomość.