Prześlij multimedia jako załącznik

Ten przewodnik wyjaśnia, jak używać metody upload w zasobie Media interfejsu Google Chat API do przesyłania multimediów (pliku) do Google Chat, a następnie dołączania ich do wiadomości.

Gdy użytkownik wyśle wiadomość do Twojej aplikacji, Google Chat wyśle MESSAGE zdarzenie interakcji. Zdarzenie interakcji otrzymane przez Twoją aplikację zawiera treść żądania, która jest ładunkiem JSON reprezentującym zdarzenie interakcji, w tym wszelkie załączniki. Dane w załączniku różnią się w zależności od tego, czy załącznik jest przesłaną treścią (plikiem lokalnym), czy plikiem przechowywanym na Dysku. Zasób Media reprezentuje plik przesłany do Google Chat, np. obrazy, filmy i dokumenty. Zasób Attachment reprezentuje instancję multimediów – plik – dołączony do wiadomości. Zasób Attachment zawiera metadane załącznika, np. miejsce jego zapisania.

Wymagania wstępne

Python

Przesyłanie jako załącznik

Aby przesłać multimedia i dołączyć je do wiadomości, w żądaniu podaj te informacje:

  • Określ zakres autoryzacji chat.messages.create lub chat.messages.
  • Wywołaj te metody 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 body (treści żądania) ustaw filename na nazwę przesłanego załącznika.
      • Ustaw media_body jako instancję pliku, który ma zostać przesłany.
    2. Aby utworzyć wiadomość z dołączonym przesłanym plikiem, wywołaj metodę create w zasobie Messages.
      • Ustaw attachment jako odpowiedź na wywołanie metody upload w zasobie Media. Pole attachment akceptuje listę.

Ten przykład przesyła plik obrazu PNG i dołącza go do wiadomości.

Python

  1. W katalogu roboczym utwórz plik o nazwie chat_media_and_attachment_upload.py.

  2. W pliku chat_media_and_attachment_upload.py umieść 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(
                  'credentials.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ą spaces.list metody w interfejsie Chat API lub z 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 kwestie do rozważenia

Podczas przygotowywania się do przesyłania plików i dołączania ich do wiadomości zwróć uwagę na te ograniczenia i kwestie do rozważenia: