Z tego przewodnika dowiesz się, jak używać metody upload
w zasobie Media
interfejsu Google Chat API w celu przesłania multimediów (pliku) do Google Chat, a następnie załączenia go do
wiadomość.
Gdy użytkownik wysyła wiadomość do Twojej aplikacji, Google Chat wysyła komunikat
MESSAGE
zdarzenia interakcji.
Zdarzenie interakcji odebrane przez aplikację zawiera treść żądania, która jest
Ładunek JSON reprezentujący zdarzenie interakcji, wraz ze wszystkimi załącznikami.
dane w załączniku będą się różnić w zależności od tego, czy został
przesłane treści (plik lokalny) lub plik zapisany na Dysku;
Media
zasób
reprezentuje plik przesłany do Google Chat, np. obrazy, filmy i dokumenty.
Attachment
zasób
reprezentuje instancję multimediów – pliku – dołączonego do wiadomości. Attachment
zasób zawiera metadane dotyczące załącznika, takie jak
gdzie są zapisywane.
Wymagania wstępne
Python
- Firmy lub przedsiębiorstwa Konto Google Workspace z dostępem do Google Chat.
- Python w wersji 3.6 lub nowszej
- narzędzie do zarządzania pakietami pip;
- Najnowsze biblioteki klienta Google. Aby je zainstalować lub zaktualizować:
uruchom następujące polecenie w interfejsie wiersza poleceń:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- Skonfiguruj środowisko:
- Utwórz projekt Google Cloud.
- Skonfiguruj ekran zgody OAuth
- Włącz i skonfiguruj interfejs Google Chat API pod nazwą. ikonę i opis aplikacji Google Chat.
-
Utwórz dane logowania na podstawie identyfikatora klienta OAuth dla aplikacji komputerowej. Aby uruchomić próbkę w tym
zapisz dane logowania w pliku JSON (
client_secrets.json
) na swoim katalog lokalny.
- Wybierz zakres autoryzacji, który obsługuje uwierzytelnianie użytkowników.
Prześlij jako załącznik
Aby przesłać multimedia i załączyć je do wiadomości, przekaż w żądanie:
- Określ zakres autoryzacji
chat.messages.create
lubchat.messages
. - Wywołaj te metody w Google Chat:
- Aby przesłać plik, wywołaj metodę
Metoda
upload
w zasobieMedia
.- Jako
parent
ustaw nazwę pokoju, w którym znajduje się plik. - W polu
body
(treści żądania) ustawfilename
na nazwę przesłanego pliku . - Ustaw
media_body
jako instancję pliku do przesłania.
- Jako
- Aby utworzyć wiadomość z załączonym przesłanym plikiem, wywołaj metodę
Metoda
create
wMessages
zasób.- Ustaw
attachment
jako odpowiedź wywołującą Metodaupload
wMedia
zasób.attachment
akceptuje listę.
- Ustaw
- Aby przesłać plik, wywołaj metodę
Metoda
Poniższy przykład pokazuje przesyłanie pliku graficznego PNG i załączanie go do wiadomości.
Python
- W katalogu roboczym utwórz plik o nazwie
chat_media_and_attachment_upload.py
Umieść w pliku
chat_media_and_attachment_upload.py
ten kod:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build from googleapiclient.http import MediaFileUpload # 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.create"] def main(): ''' Authenticates with Chat API via user credentials, then uploads a file as media, creates a message, and attaches the file to the 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. service = build('chat', 'v1', credentials=creds) # Upload a file to Google Chat. media = MediaFileUpload('test_image.png', mimetype='image/png') # Create a message and attach the uploaded file to it. attachment_uploaded = service.media().upload( # The space to upload the attachment in. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. parent='spaces/SPACE', # The filename of the attachment, including the file extension. body={'filename': 'test_image.png'}, # Media resource of the attachment. media_body=media ).execute() print(attachment_uploaded) # Create a Chat message with attachment. result = service.spaces().messages().create( # The space to create the message in. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Must match the space name that the attachment is uploaded to. parent='spaces/SPACE', # The message to create. body={ 'text': 'Hello, world!', 'attachment': [attachment_uploaded] } ).execute() print(result) if __name__ == '__main__': main()
W kodzie zastąp
SPACE
nazwą pokoju, aby prześlij załącznik, który znajdziesz w Metodaspaces.list
w interfejsie Chat API lub z adresu URL pokoju.W katalogu roboczym skompiluj i uruchom przykład:
python3 chat_media_and_attachment_upload.py
Interfejs Chat API zwraca treść odpowiedzi zawierającą
attachmentDataRef
ze szczegółowymi informacjami o przesłanym pliku.
Ograniczenia i uwagi
Przygotowując się do przesyłania plików i załączania ich do wiadomości, zwróć uwagę na te kwestie ograniczeń i kwestii:
- Możesz przesyłać pliki o maksymalnym rozmiarze 200 MB.
- Niektóre typy plików nie są obsługiwane i nie można ich przesyłać. Więcej informacji: Typy plików blokowane w Google Chat
- Wiadomość musi pominąć widżety akcesoriów.