Cette page explique comment utiliser le SDK Google Workspace Marketplace pour configurer et gérer votre application sur le Google Workspace Marketplace.
Pour que votre application soit disponible, vous devez la configurer dans le SDK Marketplace. Le SDK Marketplace est un ensemble d'outils qui vous permet de créer et de contrôler votre application sur le Marketplace. Le SDK Marketplace vous permet de gérer les paramètres Marketplace, tels que les suivants :
- Indiquez si votre application est disponible pour une organisation Google Workspace spécifique (application privée) ou pour tous les utilisateurs Marketplace (application publique).
- Types d'utilisateurs Marketplace pouvant installer votre application
- Les applications Google Workspace avec lesquelles votre application s'intègre
- les habilitations OAuth requises par votre application ;
- Informations sur le développeur et le responsable de la maintenance de l'application
Que vous publiiez votre application de manière privée ou publique, vous devez utiliser le SDK Marketplace pour la gérer sur le Marketplace.
Activer le SDK Marketplace
Si vous ne l'avez pas déjà fait, activez le SDK Marketplace dans votre projet Google Cloud.
Ouvrez votre projet Cloud dans la console Google Cloud.
Si ce n'est pas déjà fait, ouvrez le projet Cloud que vous souhaitez utiliser pour cet exemple :
- Dans la console Google Cloud, accédez à la page Sélectionner un projet.
- Sélectionnez le projet Google Cloud que vous souhaitez utiliser. Vous pouvez également cliquer sur Créer un projet et suivre les instructions à l'écran. Si vous créez un projet Google Cloud, vous devrez peut-être activer la facturation pour ce projet.
Activer le SDK Marketplace
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.Dans la console Google Cloud, activez le SDK Google Workspace Marketplace.
Déterminer les paramètres de configuration de votre application
La référence suivante décrit les paramètres disponibles sur la page Configuration de l'application du SDK Marketplace.
Choisir qui peut voir et installer votre application
Lorsque vous configurez votre application, vous spécifiez les utilisateurs qui peuvent y accéder à l'aide des paramètres suivants :
- Visibilité de l'application : si vous publiez une application dans une organisation Google Workspace, indiquez si sa fiche est non répertoriée, visible par tous les utilisateurs de votre organisation ou par toute personne utilisant Google Workspace.
- Paramètres d'installation : indique si l'application ne peut être installée que par les administrateurs Google Workspace.
Quels que soient les paramètres que vous spécifiez dans la fiche de votre application, il est possible que les utilisateurs appartenant à une organisation Google Workspace ne puissent pas découvrir, installer ni utiliser votre application en fonction des paramètres définis par leurs administrateurs. Les administrateurs peuvent avoir un impact sur la disponibilité de votre application de différentes manières :
- Contrôlez si vos utilisateurs peuvent afficher des applications sur le Marketplace et en installer en leur nom.
- Utilisez une liste d'autorisation pour gérer et sélectionner des applications pour leur organisation. Si vous développez une application pour une organisation qui utilise des listes d'autorisation, demandez à un administrateur d'ajouter l'application à la liste d'autorisation.
- Désactiver certaines applications Google Workspace, par exemple en supprimant l'accès à Google Chat, aux applications Google Chat ou aux deux. Dans ce cas, les utilisateurs ne pourront pas installer votre application depuis le Marketplace.
Pour savoir comment les administrateurs gèrent l'accès à Marketplace, consultez la documentation d'aide pour les administrateurs Marketplace.
Paramètres de visibilité de l'application
L'option Visibilité des applications s'affiche si vous utilisez un compte Google Workspace (un compte créé par votre entreprise ou votre établissement scolaire). Si vous utilisez un compte personnel (un compte se terminant par "@gmail.com"), vous ne pouvez publier que publiquement.
- Publique : l'application peut être trouvée et installée par des personnes externes à votre domaine. Si vous choisissez la visibilité publique, Google examine et approuve la fiche de votre application avant sa publication.
- Privée : seuls les utilisateurs de votre domaine peuvent trouver et installer votre application.
Si vous choisissez de publier votre fiche d'application comme non répertoriée, elle n'apparaîtra pas dans les résultats de navigation ni de recherche. Les utilisateurs ne peuvent accéder à la page Store de l'application qu'avec l'URL directe.
Si vous souhaitez limiter les pays et régions dans lesquels votre application est disponible, vous pouvez le faire dans la section Distribution lorsque vous créez la fiche Play Store.
Paramètres d'installation des applications
L'option Paramètres d'installation détermine si les utilisateurs ou les administrateurs Google Workspace peuvent installer votre application à partir de la page de votre fiche Play Store sur le Marketplace.
- Installation individuelle + administrateur (par défaut) : l'application peut être installée par des utilisateurs individuels ou par des administrateurs pour leur domaine, leur unité organisationnelle ou un groupe d'utilisateurs. Il est possible que les règles du domaine d'un utilisateur l'empêchent d'installer une application, même si les installations individuelles sont activées.
- Installation réservée aux administrateurs : l'application ne peut être installée que par les administrateurs pour leur domaine, leur unité organisationnelle ou un groupe d'utilisateurs. Votre application ne s'affiche dans les résultats de recherche Google Workspace Marketplace que pour les administrateurs et les personnes qui ne sont pas connectées à leur compte Google. Choisissez cette option si votre application nécessite l'installation d'un domaine.
Paramètres d'installation et de visibilité courants
Le tableau suivant récapitule certaines des options de configuration d'application courantes pour l'installation et la visibilité :
Utilisateurs de l'application visés | Paramètre Visibilité de l'application | Paramètre Installation d'applications | Qui peut installer mon application ? | Qui peut utiliser mon application ? | |
---|---|---|---|---|---|
Pour les applications conçues pour une organisation Google Workspace | |||||
Utilisateurs spécifiques de votre organisation | Privée et Non répertoriée | Installation individuelle + administrateur | Si cela est autorisé, toute personne de votre organisation disposant de l'URL de la fiche de l'application. | Si cela est autorisé, toute personne de votre organisation disposant de l'URL de la fiche de l'application. | |
Votre entreprise | Privé | Installation individuelle + administrateur | Si cela est autorisé, tous les membres de votre organisation. | Si cela est autorisé, tous les membres de votre organisation. | |
Votre entreprise | Privé | Administrateurs uniquement | Administrateurs | Utilisateurs ayant installé l'application par le biais de leur administrateur. | |
Pour les applications disponibles pour les utilisateurs en dehors d'une organisation Google Workspace spécifique | |||||
Utilisateurs dans les organisations Google Workspace | Publique | Administrateurs uniquement | Administrateurs | Utilisateurs ayant installé l'application par le biais de leur administrateur. | |
Tous les utilisateurs de Google Workspace | Publique | Installation individuelle + administrateur |
|
|
Identifier comment votre application s'intègre aux applications Google Workspace
Choisissez les services Google Workspace pour lesquels votre application ou module complémentaire doit fonctionner, comme un module complémentaire Google Workspace ou une application Google Chat. Vous devez choisir au moins une option. Dans certains cas, vous pouvez inclure plusieurs intégrations d'applications dans votre fiche d'application. Consultez Lister les intégrations d'applications.
En fonction des intégrations d'applications que vous choisissez, vous devrez peut-être fournir des informations supplémentaires et activer les API correspondantes dans votre projet Google Cloud. Le tableau suivant décrit la configuration supplémentaire requise pour chacun d'eux :
Module complémentaire Google Workspace
Pour publier un module complémentaire Google Workspace, vous devez fournir son ID de déploiement.
Pour trouver l'ID de déploiement dans Apps Script, procédez comme suit :
- Ouvrez votre module complémentaire Google Workspace dans l'éditeur Apps Script.
- Cliquez sur Déployer > Gérer les déploiements.
- Sous l'ID de déploiement, cliquez sur Copier.
Pour trouver l'ID de déploiement d'un module complémentaire HTTP, procédez comme suit :
- Sur la page "Configuration de l'application", sous "Module complémentaire Google Workspace", cliquez sur Déploiements HTTP ou autres > Sélectionner le déploiement.
- Sélectionnez le déploiement que vous souhaitez publier.
- Cliquez sur Sélectionner.
Module complémentaire de l'éditeur (Docs, Sheets, Slides, Forms)
Pour publier un module complémentaire de l'éditeur, vous devez fournir l'ID du script du projet et la version que vous souhaitez publier.
Pour trouver l'ID du script du projet, procédez comme suit :
- Ouvrez le module complémentaire dans l'éditeur Apps Script.
- À gauche, cliquez sur Paramètres du projet .
- Sous "ID", copiez l'ID du script.
Pour trouver la version, procédez comme suit :
- Ouvrez le module complémentaire dans l'éditeur Apps Script.
- En haut à droite, cliquez sur Déployer > Gérer les déploiements.
- Le numéro de version se trouve sous "Configuration".
Application Google Chat
Pour publier une application Google Chat interactive, consultez la documentation suivante :
- Si vous avez créé votre application Chat en tant que module complémentaire, vous devez configurer les paramètres du module complémentaire dans l'API Chat. Pour en savoir plus, consultez Configurer une application Chat dans la documentation sur les modules complémentaires Google Workspace.
- Si vous avez créé votre application Chat à l'aide d'événements d'interaction, vous devez configurer les paramètres des événements d'interaction dans l'API Chat. Pour en savoir plus, consultez Recevoir et répondre aux événements d'interaction dans la documentation de l'API Chat.
- Si vous avez créé votre application Chat avec la configuration automatique d'AppSheet, publiez-la en suivant la procédure décrite dans la documentation AppSheet, Partager votre application Chat avec la configuration automatique.
Application Drive
Pour publier une application Drive, vous devez activer et configurer l' API Google Drive.
Application Web
Pour publier une application Web, vous devez fournir son URL de navigation universelle, c'est-à-dire l'URL qui pointe vers l'application Web depuis le menu des applications Google
. Votre application Web doit être en production et entièrement fonctionnelle.Lorsque vous remplissez la page de la fiche Play Store, vous devez fournir des icônes supplémentaires de dimensions 96 x 96 et 48 x 48 pixels.
Si vous avez créé votre application Web dans Apps Script, suivez ces étapes pour obtenir l'URL de navigation universelle :
- Ouvrez votre module complémentaire Google Workspace dans l'éditeur Apps Script.
- Cliquez sur Déployer > Nouveau déploiement.
- Sous "Sélectionner un type", cliquez sur Application Web.
- Remplissez les options, puis cliquez sur Déployer.
- Cliquez sur Copier.
Spécifier le niveau d'accès requis par votre application
Sous Niveaux d'accès OAuth, fournissez la liste complète des niveaux d'accès OAuth 2.0 requis par votre application. Les niveaux d'accès OAuth que vous saisissez ici doivent correspondre à ceux que vous affichez sur votre écran de consentement OAuth et, le cas échéant, dans le fichier manifeste Apps Script.
Si vous incluez plusieurs intégrations d'applications, assurez-vous d'ajouter les niveaux d'accès de chacune d'elles à la page de configuration de l'application du SDK Marketplace et à votre écran de consentement OAuth.
Utilisez toujours les niveaux d'accès les plus restreints possible (par exemple, n'incluez pas un niveau d'accès Drive complet si vous n'avez besoin que d'un niveau d'accès en lecture seule).
Pour les projets Apps Script, consultez Champs d'application de l'autorisation pour en savoir plus.
Fournir des informations sur le développeur de l'application
Sous Informations sur le développeur, saisissez vos coordonnées et d'autres informations. Ces champs apparaissent sur la page de la fiche Play Store de votre application.
Champs | |
---|---|
Statut de commerçant |
Conformément à la législation sur la protection des consommateurs de l'Espace économique européen (EEE), il doit être indiqué si les marchands de la place de marché sont des commerçants ou des non-commerçants :
Si vous ne le précisez pas, la mention "Statut de marchand non spécifié" s'affichera sur la page de la fiche Play Store de votre application. |
Nom du développeur | Nom à afficher en tant qu'auteur de l'application. Si vous êtes un marchand, indiquez votre nom commercial ou votre nom légal. |
Adresse postale du développeur |
Obligatoire pour les traders. Non collectées pour les non-professionnels. L'adresse de votre entreprise Saisissez une adresse postale de contact valide. |
URL du site Web du développeur | Site Web vous décrivant (ou décrivant votre organisation) en tant que développeur. |
Adresse e-mail du développeur |
Adresse e-mail à utiliser comme point de contact. Il n'est pas inclus dans la fiche de votre application. Veillez à ce que cette adresse e-mail soit à jour, car elle est utilisée :
|
URL du site Web de l'application | Facultatif. Site Web qui décrit plus en détail votre application. |
Enregistrer les paramètres de configuration de votre application dans le SDK Marketplace
En utilisant les informations de la section précédente, enregistrez la configuration de votre application dans le SDK Marketplace :
Dans la console Google Cloud, accédez à la page Configuration de l'application du SDK Marketplace :
Remplissez chaque section en fonction de ce que vous avez déterminé dans la section précédente.
Cliquez sur Enregistrer le brouillon.
(Facultatif) Vous pouvez obtenir des données analytiques sur l'utilisation de l'application dans Google Analytics. Pour ce faire, ajoutez un ID Google Analytics dans le SDK Marketplace.
- Accédez à l'onglet Analytics.
- Saisissez votre ID Google Analytics.
- Cliquez sur Enregistrer.
Résoudre les problèmes
Cette section décrit les problèmes courants que vous pouvez rencontrer.
Autorisations requises manquantes lors de la publication d'applications sur Marketplace
Vous ne pouvez pas publier d'applications sur le Marketplace, car les tentatives de configuration de l'application sur la page "Configuration de l'application" du SDK Marketplace échouent et le message d'erreur suivant s'affiche :
You are missing at least one of the following required permissions: Project workspacemarketplace.appconfiguration.view / workspacemarketplace.appconfiguration.update
Cette erreur se produit lorsque l'API Marketplace SDK est activée et que vous utilisez un rôle IAM autre que Editor
ou Owner
.
Pour résoudre cette erreur, mettez en œuvre l'une des solutions suivantes :
Demandez au propriétaire du projet d'attribuer le rôle
roles/appmetadata.workspaceMarketplaceAppConfigurationAdmin
au compte auquel il manque des autorisations pour lui permettre de configurer et de gérer l'application dans le SDK Marketplace.Demandez au propriétaire du projet d'ajouter les autorisations manquantes à un rôle personnalisé sur la page IAM et administration > Rôles de la console Google Cloud. Attribuez ensuite le rôle personnalisé au compte auquel il manque des autorisations.
Les primitives
roles/editor
ouroles/owner
peuvent être utilisées pour publier des applications. Toutefois, la documentation Utiliser IAM de manière sécurisée considère qu'il s'agit d'une mauvaise pratique, car il n'est pas facile de limiter l'accès en modification à d'autres ressources du projet.