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 l'interface utilisateur de Drive. Une configuration est également requise pour répertorier votre application 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'interface utilisateur de Google Drive, vous devez activer l'API Drive. Vous aurez ainsi accès à l'API et aux fonctionnalités d'intégration de l'interface utilisateur.

• 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 APIs, accédez à Menu > API et services > API et services activés.

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

2. Au 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 pour les utilisateurs dans l'onglet "Gérer les applications" des paramètres de Drive.
5. (Facultatif) Saisissez une brève description sur une ligne dans le champ Description courte. La brève description s'affiche pour les 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 raccourcis et des fichiers de raccourcis tiers. Un ensemble d'icônes standards est utilisé pour d'autres types de fichiers.

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

   • 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 répertorier votre application dans 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 Drive à votre application. Pour en savoir plus sur le contenu du paramètre state, consultez la section Paramètre state.
   Avertissement :L'option permettant d'afficher automatiquement l'écran d'autorisation OAuth 2.0 est obsolète. Ne cochez pas cette case. L'application doit démarrer toutes les requêtes d'autorisation.

9. (Facultatif) Saisissez les types MIME par défaut et les extensions de fichier 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. Par exemple, votre application peut ouvrir un format intégré pour superposer et modifier des images. N'incluez que des types de médias standards et assurez-vous qu'ils ne contiennent pas de fautes de frappe ni d'orthographe. Si votre application ouvre uniquement des fichiers de raccourcis ou de raccourcis tiers, vous pouvez laisser le type MIME vide.

10. (Facultatif) Saisissez des types MIME secondaires et des extensions de fichier dans les champs Types MIME secondaires et Extensions de fichier secondaires. Les types MIME secondaires et les extensions de fichier représentent les fichiers que votre application peut ouvrir, mais 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 médias standards et assurez-vous qu'ils ne contiennent pas de fautes de frappe ni d'orthographe. Si votre application ouvre uniquement des fichiers de raccourcis ou de raccourcis tiers, vous pouvez laisser le type MIME vide.

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

11. Pour utiliser le bouton "Nouveau " de l'interface utilisateur 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 répertorier votre application dans 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 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.

    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 les fichiers des Drive partagés, cochez la case Compatibilité avec les Drive partagés. Pour en savoir plus sur la compatibilité des Drive partagés dans votre application, consultez la page Mettre en œuvre la compatibilité des Drive partagés.

15. Cliquez sur Envoyer.

Demander le champ d'application drive.install

Pour autoriser l'affichage des applications dans le menu "Ouvrir avec" ou "Nouveau", demandez le champ d'application https://www.googleapis.com/auth/drive.install à intégrer à l'interface utilisateur Drive. Lorsqu'ils demandent ce champ d'application, les utilisateurs reçoivent 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'interface utilisateur Drive.

Pour en savoir plus sur les champs d'application que vous pouvez demander pour les applications Drive et sur la procédure à suivre, consultez la page Informations sur les autorisations 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 la rechercher et l'installer directement depuis Google Workspace Marketplace.

Paramètre state

Par défaut, un paramètre state est ajouté à la fois à l'URL ouverte et à la nouvelle URL pour transmettre les données de l'interface utilisateur de Drive à votre application. Ce paramètre contient une chaîne encodée 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 ouverte ou nouvelle URL):

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

Le paramètre state est encodé au format URL. Par conséquent, votre application doit gérer les caractères d'échappement et les 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 sur l'état au format JSON pour une nouvelle URL

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

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

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

Les informations state pour 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 permettent de récupérer les métadonnées d'un fichier et de télécharger son 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 concernant 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 à 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 à partir de l'interface utilisateur de Drive. Pour en savoir plus, consultez Intégration avec le bouton "Nouveau " de l'interface utilisateur Drive ou Menu contextuel "Ouvrir avec " de l'interface utilisateur Drive.