Configuration d'un projet Google Cloud

Cette page contient les informations que vous devez connaître sur la création et la configuration de 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 (SSO Google), 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 la section Publier une application.

Création de projets Google Cloud

Il existe deux types de projets: 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 les 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 Marketplace.

Important :Vous ne pouvez pas convertir un projet privé en projet public. Créez un projet privé pour développer votre module complémentaire et un projet public pour représenter la version prête pour la production.

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

Créer un projet Google Cloud privé

Ce projet privé représente le module complémentaire utilisé 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. Google vous recommande donc 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 avec une licence Teaching and Learning Upgrade ou Plus. Si vous n'avez pas encore accès à un domaine de ce type, suivez les étapes ci-dessous pour configurer un domaine de démonstration Google Workspace for Education, passer à une licence Plus et l'autoriser à accéder à l'API des modules complémentaires Classroom:

1. Suivez la procédure pour obtenir un domaine de test pour les développeurs.

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 du domaine de démonstration.

   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 > Autres services Google :
     • Google Cloud Platform est activé pour tout le monde.
     • Les paramètres de création de projet 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 d'un domaine de démonstration. Ce formulaire vous demande de faire passer votre domaine de démonstration à Google Workspace for Education Plus avec 10 licences et d'autoriser votre projet Cloud à accéder à l'API des modules complémentaires Classroom.

   Remarque :Envoyez à la fois le formulaire Google for Education Demo Domains (disponible sur la page Obtenir un domaine test pour les développeurs) et le formulaire de demande de mise à niveau d'un domaine de démonstration décrits ici.

   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 d'enseignant test dans la console d'administration. Sous Annuaire > Utilisateurs, créez ou sélectionnez vos comptes d'enseignants tests. Dans les licences de chaque enseignant, vérifiez que Google Workspace for Education Plus est attribué.

4. Activez 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 l'option Visibilité de l'application du SDK Marketplace Configuration de l'application sur Privé.

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

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.

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

   Créer un projet Google Cloud

   Avertissement :Vérifiez que le projet appartient à votre domaine de production et que vous êtes connecté à la console Google Cloud en tant qu'utilisateur de ce domaine.

2. Activez 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 l'option Visibilité de l'application du SDK Marketplace Configuration de l'application 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:Les applications non répertoriées sont introuvables sur Google Workspace Marketplace lors de la navigation ou de la 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 la fiche Play Store. Votre application doit rester non répertoriée jusqu'à ce que vous sachiez la publier auprès du grand public. Vous pouvez indiquer si un module complémentaire apparaît ou non sur la page "Configuration de l'application" du SDK Marketplace.

5. Partagez l'ID ou le numéro du projet Cloud avec votre partenaire Google pour ajouter le projet à la liste d'autorisation des modules complémentaires. Le projet aura ainsi accès aux nouveaux modules complémentaires de l'API Classroom.

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

7. Votre application sera examinée par l'équipe Google Workspace Marketplace. Ils communiqueront avec vous à l'aide de l'adresse e-mail du 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.

OAuth 2.0

L'accès à l'API Classroom nécessite le consentement de l'utilisateur pour l'accès aux données. Ils sont obtenus 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 ultérieurement des appels d'API vers Google Classroom. Les champs d'application doivent être configurés dans la fiche Play Store de Google Workspace Marketplace afin que l'administrateur du domaine puisse donner son autorisation au nom des utilisateurs du 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, dans l'onglet "Configuration de l'application SDK Marketplace" et dans le code de votre module complémentaire. Des niveaux d'accès non concordants 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 la liste détaillée de tous les champs d'application disponibles et de leurs utilisations. Pour obtenir des informations générales sur la configuration OAuth, consultez la page Configurer OAuth dans la documentation de l'espace de travail.

Autorisations utilisateur

Votre application Web doit demander au moins l'un des champs d'application suivants:

• 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, le paramètre hd ("domaine hébergé") est transmis aux URL de votre application Web.

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 ultérieures du même utilisateur.

login_hint et hd sont des paramètres OpenID Connect standards que vous pouvez éventuellement transmettre à Google lorsque vous utilisez Google Sign-In ou demandez un jeton OAuth. Ils sont destinés à faciliter l'expérience d'autorisation pour l'utilisateur final.

Champs d'application 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 de lancer 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 un enseignant ou un élève du cours spécifié par le courseId de la requête.
• L'utilisateur doit être enseignant pour créer, mettre à jour et supprimer une pièce jointe, ou encore envoyer des notes pour lui attribuer des notes.
• Les appels vers une publication Google Classroom spécifique sont restreints par les vérifications suivantes.
  • Lorsqu'un module complémentaire a déjà au moins une pièce jointe à un post, il peut demander les éléments suivants :
    • validation du lancement d'un cadre iFrame
    • Opérations de lecture, de mise à jour et de suppression des pièces jointes
    • Mises à jour des notes sur ce post
  • Lorsque l'iFrame de découverte des pièces jointes est ouvert pour la première fois, il est possible que le module complémentaire n'ait pas encore de pièce jointe au post. Un paramètre de requête addOnToken est fourni. Il peut être utilisé pour effectuer des requêtes pour les éléments suivants :
    • Créer une pièce jointe sous le post (addOnToken est obligatoire)
    • Validation du lancement (addOnToken est validé s'il est fourni et est obligatoire lorsque le module complémentaire ne comporte pas de pièce jointe dans le post)

Validation OAuth

Remarque :Vous ne pouvez pas créer de vidéo de démonstration à envoyer lors du processus de validation OAuth. Il est préférable de publier le module complémentaire sans valider le protocole OAuth. L'équipe Google Workspace Marketplace chargée de l'examen des applications est alors invitée à réaliser une vidéo de démonstration en votre nom. L'équipe d'examinateurs vous fournira ensuite la vidéo pour que vous puissiez l'inclure dans votre demande de validation OAuth.

Un module complémentaire Classroom utilise les API Google pour accéder aux données des utilisateurs Google.

• Valider l'identité de votre marque
• Vérifiez 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 modifier votre sélection.

Tenez compte de certains points lorsque vous créez une fiche Play Store Marketplace pour des modules complémentaires Classroom dans le cadre de ce programme en accès anticipé.

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.

Considérations relatives aux listes

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

Suivez ces consignes dans vos fiches:

• Sous App Details (Informations sur l'application) :

  • Évitez les signes de ponctuation dans le nom de l'application. Par exemple, utilisez "Mon module complémentaire de mon entreprise" au lieu de "Mon entreprise: Mon module complémentaire" ou "Mon module complémentaire, par mon entreprise".

  • Les champs Short Description (Description courte) et Advanced 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 dans la fiche Marketplace.

  • Assurez-vous d'avoir sélectionné une valeur pour le champ Catégorie. Pour un module complémentaire Classroom, il peut être judicieux de choisir des ressources pédagogiques ou des outils pour les enseignants et les administrateurs.

  • Consultez les éléments répertoriés dans la description des détails de l'application sur Marketplace pour en savoir plus.

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

• Sous Éléments graphiques:

  • Les assets graphiques fournis ne sont pas flous et ne respectent pas les tailles spécifiées dans les normes 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 pour les API Google, qui couvrent les noms et descriptions autorisés.

• Si vous faites référence à des produits Google dans votre fiche, utilisez son nom au format figurant dans la liste des marques. Assurez-vous d'inclure le symbole de marque (TM) s'il est spécifié. Utilisez Google DocsTM, et non "Google Docs".

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

Si vous souhaitez permettre l'intégration de vos applications Google Workspace Marketplace aux services de licence et de facturation de Google, consultez l' API Marketplace.

Paramètres d'installation

Les modules complémentaires peuvent autoriser une installation individuelle en plus de l'installation administrateur. Cette page met en évidence les différences entre les deux types d'installation. Elle n'est pas destinée à promouvoir l'un ou l'autre de ces types d'installation. 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 pour le compte de tous les utilisateurs du domaine. Les utilisateurs ne sont pas invités à autoriser les niveaux d'accès s'ils le font.

Voici quelques points à prendre en compte concernant l'installation par un 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 distribution des installations via un administrateur peut vous aider à vous assurer que les licences sont distribuées et utilisées de manière appropriée auprès de l'institution correspondante.
• Allégez la charge de travail pour les utilisateurs finaux. L'installation par un administrateur réduit la charge de configuration pour les enseignants et les élèves. Cela peut se traduire par une expérience utilisateur plus fluide, avec moins de clics et moins de risques de confusion.

Pour en savoir plus sur les opérations d'installation en tant qu'administrateur, consultez les pages Installer des applications Marketplace dans votre domaine et Fonctionnement de la structure organisationnelle 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 points à prendre en compte pour une installation individuelle.

• Faciliter l'adoption D'autres utilisateurs peuvent voir et installer votre module complémentaire à partir de Google Workspace Marketplace. Autoriser l'installation individuelle peut inciter davantage d'enseignants à adopter votre produit ou à le défendre.
• 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 maintenir une liste d'autorisation pour permettre aux utilisateurs d'installer des modules complémentaires leur permettant d'effectuer une installation individuelle. Si un module complémentaire ne figure pas dans la liste d'autorisation, les utilisateurs peuvent toujours consulter sa liste dans Google Workspace Marketplace, mais ne peuvent pas l'installer. À la place, ils voient un message indiquant 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 de l'iFrame de lancement dans le champ URI de configuration de la pièce jointe. Cette URL est utilisée comme valeur src de l'iFrame pour l'iFrame Discovery des 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 dans votre module complémentaire. Cette fonctionnalité renforce la sécurité en empêchant les rattachements provenant de sources non autorisées.

Pour en savoir plus sur ces champs, consultez la page du guide iFrame.

Comptes de test

Créez des comptes de test sur votre domaine de démonstration pour vérifier le comportement de votre module complémentaire privé. Deux comptes d'élèves sont nécessaires pour tester le basculement entre les élèves dans l'iFrame "Examen des devoirs".

Comptes de test suggérés:

• Tammy Teacher, tammy.teacher@<votre domaine de démonstration>
• Sam Student, sam.student@<votre domaine de démonstration>
• Sally Student, sally.student@<votre domaine de démonstration>

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

1. Connectez-vous à la console d'administration.
2. Accédez à Utilisateurs.
3. Cliquez sur Add new user (Ajouter un utilisateur) (voir la figure 1).
4. Saisissez les informations de 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 à la console d'administration.
2. Accédez à Groupes.
3. Cliquez sur Créer un groupe (voir la 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.