Configurer l'intégration de l'interface utilisateur Drive

Pour afficher votre application dans Google Drive lorsqu'un utilisateur crée ou ouvre un fichier, vous devez d'abord configurer une intégration de l'interface utilisateur (UI) de Drive. Vous devez également configurer votre application pour la lister dans Google Workspace Marketplace.

Activer l'API Drive

Avant d'utiliser les API Google, vous devez les activer dans un projet Google Cloud. Vous pouvez activer une ou plusieurs API dans un même projet Google Cloud.

Pour commencer à intégrer l'UI Google Drive, vous devez activer l'API Drive. Vous pouvez ainsi accéder aux fonctionnalités d'intégration de l'API et de l'UI.

  • Dans la console Google Cloud, activez l'API Google Drive.

    Activer l'API

Configurer l'intégration de l'interface utilisateur Drive

  1. Dans la console Google API, accédez à Menu  > API et services > API et services activés.

    Accéder à "API et services activés"

  2. En bas du tableau de bord "API et services", cliquez sur API Google Drive. La page de configuration de l'API Google Drive s'affiche.
  3. Sélectionnez l'onglet Intégration de l'UI Drive.
  4. (Facultatif) Saisissez un nom dans le champ Nom de l'application. Le nom de l'application s'affiche pour les utilisateurs dans l'onglet "Gérer les applications" des paramètres de Drive.
  5. (Facultatif) Saisissez une brève description en une ligne dans le champ Brève description. La description courte s'affiche dans l'onglet "Gérer les applications" des paramètres de Drive.
  6. (Facultatif) Saisissez une description complète dans le champ Description longue.

  7. Importez une ou plusieurs icônes d'application à afficher dans la liste des applications Drive connectées d'un utilisateur et dans le menu contextuel "Ouvrir avec". Les icônes doivent être au format PNG avec un arrière-plan transparent. L'affichage des icônes dans Drive peut prendre jusqu'à 24 heures.

  8. Pour utiliser l'élément de menu "Ouvrir avec" de l'interface utilisateur de Drive, saisissez l'URL de votre application dans le champ Ouvrir l'URL. Cette URL est utilisée par le menu contextuel "Ouvrir avec".

    • Cette URL doit contenir un nom de domaine complet. localhost ne fonctionne pas.
    • Cette URL doit être accessible aux utilisateurs prévus de votre application. Si vous disposez de plusieurs versions d'application, par exemple une pour la version publique et une pour la version réservée à certains utilisateurs, chaque version doit utiliser une URL unique. Vous pouvez ensuite créer différentes configurations d'application pour chaque version.
    • Vous devez valider la propriété de cette URL avant de pouvoir lister votre application sur Google Workspace Marketplace.
    • Par défaut, un paramètre de requête state est ajouté à cette URL pour transmettre les données de l'interface utilisateur de Drive à votre application. Pour en savoir plus sur le contenu du paramètre state, consultez la section Paramètre state.

  9. (Facultatif) Saisissez les types MIME et les extensions de fichier par défaut dans les champs Types MIME par défaut et Extensions de fichier par défaut. Les types MIME et les extensions de fichier par défaut représentent les fichiers que votre application est conçue pour ouvrir uniquement. Par exemple, votre application peut ouvrir un format intégré pour superposer et modifier des images. N'incluez que des types de contenus multimédias standards et assurez-vous qu'ils ne contiennent pas de fautes de frappe ni d'orthographe. Si votre application n'ouvre que des fichiers de raccourci ou de raccourci tiers, vous pouvez laisser le type MIME vide.

  10. (Facultatif) Saisissez les types MIME et les extensions de fichier secondaires dans les champs Types MIME secondaires et Extensions de fichier secondaires. Les types MIME et les extensions de fichier secondaires représentent les fichiers que votre application peut ouvrir, mais qui ne sont pas spécifiques à votre application. Par exemple, votre application peut être une application de retouche d'image qui ouvre des images PNG et JPG. N'incluez que des types de contenus multimédias standards et assurez-vous qu'ils ne contiennent pas de fautes de frappe ni d'orthographe. Si votre application n'ouvre que des fichiers de raccourci ou de raccourci tiers, vous pouvez laisser le type MIME vide.

  11. Pour utiliser le bouton "Nouveau " de l'interface utilisateur de Drive et demander aux utilisateurs de créer un fichier avec votre application, cochez la case Créer des fichiers. Les champs Nouvelle URL et Nom du document (facultatif) s'affichent.

    • Cette URL doit contenir un nom de domaine complet. localhost ne fonctionne pas.
    • Vous devez valider la propriété de cette URL avant de pouvoir lister votre application sur Google Workspace Marketplace.
    • Par défaut, un paramètre de requête state est ajouté à cette URL pour transmettre les données de l'interface utilisateur de Drive à votre application. Pour en savoir plus sur le contenu du paramètre state, consultez la section Paramètre state.

  12. Saisissez une URL dans le champ Nouvelle URL. Cette URL est utilisée par le bouton "Nouveau" pour rediriger l'utilisateur vers votre application.

  13. (Facultatif) Si vous souhaitez que votre application ouvre des fichiers compatibles avec Google Workspace, cochez la case Importation.

  14. (Facultatif) Si votre application doit gérer des fichiers sur des Drive partagés, cochez la case Compatibilité avec les Drive partagés. Pour en savoir plus sur la prise en charge des Drive partagés dans votre application, consultez Implémenter la prise en charge des Drive partagés.

  15. Cliquez sur Envoyer.

Demander le champ d'application drive.install

Pour autoriser les applications à apparaître en tant qu'option dans le menu "Ouvrir avec" ou "Nouveau", demandez l'étendue https://www.googleapis.com/auth/drive.install pour l'intégrer à l'interface utilisateur de Drive. Lorsque vous demandez cette étendue, les utilisateurs reçoivent une boîte de dialogue semblable à celle-ci:

Boîte de dialogue d'installation de l'interface utilisateur de Google Drive.
Figure 1. Boîte de dialogue d'installation lorsque vous utilisez des portées pour l'interface utilisateur de Drive.

Pour en savoir plus sur les habilitations que vous pouvez demander pour les applications Drive et comment les demander, consultez Informations sur l'autorisation et l'authentification spécifiques aux API.

Paramètre state

Par défaut, un paramètre state est ajouté à la fois à l'URL ouverte et à l'URL nouvelle pour transmettre des données de l'interface utilisateur de Drive à votre application. Ce paramètre contient une chaîne encodée au format JSON avec des variables de modèle et des données sur la requête envoyée à votre application. Les variables incluses dépendent du type d'URL utilisé (URL ouverte ou URL nouvelle):

Variable de modèle Description Application de l'URL
{ids} Liste des ID de fichiers ouverts, séparés par une virgule. Ouvrir l'URL
{exportIds} Liste d'ID de fichiers exportés, séparés par une virgule (utilisée uniquement lors de l'ouverture de documents Google intégrés). Ouvrir l'URL
{resourceKeys} Dictionnaire JSON des ID de fichier mappés à leurs clés de ressources respectives. Ouvrir l'URL
{folderId} ID du dossier parent. Nouvelle URL
{folderResourceKey} Clé de ressource du dossier parent. Nouvelle URL
{userId} ID de profil qui identifie l'utilisateur. URL d'ouverture et Nouvelle URL
{action} Action effectuée. La valeur est open lorsque vous utilisez une URL ouverte ou create lorsque vous utilisez une nouvelle URL. URL d'ouverture et Nouvelle URL

Le paramètre state est encodé au format URL. Votre application doit donc gérer les caractères d'échappement et l'analyser au format JSON. Les applications peuvent détecter la valeur create dans le paramètre state pour vérifier une requête de création de fichier.

Exemple d'informations d'état au format JSON pour une nouvelle URL

Les informations state pour une nouvelle URL sont les suivantes:

{
  "action":"create",
  "folderId":"FOLDER_ID",
  "folderResourceKey":"FOLDER_RESOURCE_KEY",
  "userId":"USER_ID"
}

Exemple d'informations d'état au format JSON pour une URL ouverte

Les informations state d'une URL ouverte sont les suivantes:

{
  "ids": ["ID"],
  "resourceKeys":{"RESOURCE_KEYS":"RESOURCE_KEYS"},
  "action":"open",
  "userId":"USER_ID"
}

Les ID et les clés de ressource permettent de récupérer les métadonnées des fichiers et de télécharger leur contenu. Une fois que votre application dispose de l'ID de fichier et d'un jeton d'accès, elle peut vérifier les autorisations, récupérer les métadonnées du fichier et télécharger le contenu du fichier, comme décrit dans la méthode files.get.

Une application installée doit pouvoir créer, gérer et ouvrir les actions lancées depuis l'interface utilisateur de Drive. Pour en savoir plus, consultez Intégrer le bouton "Nouveau " de l'UI Drive ou Intégrer le menu contextuel "Ouvrir avec " de l'UI Drive.