Importer du contenu multimédia sous forme de fichier joint

Ce guide explique comment utiliser la méthode upload sur la ressource Media de l'API Google Chat pour importer du contenu multimédia (un fichier) dans Google Chat, puis le joindre à un message.

Lorsque l'utilisateur envoie un message à votre application, Google Chat envoie un événement d'interaction MESSAGE. L'événement d'interaction reçu par votre application inclut un corps de requête, qui correspond à la charge utile JSON représentant l'événement d'interaction, y compris les éventuelles pièces jointes. Les données de la pièce jointe diffèrent selon qu'il s'agit d'un contenu importé (fichier local) ou d'un fichier stocké sur Drive. La ressource Media représente un fichier importé dans Google Chat, par exemple des images, des vidéos et des documents. La ressource Attachment représente une instance de contenu multimédia (fichier) jointe à un message. La ressource Attachment inclut les métadonnées sur le rattachement, telles que son emplacement d'enregistrement.

Prérequis

Python

  • Python 3.6 ou version ultérieure
  • L'outil de gestion des packages pip

  • Les dernières bibliothèques clientes Google pour Python. Pour les installer ou les mettre à jour, exécutez la commande suivante dans votre interface de ligne de commande:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
  • Un projet Google Cloud avec l'API Google Chat activée et configurée Pour connaître la procédure à suivre, consultez Créer une application Google Chat.

  • Autorisation configurée pour l'application Chat. L'importation de fichiers multimédias en tant que pièce jointe nécessite une authentification de l'utilisateur avec le champ d'application d'autorisation chat.messages.create ou chat.messages.

Importer en tant que fichier en pièce jointe

Pour importer du contenu multimédia et le joindre à un message, transmettez les éléments suivants dans votre requête :

  • Spécifiez le champ d'application des autorisations chat.messages.create ou chat.messages.
  • Appelez les méthodes Google Chat suivantes :
    1. Pour importer le fichier, appelez la méthode upload sur la ressource Media.
      • Définissez parent sur le nom de l'espace qui héberge le fichier.
      • Dans body (corps de la requête), définissez filename sur le nom du fichier importé en pièce jointe.
      • Définissez media_body comme instance du fichier à importer.
    2. Pour créer un message avec le fichier importé en pièce jointe, appelez la méthode create sur la ressource Messages.
      • Définissez attachment comme réponse de l'appel de la méthode upload sur la ressource Media. Le champ attachment accepte une liste.

L'exemple suivant importe un fichier image PNG et le joint à un message.

Python

  1. Dans votre répertoire de travail, créez un fichier nommé chat_media_and_attachment_upload.py.

  2. Incluez le code suivant dans 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. Dans le code, remplacez SPACE par le nom de l'espace dans lequel importer la pièce jointe. Vous pouvez l'obtenir à l'aide de la méthode spaces.list de l'API Chat ou à partir de l'URL d'un espace.

  4. Dans votre répertoire de travail, créez et exécutez l'exemple:

    python3 chat_media_and_attachment_upload.py

L'API Chat renvoie un corps de réponse contenant attachmentDataRef avec des détails sur le fichier importé.

Limites et considérations

Lorsque vous vous préparez à importer des fichiers et à les joindre aux messages, tenez compte des limites et considérations suivantes:

  • La taille maximale des fichiers importés est de 200 Mo.
  • Certains types de fichiers ne sont pas compatibles et ne peuvent pas être importés. Pour en savoir plus, consultez Types de fichiers bloqués dans Google Chat.