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, takie jak treść lub zawartość karty. Możesz też dołączyć SMS-a do karty informacyjnej 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
, podczas gdy update
używa żądania HTTP PUT
. Więcej informacji znajdziesz w sekcji na temat PATCH
i PUT
w AIP-134.
Zasób Message
reprezentuje tekst lub kartę w Google Chat. 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 do języka Python. Aby je zainstalować lub zaktualizować, uruchom w interfejsie wiersza poleceń to polecenie:
pip3 install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib oauth2client
Opublikowana aplikacja Google Chat. Aby utworzyć i opublikować aplikację do obsługi czatu, przeczytaj artykuł Tworzenie aplikacji Google Chat.
Autoryzacja skonfigurowana dla aplikacji do obsługi czatu:
- Aktualizacja wiadomości tekstowej obsługuje obie te metody uwierzytelniania:
- Uwierzytelnianie użytkownika z zakresem autoryzacji
chat.messages
może aktualizować wiadomości utworzone przez tego użytkownika. - Uwierzytelnianie aplikacji z zakresem autoryzacji
chat.bot
może aktualizować wiadomości utworzone przez tę aplikację.
- Uwierzytelnianie użytkownika z zakresem autoryzacji
- Aktualizacja wiadomości karty wymaga uwierzytelniania aplikacji z użyciem zakresu autoryzacji
chat.bot
.
- Aktualizacja wiadomości tekstowej obsługuje obie te metody uwierzytelniania:
Zaktualizować SMS-a lub dodać go na początku wiadomości na karcie z uwierzytelnianiem użytkownika
Aby zaktualizować wiadomość tekstową z uwierzytelnianiem użytkownika, przekaż w żądaniu te informacje:
- Zakres autoryzacji
chat.messages
. name
wiadomości do zaktualizowania.updateMask='text'
body
, który określa zaktualizowaną wiadomość.
Jeśli zaktualizowana wiadomość to wiadomość z kartą, pojawi się ona na początku wiadomości na karcie (która będzie się nadal wyświetlać).
Aby zaktualizować SMS-a lub dodać wiadomość na początku do wiadomości na karcie po uwierzytelnieniu użytkownika:
Python
- W katalogu roboczym utwórz plik o nazwie
chat_update_text_message_user.py
. Umieść ten kod w pliku
chat_update_text_message_user.py
:import os.path from google.auth.transport.requests import Request from google.oauth2.credentials import Credentials from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build from googleapiclient.errors import HttpError # 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 created membership. print(result) if __name__ == '__main__': main()
W kodzie zastąp następujący fragment:
SPACE
: nazwa pokoju, którą można uzyskać, korzystając z metodyspaces.list
w Chat API lub z adresu URL pokoju.MESSAGE
: nazwa wiadomości, którą można uzyskać z treści odpowiedzi zwróconej po utworzeniu wiadomości asynchronicznej za pomocą interfejsu Chat API lub z niestandardową nazwą przypisaną do wiadomości podczas jej tworzenia.
W katalogu roboczym skompiluj i uruchom przykład:
python3 chat_update_text_message_user.py
Zaktualizuj SMS-a lub dodaj wiadomość na początku do wiadomości na karcie dzięki uwierzytelnianiu w aplikacji
Aby zaktualizować wiadomość tekstową za pomocą uwierzytelniania aplikacji, przekaż w żądaniu te informacje:
- Zakres autoryzacji
chat.bot
. name
wiadomości do zaktualizowania.updateMask='text'
body
, który określa zaktualizowaną wiadomość.
Jeśli zaktualizowana wiadomość to wiadomość z kartą, pojawi się ona na początku wiadomości (która będzie się nadal wyświetlać).
Aby zaktualizować SMS-a jako SMS-a lub dodać wiadomość na początku wiadomości za pomocą uwierzytelniania aplikacji:
Python
- W katalogu roboczym utwórz plik o nazwie
chat_update_text_message_app.py
. Umieść ten kod w pliku
chat_update_text_message_app.py
:from httplib2 import Http from oauth2client.service_account import ServiceAccountCredentials from apiclient.discovery import build # Specify required scopes. SCOPES = ['https://www.googleapis.com/auth/chat.bot'] # Specify service account details. CREDENTIALS = ServiceAccountCredentials.from_json_keyfile_name( 'credentials.json', SCOPES) # Build the URI and authenticate with the service account. chat = build('chat', 'v1', http=CREDENTIALS.authorize(Http())) # 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)
W kodzie zastąp następujący fragment:
SPACE
: nazwa pokoju, którą można uzyskać, korzystając z metodyspaces.list
w Chat API lub z adresu URL pokoju.MESSAGE
: nazwa wiadomości, którą można uzyskać z treści odpowiedzi zwróconej po utworzeniu wiadomości asynchronicznej za pomocą interfejsu Chat API lub z niestandardową nazwą przypisaną do wiadomości podczas jej tworzenia.
W katalogu roboczym skompiluj i uruchom przykład:
python3 chat_update_text_message_app.py
Zaktualizuj komunikat dotyczący karty lub dołącz komunikat dotyczący karty do SMS-a
Aby zaktualizować wiadomość karty, przekaż w swojej prośbie te dane:
- Zakres autoryzacji
chat.bot
. Aktualizacja komunikatu na karcie wymaga uwierzytelniania aplikacji. name
wiadomości do zaktualizowania.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 jest aktualizowana.
Aby przekształcić wiadomość w wiadomość z kartą:
Python
- W katalogu roboczym utwórz plik o nazwie
chat_update_card_message.py
. Umieść ten kod w pliku
chat_update_card_message.py
:from httplib2 import Http from oauth2client.service_account import ServiceAccountCredentials from apiclient.discovery import build # Specify required scopes. SCOPES = ['https://www.googleapis.com/auth/chat.bot'] # Specify service account details. CREDENTIALS = ServiceAccountCredentials.from_json_keyfile_name( 'credentials.json', SCOPES) # Build the URI and authenticate with the service account. chat = build('chat', 'v1', http=CREDENTIALS.authorize(Http())) # 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)
W kodzie zastąp następujący fragment:
SPACE
: nazwa pokoju, którą można uzyskać, korzystając z metodyspaces.list
w Chat API lub z adresu URL pokoju.MESSAGE
: nazwa wiadomości, którą można uzyskać z treści odpowiedzi zwróconej po utworzeniu wiadomości asynchronicznej za pomocą interfejsu Chat API lub z niestandardową nazwą przypisaną do wiadomości podczas jej tworzenia.
W katalogu roboczym skompiluj i uruchom przykład:
python3 chat_update_card_message.py
Interfejs Chat API zwraca instancję Message
zawierającą szczegóły zaktualizowanej wiadomości.
Aktualizowanie wiadomości z wykorzystaniem wielu ścieżek pól jednocześnie
Po zaktualizowaniu wiadomości możesz jednocześnie zaktualizować wiele ścieżek wiadomości. Na przykład w żądaniu aktualizacji wiadomości możesz jednocześnie podać zmianę ścieżek pól text
i cardsv2
, co spowoduje zaktualizowanie zarówno tekstu wiadomości, jak i karty. Jeśli wiadomość zawiera tylko tekst, ale nie zawiera karty, zostanie do niej 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 za pomocą uwierzytelniania użytkownika, prześlij w żądaniu te dane:
- Zakres autoryzacji
chat.messages
. name
wiadomości do zaktualizowania.Atrybut
updateMask
określający ścieżki pól wiadomości do zaktualizowania, rozdzielone przecinkami:updateMask='text', 'cardsV2'
.body
, który określa zaktualizowaną wiadomość wraz ze wszystkimi zaktualizowanymi ścieżkami 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 pliku
chat_update_text_message_user.py
:import os.path from google.auth.transport.requests import Request from google.oauth2.credentials import Credentials from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build from googleapiclient.errors import HttpError # 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 created membership. print(result) if __name__ == '__main__': main()
W kodzie zastąp następujący fragment:
SPACE
: nazwa pokoju, którą można uzyskać, korzystając z metodyspaces.list
w Chat API lub z adresu URL pokoju.MESSAGE
: nazwa wiadomości, którą można uzyskać z treści odpowiedzi zwróconej po utworzeniu wiadomości asynchronicznej za pomocą interfejsu Chat API lub z niestandardową nazwą przypisaną do wiadomości podczas jej tworzenia.
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ółowych informacji o wiadomości
- Wyświetlanie listy wiadomości w pokoju
- Wyślij wiadomość.