Configurer une intégration avec l'UI 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 Drive. La configuration est également requise pour lister votre application sur 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 l'intégration à l'interface utilisateur de Google Drive, vous devez activer l'API Drive. Cela vous donne accès à l'API et aux fonctionnalités d'intégration de l'UI.

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

  Activer l'API

Configurer l'intégration de l'UI Drive

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

   Accéder à la page "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'interface utilisateur Drive.
4. (Facultatif) Saisissez un nom dans le champ Nom de l'application. Le nom de l'application s'affiche dans l'onglet "Gérer les applications" des paramètres de Drive.
5. (Facultatif) Saisissez une brève description d'une ligne dans le champ Description courte. La description courte est présentée aux utilisateurs dans l'onglet "Gérer les applications" des paramètres 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.

   Remarque : Les icônes de document sont obsolètes. L'icône de votre application s'affiche à côté des fichiers de raccourcis et des fichiers de raccourcis tiers. Un ensemble d'icônes standards est utilisé pour les autres types de fichiers.

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 URL d'ouverture. 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 version publique et une version limité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 Le paramètre state.
   Avertissement : L'option permettant d'afficher automatiquement l'écran de consentement OAuth 2.0 est obsolète. Ne cochez pas cette case. L'application doit lancer toutes les demandes d'autorisation.

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 spécialement conçue pour ouvrir. 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 raccourcis ou des fichiers de raccourcis tiers, vous pouvez laisser le champ "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'images 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 raccourcis ou des fichiers de raccourcis tiers, vous pouvez laisser le champ "Type MIME" vide.

    Remarque : Si un utilisateur installe plusieurs applications Drive pouvant ouvrir un fichier, l'application installée le plus récemment est utilisée jusqu'à ce que l'utilisateur en choisisse une autre.

11. Pour utiliser le bouton "Nouveau " de l'interface utilisateur de Drive et permettre aux utilisateurs de créer un fichier avec votre application, cochez la case Création de 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 Le 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.

    Remarque : Laissez le champ "Nom du document" vide. Ce champ n'est plus utilisé.

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 niveau d'accès drive.install

Pour que les applications apparaissent comme une option dans le menu "Ouvrir avec" ou "Nouveau", demandez le champ d'application https://www.googleapis.com/auth/drive.install pour l'intégration à l'interface utilisateur de Drive. Lorsqu'ils demandent ce niveau d'accès, les utilisateurs voient s'afficher une boîte de dialogue semblable à celle-ci :

Figure 1. Boîte de dialogue d'installation lors de l'utilisation de champs d'application pour l'UI Drive.

Pour en savoir plus sur les champs d'application que vous pouvez demander pour les applications Drive et sur la manière de les demander, consultez Informations sur l'autorisation et l'authentification spécifiques aux API.

Remarque : Si vous publiez votre application Drive sur Google Workspace Marketplace, les utilisateurs et les administrateurs de domaine peuvent rechercher et installer l'application directement depuis Google Workspace Marketplace.

Paramètre state

Par défaut, un paramètre state est ajouté à l'URL d'ouverture et à la nouvelle URL pour transmettre les données de l'UI 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 adressée à votre application. Les variables incluses dépendent du type d'URL utilisé (URL d'ouverture ou nouvelle URL) :

Variable de modèle	Description	URL de l'application
{ids}	Liste d'ID de fichiers en cours d'ouverture, séparés par une virgule.	Ouvrir l'URL
{exportIds}	Liste d'ID de fichiers exportés, séparés par une virgule. Utilisé uniquement lors de l'ouverture de fichiers Google Workspace.	Ouvrir l'URL
{resourceKeys}	Dictionnaire JSON des ID de fichier mappés à leurs clés de ressource 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 en cours d'exécution. 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 valider 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 ressources sont utilisés pour récupérer les métadonnées des fichiers et 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.

Remarque : Toutes les applications, y compris celles qui ouvrent des fichiers à partir de raccourcis et de raccourcis tiers, doivent appeler la méthode files.get pour vérifier les autorisations de l'utilisateur pour un document. Les applications doivent avertir les utilisateurs en lecture seule lorsqu'ils ouvrent un fichier qu'ils ne peuvent pas modifier ni enregistrer (au lieu de les laisser passer du temps à le modifier, puis d'afficher une erreur lors de l'enregistrement).

Articles associés

Une application installée doit pouvoir créer, gérer et ouvrir des 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.