Configuration d'un projet Google Cloud

Cette page contient les informations dont vous avez besoin pour créer et configurer des projets Google Cloud pour les modules complémentaires Classroom. Les projets Google Cloud permettent d'implémenter l'authentification unique Google via OAuth 2.0 (Google SSO), d'autoriser les requêtes effectuées par votre module complémentaire et de gérer la fiche d'un module complémentaire dans la boutique Google Workspace Marketplace.

Pour en savoir plus sur la publication d'un module complémentaire sur Marketplace, consultez Publier une application.

Création de projets Google Cloud

Point clé :La visibilité publique de votre application complémentaire de production doit être définie dans le SDK Google Workspace Marketplace. Un projet privé peut être utile pour développer et tester votre module complémentaire, mais seul un projet public est requis.

Il existe deux types de projets à créer: un projet privé utilisé pour le développement et un projet public accessible par les utilisateurs finaux. Les libellés "public" et "privé" font référence à la visibilité de votre application dans Google Workspace Marketplace. Une application Marketplace privée ne peut être installée que par des utilisateurs du domaine dans lequel elle a été créée, tandis qu'une application Marketplace publique est disponible pour n'importe quel domaine Google Workspace. Il doit s'agir de deux applications distinctes, car un projet ne peut pas être à la fois public et privé. Les applications publiques doivent être examinées et approuvées avant d'être disponibles sur la place de marché.

Important :Vous ne pouvez pas convertir un projet privé en projet public.

Pour obtenir des informations générales sur la création d'un projet Google Cloud, consultez la page Créer un projet Google Cloud.

Créer un projet Google Cloud public

Ce projet représente le module complémentaire accessible par les administrateurs, les enseignants et les élèves. Un projet public doit être examiné et approuvé par l'équipe Google Workspace Marketplace avant de pouvoir être lancé ou installé.

1. Créez un projet Google Cloud dans votre domaine de production.

   Créer un projet Google Cloud

   Important:Assurez-vous que le projet appartient à votre domaine de production et que vous êtes connecté à la console Google Cloud en tant qu'utilisateur de ce domaine.
   Avertissement:Vous devez utiliser la version Brouillon de votre projet pour les tests. Pour le moment, cette fonctionnalité n'est disponible que via le programme Preview développeur Google Workspace. Après avoir créé votre projet Cloud, remplissez le formulaire de demande pour activer les fonctionnalités du programme Preview développeur Google Workspace. Pour en savoir plus, consultez Mettre à jour la fiche de votre application avec des brouillons.

2. activer l'API Classroom dans votre projet Cloud ;

   Activer l'API Classroom

3. Activez le SDK Google Workspace Marketplace dans votre projet Cloud.

   Activer le SDK Google Workspace Marketplace

4. Définissez la configuration de l'application Visibilité de l'application du SDK Marketplace sur Publique et cochez la case Non répertoriée.

   Important:Vous ne pouvez pas partager ni convertir un projet privé utilisé lors des phases de développement et de test internes.
   Important:Vous ne pouvez pas trouver les applications non répertoriées sur Google Workspace Marketplace en parcourant le site ou en y faisant une recherche. Dans la configuration du SDK Marketplace, vous trouverez une URL directe permettant d'installer le module complémentaire. Seuls Google et le développeur peuvent trouver cette fiche. Votre application doit rester non répertoriée jusqu'à ce que vous décidiez de la proposer au grand public. Vous pouvez activer ou désactiver l'affichage d'un module complémentaire sur la page "Configuration de l'application" du SDK Marketplace.

5. Renseignez les champs obligatoires sur la page Fiche Play Store du SDK Marketplace, puis cliquez sur PUBLIER.

6. Votre application sera examinée par l'équipe Google Workspace Marketplace. Il vous contactera à l'aide de l'adresse e-mail de développeur spécifiée dans le SDK Marketplace. Une fois l'application approuvée, décochez la case Non répertoriée pour que les enseignants et les administrateurs puissent la trouver sur Marketplace.

Créer un projet Google Cloud privé

Ce projet privé représente l'application complémentaire utilisée pour le développement. Il n'est pas accessible aux utilisateurs extérieurs au domaine dans lequel il a été créé, mais il n'a pas besoin d'être approuvé avant l'installation. Par conséquent, Google vous recommande d'utiliser ce projet pour développer et tester votre module complémentaire dans un environnement contrôlé.

Pour créer un projet privé, vous devez avoir accès à un domaine Google Workspace for Education disposant d'une licence Teaching and Learning Upgrade ou Plus. Si vous n'avez pas encore accès à un domaine de ce type, procédez comme suit pour configurer un domaine de démonstration Google Workspace for Education, le mettre à niveau vers une licence Plus et l'autoriser à accéder à l'API des modules complémentaires Classroom:

1. Suivez la procédure permettant d'obtenir un domaine test de développeur.

2. Lorsque vous êtes connecté en tant qu'administrateur dans le domaine de démonstration, créez un projet Google Cloud.

   Créer un projet Google Cloud

   Avertissement :Assurez-vous que le projet appartient au domaine de démonstration et que vous êtes connecté à la console Google Cloud à l'aide d'un compte administrateur de ce domaine.

   Si vous ne pouvez pas accéder à la console Google Cloud ou créer des projets Cloud, vérifiez les points suivants dans la console d'administration:

   • Accédez à la page Paramètres de compte > Paramètres d'accès basés sur l'âge, puis sélectionnez l'option Tous les utilisateurs de ce groupe ou de cette unité organisationnelle ont 18 ans ou plus.
   • Sous Applications > Services Google supplémentaires:
   • Google Cloud Platform est activé pour tous.
   • Les paramètres de création des projets sont Autoriser les utilisateurs à créer des projets.
   • Les paramètres d'accès à Cloud Shell sont Autoriser l'accès à Cloud Shell.

3. Remplissez et envoyez le formulaire de demande de mise à niveau de domaine de démonstration. Lorsque vous envoyez ce formulaire, Google demande à Google de mettre à niveau votre domaine de démonstration vers Google Workspace for Education Plus, qui dispose de 10 licences. Votre projet Cloud est alors autorisé à utiliser l'API des modules complémentaires Classroom.

   Vous recevrez un e-mail une fois les processus de mise à niveau et de liste d'autorisation terminés. Attribuez des licences Plus à vos comptes enseignant test dans la console d'administration. Sous Annuaire > Utilisateurs, créez ou sélectionnez vos comptes enseignant test. Dans les licences de chaque enseignant, vérifiez que Google Workspace for Education Plus est défini sur Attribué.

4. activer l'API Classroom dans votre projet Cloud ;

   Activer l'API Classroom

5. Activez le SDK Google Workspace Marketplace dans votre projet Cloud.

   Activer le SDK Google Workspace Marketplace

6. Définissez la configuration de l'application Visibilité de l'application du SDK Marketplace sur privée.

7. Renseignez les champs obligatoires sur la page Fiche Play Store du SDK Marketplace, puis cliquez sur PUBLIER. Une fois la fiche de l'application publiée, les utilisateurs du domaine peuvent la trouver et l'installer sur Google Workspace Marketplace ou en accédant à l'URL de l'application indiquée sur la fiche Play Store.

OAuth 2.0

L'accès à l'API Classroom nécessite une autorisation pour accéder aux données utilisateur. Celles-ci sont obtenues en demandant à Google l'accès aux champs d'application OAuth pour l'utilisateur connecté et en recevant un jeton qui peut être utilisé pour effectuer ensuite des appels d'API vers Google Classroom. Les niveaux d'accès doivent être configurés sur la fiche Play Store de Google Workspace Marketplace afin que l'administrateur du domaine puisse donner son consentement au nom des utilisateurs de leur domaine s'ils installent le module complémentaire.

Important :Si votre module complémentaire demande des champs d'application supplémentaires, incluez-les sur l'écran de consentement OAuth, l'onglet "Configuration de l'application du SDK Marketplace" et le code d'application de votre module complémentaire. Des champs d'application incohérents dans ces emplacements peuvent entraîner des problèmes pour les utilisateurs lors de l'installation du module complémentaire.

Consultez la page Champs d'application OAuth pour les API Google pour obtenir une liste détaillée de tous les champs d'application disponibles et de leurs utilisations. Consultez la page Configurer OAuth dans la documentation de l'espace de travail pour obtenir des informations générales sur la configuration OAuth.

Autorisations des utilisateurs

Votre application Web doit demander au moins l'une des habilitations suivantes:

• https://www.googleapis.com/auth/userinfo.email, qui permet à une application d'afficher l'adresse e-mail de l'utilisateur.
• https://www.googleapis.com/auth/userinfo.profile, qui permet à une application d'accéder à des informations personnelles telles que le portrait, les prénoms et les noms, ainsi que d'autres informations personnelles que l'utilisateur a rendues publiques.

Une fois qu'un utilisateur a autorisé l'un de ces champs d'application dans votre module complémentaire, il est identifié par le paramètre de requête login_hint. Ce paramètre est transmis à l'une des URL de votre application Web lorsqu'un iFrame est ouvert. Si un utilisateur n'a pas autorisé l'un de ces champs d'application, login_hint n'est pas envoyé.

Avertissement :Votre application doit demander au moins l'un des champs d'application userinfo.email ou userinfo.profile afin de recevoir login_hint lors des visites suivantes du même utilisateur.

login_hint est un paramètre OpenID Connect standard que vous pouvez éventuellement transmettre à Google lorsque vous utilisez Google Sign-In ou demandez un jeton OAuth. Elle est destinée à faciliter l'expérience d'autorisation pour l'utilisateur final.

Habilitations des modules complémentaires Classroom

Les champs d'application suivants sont spécifiques aux modules complémentaires Classroom:

• https://www.googleapis.com/auth/classroom.addons.teacher, qui permet d'accéder à toutes les méthodes de l'API.
• https://www.googleapis.com/auth/classroom.addons.student, qui permet d'accéder au lancement des opérations de validation et de lecture des pièces jointes.

Même avec un jeton d'accès OAuth valide indiquant les identifiants de l'utilisateur, les appels d'API sont contrôlés par des exigences supplémentaires:

• Toutes les méthodes nécessitent que l'utilisateur soit enseignant ou élève dans le cours spécifié par le courseId de la requête.
• L'utilisateur doit être enseignant pour créer, mettre à jour, supprimer et renvoyer des notes.
• Les appels vers un post Google Classroom spécifique sont contrôlés par les vérifications suivantes.
  • Lorsqu'un module complémentaire comporte déjà au moins une pièce jointe à un post, il peut envoyer des requêtes pour :
    • validation du lancement de l'iFrame
    • Opérations de lecture, de mise à jour et de suppression des pièces jointes
    • Noter les mises à jour sur ce post
  • Lorsque vous ouvrez l'iFrame de découverte de pièces jointes pour la première fois, il est possible que le module complémentaire ne comporte pas encore de pièce jointe au post. Un paramètre de requête addOnToken est fourni et peut être utilisé pour envoyer des requêtes pour les éléments suivants :
    • Créer une pièce jointe sous le post (addOnToken obligatoire)
    • Lancer la validation (addOnToken est validé s'il est fourni et est requis lorsque le module complémentaire ne comporte pas de pièce jointe au post)

Validation OAuth

Remarque :Vous ne pouvez pas créer de vidéo de démonstration à envoyer dans le cadre du processus de validation OAuth. À la place, publiez le module complémentaire sans valider OAuth. L'équipe d'examinateurs de Google Workspace Marketplace est alors alertée pour qu'elle réalise une vidéo de démonstration en votre nom. L'équipe d'examinateurs vous fournit ensuite la vidéo afin que vous puissiez l'inclure dans votre demande de validation OAuth.

Les modules complémentaires Classroom accèdent aux données des utilisateurs Google à l'aide des API Google.

• Validez l'identité de votre marque.
• Validez les champs d'application OAuth sensibles.

Pour en savoir plus sur le processus de validation, consultez les questions fréquentes sur la validation de l'API OAuth.

Fiche Google Workspace Marketplace

Avertissement :Une fois que vous avez enregistré votre option de visibilité pendant le processus de publication, vous ne pourrez plus la modifier.

Pour obtenir des informations générales sur la configuration du SDK Google Workspace Marketplace, consultez Activer et configurer le SDK Google Workspace Marketplace et Créer une fiche Play Store Google Workspace Marketplace.

Remarques concernant les listes

La liste du SDK Marketplace Store de votre projet Google Cloud public spécifie le nom de votre application et les descriptions destinées aux utilisateurs finaux. Vous pouvez fournir ces informations dans plusieurs langues sous Informations sur l'application.

Respectez les consignes suivantes dans vos fiches:

• Sous Informations sur l'application:

  • Évitez d'utiliser des signes de ponctuation dans le nom de l'application. Par exemple, utilisez "My Add-on by My Company" (Mon module complémentaire par Mon entreprise) au lieu de "My Company: Mon module complémentaire" ou "Mon module complémentaire, par Mon entreprise".

  • Les champs Short Description (Description courte) et Detailed Description (Description détaillée) ne doivent pas contenir exactement le même texte.

  + Assurez-vous d'avoir sélectionné une valeur pour le champ Pricing (Tarification). Ce champ comprend les options Sans frais, Payant avec un essai sans frais, Payant avec des fonctionnalités sans frais et Payant. Vous n'avez pas besoin de spécifier le montant du coût sur la fiche Marketplace.

  • Assurez-vous d'avoir sélectionné une valeur pour le champ Catégorie. Les ressources pédagogiques et les outils pour les enseignants et les administrateurs peuvent être de bons choix pour les modules complémentaires Classroom.

  • Pour en savoir plus, consultez les éléments listés dans la description des détails de l'application de Marketplace.

Important :Consultez les informations sur l'application pour chaque langue dans laquelle vous proposez votre module complémentaire.

• Sous Éléments graphiques:

  • Les éléments graphiques fournis ne sont pas flous et respectent la taille spécifiée dans les normes de Google Workspace Marketplace.

  • Les captures d'écran fournies sont des représentations précises de votre expérience avec le module complémentaire.

• Sous Liens d'aide:

  • Assurez-vous d'avoir fourni un lien vers les Conditions d'utilisation de votre application.

• Vérifiez que vous respectez les Consignes relatives à la marque des API Google, qui couvrent les noms et les descriptions autorisés.

• Si votre fiche fait référence à des produits Google, utilisez le nom de l'un ou l'autre de ces produits en respectant le format indiqué dans la liste des marques de commerce. Assurez-vous d'inclure le symbole de marque (TM) s'il est indiqué. Utilisez "Google DocsTM", et non "Google Docs".

Intégration aux services de gestion des licences et de facturation de Google

Si vous souhaitez intégrer vos applications Google Workspace Marketplace aux services de gestion de licences et de facturation de Google, consultez l' API Marketplace.

Paramètres d'installation

Les modules complémentaires peuvent permettre une installation individuelle en plus de l'installation par un administrateur. Cette page présente certaines différences entre les deux types d'installation. Elle n'est pas destinée à promouvoir l'un ou l'autre type. Vous pouvez choisir d'autoriser ou non l'installation individuelle sur la page de configuration de l'application du SDK Google Workspace Marketplace.

Installation par l'administrateur

Les installations administrateur permettent à un administrateur d'ajouter un module complémentaire à tous les comptes d'un domaine, ou à des groupes d'accès ou des unités organisationnelles spécifiques. Seul un administrateur de domaine peut effectuer une installation administrateur. L'administrateur peut éventuellement autoriser tous les niveaux d'accès au nom de tous les utilisateurs du domaine. Les utilisateurs ne sont pas invités à autoriser les niveaux d'accès s'il le décide.

Voici quelques éléments à prendre en compte concernant l'installation par l'administrateur.

• Des commandes plus serrées Les administrateurs peuvent limiter les utilisateurs autorisés à accéder à un module complémentaire.
• Compatibilité avec les licences. Si votre application nécessite une licence, la gestion des installations par un administrateur peut aider à garantir que les licences sont distribuées et utilisées de manière appropriée avec l'établissement correspondant.
• Allégez la charge de travail des utilisateurs finaux. L'installation par un administrateur réduit la charge de configuration pour les enseignants et les élèves. Cela peut offrir une expérience utilisateur plus fluide, avec moins de clics et moins de risques de confusion.

Pour en savoir plus sur la procédure d'installation par les administrateurs et sur le fonctionnement de la structure organisationnelle, consultez Installer des applications Marketplace dans votre domaine pour en savoir plus sur les unités organisationnelles et les groupes d'accès.

Installation individuelle

Les installations individuelles ajoutent un module complémentaire au compte de l'utilisateur. L'utilisateur est invité à autoriser les niveaux d'accès du module complémentaire lors de l'installation.

Voici quelques éléments à prendre en compte concernant l'installation individuelle.

• Faciliter l'adoption Davantage d'utilisateurs peuvent voir et installer votre module complémentaire depuis Google Workspace Marketplace. Autoriser l'installation individuelle peut inciter davantage d'enseignants à adopter ou à promouvoir votre produit.
• Tests administrateur. Un administrateur peut installer individuellement un module complémentaire pour le tester ou l'évaluer avant de l'approuver ou de l'installer pour un groupe plus large.

En plus d'installer des modules complémentaires pour le compte des utilisateurs, les administrateurs peuvent également gérer une liste d'autorisation pour permettre aux utilisateurs d'installer des modules complémentaires permettant une installation individuelle. Si un module complémentaire ne figure pas dans la liste d'autorisation, les utilisateurs peuvent toujours voir sa fiche dans Google Workspace Marketplace, mais ne peuvent pas l'installer. À la place, un message leur indique que l'installation du module complémentaire n'a pas été autorisée par un administrateur de domaine. Pour en savoir plus sur ce comportement, consultez Gérer les applications Google Workspace Marketplace figurant sur votre liste d'autorisation.

Pour en savoir plus, consultez la documentation sur les paramètres d'installation de Google Workspace Marketplace.

Intégration d'une application

Vous devez indiquer une URL iFrame de lancement dans le champ URI de configuration des pièces jointes. Cette URL est utilisée comme valeur de l'iFrame src pour l'iFrame de découverte de pièces jointes. L'iFrame de découverte de pièces jointes permet aux enseignants de rechercher du contenu ou des activités à joindre à leur devoir.

Vous devez également spécifier tous les préfixes d'URI à partir desquels les rattachements sont autorisés à partir de votre module complémentaire. Cette fonctionnalité renforce la sécurité en empêchant les pièces jointes provenant de sources non autorisées.

Pour en savoir plus sur ces champs, consultez le guide sur les cadres iFrame.

Comptes de test

Créez des comptes de test sur votre domaine de démonstration pour vérifier le comportement correct de votre module complémentaire privé. Deux comptes élève sont nécessaires pour tester le passage d'un élève à un autre dans l'iFrame de révision des devoirs des élèves.

Comptes de test suggérés:

• Marie, enseignante, tammy.Teacher@<votre domaine de démonstration>
• Sam Étudiant, sam.student@<votre domaine de démonstration>
• Étudiante Sally, sally.student@<votre domaine de démonstration>

Pour créer un compte de test, procédez comme suit:

1. Connectez-vous à votre console d'administration.
2. Accédez à Utilisateurs.
3. Cliquez sur Add new user (Ajouter un utilisateur) (voir la figure 1).
4. Saisissez les informations sur l'utilisateur et attribuez-lui les rôles appropriés.

Figure 1. Emplacement du lien Ajouter un utilisateur dans la console d'administration.

Pour créer un groupe de test, procédez comme suit:

1. Connectez-vous à votre console d'administration.
2. Accédez à Groupes.
3. Cliquez sur Create group (Créer un groupe) (voir figure 2).
4. Saisissez les membres et les propriétaires du groupe.

Figure 2. Emplacement du lien Créer un groupe dans la console d'administration.