Prześlij multimedia jako załącznik

Z tego przewodnika dowiesz się, jak używać metody upload (zasobu Media) interfejsu Google Chat API, aby przesyłać multimedia (plik) do Google Chat, a następnie załączać je do wiadomości.

Gdy użytkownik wysyła wiadomość do Twojej aplikacji, Google Chat wysyła zdarzenie interakcji MESSAGE. Zdarzenie interakcji odebrane przez aplikację zawiera treść żądania, czyli ładunek JSON reprezentujący zdarzenie interakcji wraz z ewentualnymi załącznikami. Dane w załączniku różnią się w zależności od tego, czy załącznik jest przesłany (plik lokalny) czy przechowywany na Dysku. Zasób Media reprezentuje plik przesłany do Google Chat, np. obrazy, filmy czy dokumenty. Zasób Attachment odpowiada instancji multimediów (pliku) dołączonej do wiadomości. Zasób Attachment zawiera metadane dotyczące załącznika, np. miejsce jego zapisania.

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
    
  • Projekt Google Cloud z włączonym i skonfigurowanym interfejsem Google Chat API. Instrukcje znajdziesz w artykule Tworzenie aplikacji Google Chat.
  • Autoryzacja aplikacji Google Chat została skonfigurowana. Przesyłanie multimediów jako załącznika do pliku wymaga uwierzytelniania użytkownika z zakresem autoryzacji chat.messages.create lub chat.messages.

Prześlij jako załącznik

Aby przesłać multimedia i załączyć je do wiadomości, podaj w nim te dane:

  • Określ zakres autoryzacji chat.messages.create lub chat.messages.
  • Wywołaj te metody w Google Chat:
    1. Aby przesłać plik, wywołaj metodę upload w zasobie Media.
      • Ustaw parent na nazwę pokoju, w którym znajduje się plik.
      • W polu body (treść żądania) ustaw filename na nazwę przesłanego pliku.
      • Ustaw media_body jako instancję pliku do przesłania.
    2. Aby utworzyć wiadomość z załączonym plikiem, wywołaj metodę create w zasobie Messages.
      • Ustaw attachment jako odpowiedź po wywołaniu metody upload w zasobie Media. Pole attachment akceptuje listę.

Poniższy przykład umożliwia przesłanie pliku graficznego PNG i załączenie go do wiadomości.

Python

  1. W katalogu roboczym utwórz plik o nazwie chat_media_and_attachment_upload.py.
  2. Umieść ten kod w elemencie chat_media_and_attachment_upload.py:

    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()
    
  3. W kodzie zastąp SPACE nazwą pokoju, do którego chcesz przesłać załącznik. Możesz ją uzyskać za pomocą metody spaces.list w interfejsie Chat API lub adresu URL pokoju.

  4. 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, pamiętaj o tych ograniczeniach i zasadach:

  • Możesz przesyłać pliki o rozmiarze do 200 MB.
  • Niektóre typy plików nie są obsługiwane i nie można ich przesyłać. Więcej informacji znajdziesz w artykule Typy plików blokowane w Google Chat.