Cette page a été traduite par l'API Cloud Translation.

Créer des interfaces Google Drive

Les modules complémentaires Google Workspace offrent lorsque l'utilisateur se sert de Google Drive. Vous pouvez ainsi fournir à l'utilisateur des informations supplémentaires pertinentes, automatiser des tâches et connecter des systèmes tiers à Google Drive.

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

Vous pouvez ouvrir un module complémentaire Google Workspace dans Google Drive si son icône apparaît à droite dans l'interface utilisateur de Drive. Un module complémentaire Google 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 du module complémentaire dans Google Drive, le module complémentaire exécute la fonction drive.homepageTrigger correspondante (si elle est présente). Cette fonction crée et renvoie une fiche de page d'accueil dans Google Drive pour l'afficher. Si aucune fonction drive.homepageTrigger n'est définie, une fiche de page d'accueil générique s'affiche à la place.
Si l'utilisateur sélectionne un ou plusieurs éléments dans Google Drive, puis clique sur le module complémentaire ou sélectionne des éléments lorsque le module complémentaire est ouvert, le module complémentaire exécute la drive.onItemsSelectedTrigger fonction contextuelle (le cas échéant). Cette fonction crée l'interface contextuelle "Éléments sélectionnés" de Google Drive du module complémentaire et la renvoie à Google Drive pour l'afficher.

Créer l'interface Drive du module complémentaire

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

Décidez si vous souhaitez que votre module complémentaire dispose d'une page d'accueil spécifique à Drive. Décidez également si vous souhaitez fournir une interface contextuelle lorsque l'utilisateur sélectionne "Éléments Drive".
Ajoutez les composants addOns.common et addOns.drive champs pour le projet du script du module complémentaire fichier manifeste, y compris tous les champs d'application Drive requis.
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 hôtes Google Workspace.
Si vous fournissez une interface de sélection d'éléments contextuelle pour Drive, vous devez implémenter un drive.onItemsSelectedTrigger de déclenchement contextuel pour créer cette interface. Pour en savoir plus, consultez la section Interface contextuelle Drive pour les éléments sélectionnés.
Implémentez les fonctions de rappel associées nécessaires pour répondre aux interactions de l'utilisateur avec l'UI, telles que les clics sur les boutons.

Pages d'accueil de Drive

Google Drive permet d'afficher le module complémentaire Google Workspace pages d'accueil. Pour afficher la page d'accueil commune de votre module complémentaire dans Google Drive, assurez-vous simplement qu'un champ addOns.drive figure 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éclencheur de la page d'accueil dans votre le projet de script du module complémentaire. Cette fonction est automatiquement appelée pour créer la page d'accueil de Drive si nécessaire. Vous devez implémenter cette fonction pour créer et renvoyer un seul Card ou un tableau de Card les objets qui constituent la page d'accueil. La fonction de déclencheur de la page d'accueil reçoit une Objet événement sous la forme d'un paramètre contenant des informations générales, telles que Google Cloud. Vous pouvez utiliser les données de l'objet d'événement pour adapter la création 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 Google Drive. Lorsque s'exécute, il exécute la fonction de déclencheur contextuel spécifiée par drive.onItemsSelectedTrigger.runFunction dans le fichier manifeste du module complémentaire.

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

Assurez-vous que le fichier manifeste du module complémentaire inclut le https://www.googleapis.com/auth/drive.addons.metadata.readonly portée
Assurez-vous que le fichier manifeste inclut une section drive.onItemsSelectedTrigger.
Implémentez la fonction nommée dans drive.onItemsSelectedTrigger . Cette fonction accepte un objet d'événement comme argument et doit renvoyer un seul objet Card ou un tableau d'objets Card.
Comme pour toute carte, vous devez implémenter les fonctions de rappel utilisées pour fournir l'interactivité des widgets pour l'interface. Par exemple, si vous incluez un bouton dans l'interface, il doit comporter une action associée et une fonction de rappel implémentée qui s'exécute lorsque l'utilisateur clique sur le bouton.

Objets "Événement"

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

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

Les objets d'événement Drive contextuels pour les déclencheurs de sélection d'éléments incluent des informations sur les éléments sélectionnés par l'utilisateur lors de l'exécution du déclencheur. Lorsqu'un utilisateur sélectionne plusieurs éléments dans Drive, l'un des éléments est considéré comme faisant partie Intérêt principal cet élément est appelé élément de curseur actif.

L'exemple suivant montre Objet événement Drive qui est transmis à 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"
          },
          ...
        ]
      },
      ...
    }