Z tego przewodnika dowiesz się, jak używać metody
get()
w zasobie Message
interfejsu Google Chat API, aby zwracać szczegóły wiadomości tekstowej lub karty.
W interfejsie Chat API wiadomość w Google Chat jest reprezentowana przez Message
zasób.
Użytkownicy Google Chat mogą wysyłać tylko wiadomości tekstowe, ale aplikacje Google Chat mogą korzystać z wielu innych funkcji przesyłania wiadomości, w tym wyświetlać statyczne lub interaktywne interfejsy użytkownika, zbierać informacje od użytkowników i dostarczać wiadomości prywatnie. Więcej informacji o funkcjach przesyłania wiadomości dostępnych w interfejsie Chat API znajdziesz w przeglądzie wiadomości w Google Chat.
Wymagania wstępne
Node.js
- Konto Google Workspace w wersji Business lub Enterprise z dostępem do Google Chat.
- Skonfiguruj środowisko:
- Utwórz projekt Google Cloud.
- Skonfiguruj ekran zgody OAuth.
- Włącz i skonfiguruj interfejs Google Chat API, podając nazwę, ikonę i opis aplikacji do obsługi czatu.
- Zainstaluj bibliotekę klienta Cloud Node.js.
- Utwórz dane logowania, które będą zależeć od sposobu uwierzytelniania w żądaniu do interfejsu Google Chat API:
- Aby uwierzytelnić się jako użytkownik Chatu, utwórz dane logowania identyfikatora klienta OAuth i zapisz je jako plik JSON o nazwie
credentials.json
w katalogu lokalnym. - Aby uwierzytelnić się jako aplikacja w Chat, utwórz dane logowania konta usługi i zapisz je w pliku JSON o nazwie
credentials.json
.
- Aby uwierzytelnić się jako użytkownik Chatu, utwórz dane logowania identyfikatora klienta OAuth i zapisz je jako plik JSON o nazwie
- Wybierz zakres autoryzacji w zależności od tego, czy chcesz uwierzytelnić się jako użytkownik, czy jako aplikacja do obsługi czatu.
- Pokój Google Chat, w którym uwierzytelniony użytkownik lub wywołująca aplikacja Chat jest członkiem. Aby uwierzytelnić się jako aplikacja do czatu, dodaj ją do pokoju.
Python
- Konto Google Workspace w wersji Business lub Enterprise z dostępem do Google Chat.
- Skonfiguruj środowisko:
- Utwórz projekt Google Cloud.
- Skonfiguruj ekran zgody OAuth.
- Włącz i skonfiguruj interfejs Google Chat API, podając nazwę, ikonę i opis aplikacji do obsługi czatu.
- Zainstaluj bibliotekę klienta Cloud w Pythonie.
- Utwórz dane logowania, które będą zależeć od sposobu uwierzytelniania w żądaniu do interfejsu Google Chat API:
- Aby uwierzytelnić się jako użytkownik Chatu, utwórz dane logowania identyfikatora klienta OAuth i zapisz je jako plik JSON o nazwie
credentials.json
w katalogu lokalnym. - Aby uwierzytelnić się jako aplikacja w Chat, utwórz dane logowania konta usługi i zapisz je w pliku JSON o nazwie
credentials.json
.
- Aby uwierzytelnić się jako użytkownik Chatu, utwórz dane logowania identyfikatora klienta OAuth i zapisz je jako plik JSON o nazwie
- Wybierz zakres autoryzacji w zależności od tego, czy chcesz uwierzytelnić się jako użytkownik, czy jako aplikacja do obsługi czatu.
- Pokój Google Chat, w którym uwierzytelniony użytkownik lub wywołująca aplikacja Chat jest członkiem. Aby uwierzytelnić się jako aplikacja do czatu, dodaj ją do pokoju.
Java
- Konto Google Workspace w wersji Business lub Enterprise z dostępem do Google Chat.
- Skonfiguruj środowisko:
- Utwórz projekt Google Cloud.
- Skonfiguruj ekran zgody OAuth.
- Włącz i skonfiguruj interfejs Google Chat API, podając nazwę, ikonę i opis aplikacji do obsługi czatu.
- Zainstaluj bibliotekę klienta Cloud w języku Java.
- Utwórz dane logowania, które będą zależeć od sposobu uwierzytelniania w żądaniu do interfejsu Google Chat API:
- Aby uwierzytelnić się jako użytkownik Chatu, utwórz dane logowania identyfikatora klienta OAuth i zapisz je jako plik JSON o nazwie
credentials.json
w katalogu lokalnym. - Aby uwierzytelnić się jako aplikacja w Chat, utwórz dane logowania konta usługi i zapisz je w pliku JSON o nazwie
credentials.json
.
- Aby uwierzytelnić się jako użytkownik Chatu, utwórz dane logowania identyfikatora klienta OAuth i zapisz je jako plik JSON o nazwie
- Wybierz zakres autoryzacji w zależności od tego, czy chcesz uwierzytelnić się jako użytkownik, czy jako aplikacja do obsługi czatu.
- Pokój Google Chat, w którym uwierzytelniony użytkownik lub wywołująca aplikacja Chat jest członkiem. Aby uwierzytelnić się jako aplikacja do czatu, dodaj ją do pokoju.
Google Apps Script
- Konto Google Workspace w wersji Business lub Enterprise z dostępem do Google Chat.
- Skonfiguruj środowisko:
- Utwórz projekt Google Cloud.
- Skonfiguruj ekran zgody OAuth.
- Włącz i skonfiguruj interfejs Google Chat API, podając nazwę, ikonę i opis aplikacji do obsługi czatu.
- Utwórz samodzielny projekt Apps Script i włącz zaawansowaną usługę czatu.
- W tym przewodniku musisz użyć uwierzytelniania użytkownika lub aplikacji. Aby uwierzytelnić się jako aplikacja do obsługi czatu, utwórz dane logowania konta usługi. Instrukcje znajdziesz w artykule Uwierzytelnianie i autoryzowanie jako aplikacja Google Chat.
- Wybierz zakres autoryzacji w zależności od tego, czy chcesz uwierzytelnić się jako użytkownik, czy jako aplikacja do obsługi czatu.
- Pokój Google Chat, w którym uwierzytelniony użytkownik lub wywołująca aplikacja Chat jest członkiem. Aby uwierzytelnić się jako aplikacja do czatu, dodaj ją do pokoju.
Otrzymywanie wiadomości z uwierzytelnianiem użytkownika
Aby uzyskać szczegółowe informacje o wiadomości z uwierzytelnianiem użytkownika, w żądaniu przekaż te informacje:
- Określ zakres autoryzacji
chat.messages.readonly
lubchat.messages
. - Wywołaj metodę
GetMessage()
. - Ustaw
name
na nazwę zasobu wiadomości, którą chcesz pobrać.
W przykładzie poniżej pobierana jest wiadomość z uwierzytelnianiem użytkownika:
Node.js
Python
Java
Google Apps Script
Aby uruchomić ten przykład, zastąp te elementy:
SPACE_NAME
: identyfikator zname
pokoju. Możesz go uzyskać, wywołując metodęListSpaces()
lub z adresu URL pokoju.MESSAGE_NAME
: identyfikator z polaname
wiadomości. Identyfikator możesz uzyskać z treści odpowiedzi zwróconej po utworzeniu wiadomości asynchronicznie za pomocą interfejsu Chat API lub za pomocą niestandardowej nazwy przypisanej do wiadomości podczas jej tworzenia.
Interfejs Chat API zwraca instancję Message
, która zawiera szczegółowe informacje o określonej wiadomości.
Otrzymywanie wiadomości z uwierzytelnianiem aplikacji
Aby uzyskać szczegółowe informacje o wiadomości z uwierzytelnianiem aplikacji, w żądaniu przekaż te dane:
- Określ zakres autoryzacji. Przykłady w tej sekcji korzystają z zakresu
chat.bot
, który jest ogólnie dostępny i nie wymaga zatwierdzenia przez administratora. Możesz też autoryzować aplikację Chat za zgodą administratora, co jest dostępne w wersji przedpremierowej dla programistów. - Wywołaj metodę
GetMessage()
. - Ustaw
name
na nazwę zasobu wiadomości, którą chcesz pobrać.
W tym przykładzie pobieramy wiadomość z uwierzytelnianiem aplikacji:
Node.js
Python
Java
Google Apps Script
Aby uruchomić ten przykład, zastąp te elementy:
SPACE_NAME
: identyfikator zname
pokoju. Możesz go uzyskać, wywołując metodęListSpaces()
lub z adresu URL pokoju.MESSAGE_NAME
: identyfikator z polaname
wiadomości. Identyfikator możesz uzyskać z treści odpowiedzi zwróconej po utworzeniu wiadomości asynchronicznie za pomocą interfejsu Chat API lub za pomocą niestandardowej nazwy przypisanej do wiadomości podczas jej tworzenia.
Interfejs Chat API zwraca instancję Message
, która zawiera szczegółowe informacje o określonej wiadomości.
Otrzymywanie wiadomości jako aplikacja Google Chat po zatwierdzeniu przez administratora
Uwierzytelnianie aplikacji z zakresem autoryzacji chat.app.*
wymaga jednorazowego zatwierdzenia przez administratora.
Aby uzyskać szczegółowe informacje o wiadomości z uwierzytelnianiem aplikacji za pomocą interfejsu Chat REST API, w żądaniu podaj te informacje:
- Wywołaj metodę
GetMessage()
. - Określ zakres autoryzacji
chat.app.messages.readonly
. - Ustaw
name
na nazwę zasobu wiadomości, którą chcesz pobrać.
Tworzenie klucza interfejsu API
Aby wywołać metodę interfejsu API wersji przedpremierowej dla programistów, musisz użyć niepublicznej wersji przedpremierowej dokumentu wykrywania interfejsu API. Aby uwierzytelnić żądanie, musisz przekazać klucz interfejsu API.
Aby utworzyć klucz interfejsu API, otwórz projekt Google Cloud aplikacji i wykonaj te czynności:
- W konsoli Google Cloud otwórz Menu > Interfejsy API i usługi > Dane logowania.
- Kliknij Utwórz dane logowania > Klucz interfejsu API.
- Wyświetli się nowy klucz interfejsu API.
- Kliknij Kopiuj , aby skopiować klucz interfejsu API do użycia w kodzie aplikacji. Klucz interfejsu API można też znaleźć w sekcji „Klucze interfejsu API” w danych logowania projektu.
- Aby można było zapobiec nieautoryzowanemu użyciu, zalecamy ograniczenie miejsc i interfejsów API, w których można używać klucza API. Więcej informacji znajdziesz w sekcji Dodawanie ograniczeń interfejsu API.
Napisz skrypt, który wywołuje Chat API
Aby uzyskać szczegółowe informacje o wiadomości za pomocą uwierzytelniania aplikacji i zatwierdzenia przez administratora oraz interfejsu API REST Google Chat:
Python
- W katalogu roboczym utwórz plik o nazwie
chat_messages_get_admin_app.py
. Dodaj do pliku
chat_messages_get_admin_app.py
ten kod:from google.oauth2 import service_account from apiclient.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.app.messages.readonly"] def main(): ''' Authenticates with Chat API using app authentication, then gets details about a message. ''' # Specify service account details. creds = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY') # Use the service endpoint to call Chat API. result = chat.spaces().messages().get( # The message to get details about. # # Replace SPACE_NAME with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='spaces/SPACE_NAME/messages/MESSAGE_NAME', ).execute() # Print Chat API's response in your command line interface. print(result) if __name__ == '__main__': main()
W kodzie zastąp te elementy:
API_KEY
: klucz interfejsu API utworzony do budowania punktu końcowego usługi dla interfejsu Chat API.SPACE_NAME
: identyfikator z przestrzeniname
. Możesz go uzyskać, wywołując metodęListSpaces()
lub z adresu URL pokoju.MESSAGE_NAME
: identyfikator z elementuname
wiadomości. Identyfikator możesz uzyskać z treści odpowiedzi zwróconej po utworzeniu wiadomości asynchronicznie za pomocą interfejsu Chat API lub za pomocą niestandardowej nazwy przypisanej do wiadomości podczas jej tworzenia.
W katalogu roboczym skompiluj i uruchom przykład:
python3 chat_messages_get_admin_app.py
Interfejs Chat API zwraca instancję Message
, która zawiera szczegółowe informacje o określonej wiadomości.
Powiązane artykuły
- Formatowanie wiadomości
- Usuwanie wiadomości
- Wyświetlanie listy wiadomości w pokoju
- Aktualizowanie wiadomości
- Wyślij wiadomość.