Créer des interfaces Google Drive

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Google Workspace Les modules complémentaires peuvent fournir des interfaces personnalisées lorsque l'utilisateur se sert de Google Drive. Cela vous permet de fournir à l'utilisateur des informations pertinentes supplémentaires, d'automatiser les tâches et de connecter des systèmes tiers à Google Drive.

Accéder à l'interface utilisateur du module complémentaire

Vous pouvez ouvrir un Google Workspace module complémentaire dans Google Drive si son icône s'affiche dans la colonne des icônes située à droite de l'interface utilisateur de Drive. Un module complémentaireGoogle Workspace peut définir une interface de page d'accueil, une interface de sélection d'éléments ou les deux:

  • Si un utilisateur clique sur l'icône de module complémentaire dans Google Drive, celui-ci exécute la fonction drive.homepageTrigger correspondante (le cas échéant). Cette fonction crée une fiche de page d'accueil et la renvoie à Google Drive pour affichage. Si aucune fonction drive.homepageTrigger n'est définie, une fiche générique s'affiche à la place.
  • Si l'utilisateur sélectionne un ou plusieurs éléments dans Drive, puis clique sur l'icône du module complémentaire, ou sélectionne des éléments lorsque le module est ouvert, celui-ci exécute la fonction contextuelle drive.onItemsSelectedTrigger correspondante (le cas échéant). Cette fonction crée l'interface contextuelle des éléments sélectionnés pour le module complémentaire Drive et la renvoie à Google Drive pour affichage.

Créer l'interface Drive complémentaire

Pour créer des interfaces qui étendent Google Drive, procédez comme suit:

  1. Déterminez si vous souhaitez que votre module complémentaire comporte une page d'accueil spécifique à Drive. Décidez également si vous souhaitez fournir une interface contextuelle lorsque l'utilisateur sélectionne des éléments Drive.
  2. Ajoutez les champs addOns.common et addOns.drive appropriés au fichier manifeste du projet de script du module complémentaire, y compris les champs d'application Drive requis.
  3. Si vous fournissez une page d'accueil spécifique à Drive, implémentez la fonction drive.homepageTrigger pour créer cette interface. Vous pouvez également choisir d'utiliser l'interface common.homepageTrigger pour plusieurs Google Workspace hôtes.
  4. Si vous fournissez une interface de sélection contextuelle d'éléments Drive, vous devez implémenter une fonction de déclenchement contextuel drive.onItemsSelectedTrigger pour créer cette interface. Pour en savoir plus, consultez Interface contextuelle Drive pour les éléments sélectionnés.
  5. Implémentez les fonctions de rappel associées nécessaires pour répondre aux interactions de l'interface utilisateur telles que les clics sur un bouton.

Pages d'accueil Drive

Google Drive permet d'afficher Google Workspace des pages d'accueil complémentaires. Pour afficher la page d'accueil courante de votre module complémentaire dans Google Drive, assurez-vous simplement qu'il existe un champ addOns.drive dans le fichier manifeste du module complémentaire.

Vous pouvez également ajouter un drive.homepageTrigger au fichier manifeste du module complémentaire pour fournir une page d'accueil spécifique à Drive.

Dans les deux cas, vous devez indiquer le nom d'une fonction de déclenchement de la page d'accueil dans votre projet de script de module complémentaire. Cette fonction est automatiquement appelée pour créer la page d'accueil Drive lorsqu'elle est nécessaire. Vous devez implémenter cette fonction pour créer et renvoyer un seul objet Card ou un tableau d'objets Card constituant la page d'accueil. La fonction du déclencheur de page d'accueil reçoit un objet d'événement en tant que paramètre contenant des informations générales telles que la plate-forme du client. Vous pouvez utiliser les données d'objet d'événement pour personnaliser la construction de la page d'accueil.

Interface contextuelle Drive pour les éléments sélectionnés

Google Drive s'appuie sur un déclencheur contextuel pour déterminer l'interface (le cas échéant) à afficher lorsque l'utilisateur sélectionne un ou plusieurs éléments Drive. Lorsque le déclencheur s'exécute, il exécute la fonction de déclencheur contextuel spécifiée par le champ drive.onItemsSelectedTrigger.runFunction du fichier manifeste du module complémentaire.

Pour créer une interface de sélection d'éléments contextuelle pour Drive, procédez comme suit:

  1. Assurez-vous que le fichier manifeste du module complémentaire inclut le champ d'application https://www.googleapis.com/auth/drive.addons.metadata.readonly

  2. Assurez-vous que le fichier manifeste inclut une section drive.onItemsSelectedTrigger.

  3. Implémentez la fonction nommée dans le champ drive.onItemsSelectedTrigger. Cette fonction accepte un objet d'événement en tant qu'argument et doit renvoyer un seul objet Card ou un tableau d'objets Card.

  4. Comme pour toute fiche, vous devez implémenter toutes les fonctions de rappel permettant d'assurer l'interactivité du widget pour l'interface. Par exemple, si vous incluez un bouton dans l'interface, vous devez joindre une action et une fonction de rappel implémentée qui s'exécute lorsque l'utilisateur clique sur le bouton.

Objets d'événement

Un objet d'événement est créé et transmis à la fonction de déclenchement de drive.homepageTrigger ou drive.onItemsSelectedTrigger lorsque ces fonctions sont appelées. La fonction déclencheur peut utiliser les informations de cet objet d'événement pour déterminer comment créer des fiches complémentaires ou contrôler le comportement des modules complémentaires.

La structure complète des objets d'événement est décrite dans Objets d'événement. Lorsque Drive est l'application hôte hôte du module complémentaire, les objets d'événements contextuels incluent le champ Objet d'événement Drive qui contient les informations client spécifiques à Drive.

Les objets d'événement du contexte contextuel pour les déclencheurs de sélection d'élément incluent des informations sur les éléments que l'utilisateur a sélectionnés lors de l'activation du déclencheur. Lorsqu'un utilisateur sélectionne plusieurs éléments dans Drive, l'un d'eux est considéré comme l'un des principaux centres d'intérêt. Cet élément est appelé élément de curseur actif.

L'exemple suivant montre un objet d'événement Drive transmis à une fonction drive.onItemsSelectedTrigger:

    {
      "commonEventObject": { ... },
      "drive": {
        "activeCursorItem":{
          "addonHasFileScopePermission": true,
          "id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
          "iconUrl": "https://drive-thirdparty.googleusercontent.com...",
          "mimeType":"application/pdf",
          "title":"How to get started with Drive"
        },
        "selectedItems": [
          {
            "addonHasFileScopePermission": true,
            "id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
            "iconUrl":"https://drive-thirdparty.googleusercontent.com...",
            "mimeType":"application/pdf",
            "title":"How to get started with Drive"
          },
          ...
        ]
      },
      ...
    }