Configuration d'un projet Google Cloud

Cette page contient les informations que vous devez connaître 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), pour autoriser les requêtes effectuées par votre module complémentaire et pour gérer à la fiche du module complémentaire sur Google Workspace Marketplace ; Google Store.

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

Création de projets Google Cloud

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

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 public

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

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

    Créer un projet Google Cloud

  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éfinir le SDK Marketplace Configuration de l'application Visibilité de l'application sur Publique, puis cochez la case Non répertoriée.

  5. Remplissez les champs obligatoires dans le SDK Marketplace Fiche Play Store, puis cliquez sur PUBLIER.

  6. Votre application sera examinée par l'équipe Google Workspace Marketplace. Ils communiquera avec vous via l'adresse e-mail de développeur spécifiée dans le SDK Marketplace. Une fois l'application approuvée, effacez la case Non répertoriée afin que les enseignants et les administrateurs puissent la trouver dans Place de marché :

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. Google recommande donc l'utilisation de ce projet pour développer et tester votre module complémentaire dans un environnement contrôlé.

Vous devez avoir accès à un domaine Google Workspace for Education avec le Apprentissage ou Plus pour créer un projet privé. Si vous n'avez pas encore accès à un tel outil suivez ces étapes pour configurer un domaine de démonstration Google Workspace for Education, le faire passer à un Ajoutez une licence et autorisez-la à 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 projet Google Cloud.

    Créer un projet Google Cloud

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

    • Accédez à la page Paramètres du compte > page des paramètres d'accès basés sur l'âge et sélectionnez l'option Tous les utilisateurs de ce groupe ou de cette unité organisationnelle ont 18 ans ou plus anciens.
    • 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. Envoi demande à Google de faire passer votre domaine de démonstration à Google Workspace for Education Plus avec 10 licences et permet à votre projet Cloud API Classroom Add-ons.

    Vous recevrez un e-mail lorsque les processus de mise à niveau et de liste d'autorisation seront terminé. Attribuez des licences Plus à vos comptes d'enseignants tests dans la la console d'administration. Au-dessous Annuaire > Utilisateurs, créez ou sélectionnez vos comptes enseignant test. Dans chaque Licences de l'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éfinir le SDK Marketplace Configuration de l'application Visibilité de l'application sur privée.

  7. Remplissez les champs obligatoires dans le SDK Marketplace Fiche Play Store, puis cliquez sur PUBLIER. Une fois la fiche de l'application publiée, les utilisateurs du domaine pouvez trouver et installer l'application depuis 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. Ces sont obtenus en demandant à Google l'accès aux habilitations OAuth pour les utilisateurs et de recevoir un jeton qui peut être utilisé pour effectuer ultérieurement des appels d'API vers Google Classroom. Les niveaux d'accès doivent être configurés dans sur la fiche Play Store de Google Workspace Marketplace afin que l'administrateur du domaine peuvent donner leur autorisation au nom des utilisateurs de leur domaine s'ils installent le module complémentaire.

Les habilitations Classroom étant sensibles, vous devez demander OAuth de validation avant de lancer votre module complémentaire. Sinon, un avertissement s'affichera un message indiquant que l'application n'est pas validée et que seul un petit nombre d'utilisateurs pourra accéder à votre produit. En savoir plus sur la séquence d'examen pour en savoir plus sur la validation.

Consultez la page Champs d'application OAuth pour les API Google pour obtenir la liste détaillée les champs d’application et leurs utilisations. Consultez la page Configurer OAuth dans la documentation Workspace. pour obtenir des informations générales sur la configuration OAuth.

Autorisations utilisateur

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

  • https://www.googleapis.com/auth/userinfo.email, qui permet à pour afficher l'adresse e-mail de l'utilisateur.
  • https://www.googleapis.com/auth/userinfo.profile, qui permet à pour afficher des informations personnelles telles que "Portrait", "Prénom" et "Nom" ses noms et autres informations personnelles qu'il a rendues publiques disponibles.

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

login_hint est un paramètre OpenID Connect standard que vous pouvez éventuellement sont transmises à Google lorsqu'elles utilisent Google Sign-In ou demandent un jeton OAuth. Il vise à faciliter la procédure 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 à toutes les méthodes d'API.
  • https://www.googleapis.com/auth/classroom.addons.student, qui permet l’accès pour lancer les opérations de validation et de lecture des pièces jointes.

Même s'il existe un jeton d'accès OAuth valide indiquant les identifiants de l'utilisateur, les appels d'API sont soumises à des exigences supplémentaires:

  • Toutes les méthodes nécessitent que l'utilisateur soit enseignant ou élève du cours spécifié par courseId dans la requête.
  • La création, la mise à jour et la suppression des pièces jointes, ainsi que le renvoi des notes nécessitent l'utilisateur pour devenir enseignant.
  • Les appels vers un post Google Classroom spécifique sont contrôlés par les éléments suivants : vérifications.
    • Lorsqu'un module complémentaire comporte déjà au moins une pièce jointe à un post, il peut envoyer des demandes pour: <ph type="x-smartling-placeholder">
        </ph>
      • 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, le module complémentaire peut si vous n'avez pas encore ajouté de pièce jointe au post. Un paramètre de requête addOnToken est fournie et peut être utilisée pour envoyer des requêtes pour les éléments suivants: <ph type="x-smartling-placeholder">
        </ph>
      • Créer une pièce jointe sous le post (addOnToken obligatoire)
      • Validation du lancement (addOnToken est validé s'il est fourni et est obligatoire lorsque le module complémentaire ne possède pas de pièce jointe post)

Validation OAuth

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

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

Fiche Google Workspace Marketplace

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

Remarques concernant les listes

Le SDK Marketplace Store de votre projet public Google Cloud d'application permet de spécifier le nom de l'application les descriptions qui sont aux utilisateurs finaux. Vous pouvez fournir ces informations dans la section 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 "Mon module complémentaire par mon entreprise" au lieu de "Mon entreprise: Mon module complémentaire" ou "Mon module complémentaire, par Mon Company (Entreprise)".

    • Les champs Brève description et 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 le champ inclut les options suivantes : Sans frais, Payant avec un essai sans frais, Payant avec les fonctionnalités sans frais et les tarifs payants. Vous n'avez pas besoin de préciser le 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 un module complémentaire Classroom.

    • Consultez les éléments listés dans l'application Marketplace description détaillée.

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

Si vous souhaitez autoriser vos applications Google Workspace Marketplace intégrer les services de gestion de licence et de facturation de Google, consultez la page API Marketplace.

Paramètres d'installation

Les modules complémentaires peuvent permettre une installation individuelle, en plus de l'installation par l'administrateur. l'installation. Cette page présente quelques différences entre les deux de données. il n'est pas destiné à promouvoir l'un ou l'autre type d'installation. Vous pouvez choisir autoriser ou non les installations individuelles dans le SDK Google Workspace Marketplace ; Configuration de l'application.

Installation par l'administrateur

Les installations administrateur permettent à un administrateur d'ajouter un module d'un domaine, ou à des groupes d'accès ou des unités organisationnelles spécifiques. Uniquement un administrateur de domaine peut effectuer une installation administrateur. La l'administrateur peut éventuellement autoriser tous les niveaux d'accès au nom de tous les utilisateurs dans le domaine. les utilisateurs ne sont pas invités à accepter les niveaux d'accès si le administrateur choisit de le faire.

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 distribution des installations par un administrateur peut aider à garantir que licences sont distribuées et utilisées de manière appropriée avec les établissement.
  • Allégez la charge de travail des utilisateurs finaux. Une installation administrateur réduit l'ensemble 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 savoir comment procéder, consultez Installer des applications Marketplace dans votre domaine. réaliser des installations par les administrateurs et sur le 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 éléments à prendre en compte concernant l'installation individuelle.

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

En plus d'installer des modules complémentaires pour le compte des utilisateurs, les administrateurs peuvent aussi maintenir une liste d'autorisation pour permettre aux utilisateurs d'installer des modules complémentaires qui permettent aux utilisateurs l'installation. Si un module complémentaire ne figure pas dans la liste d'autorisation, les utilisateurs peuvent tout de même voir le dans Google Workspace Marketplace, mais ne parvenez pas à installer le module complémentaire; À la place, un message s'affiche pour lui expliquer que le module complémentaire n'a pas été autorisé par un administrateur de domaine à être installé. Consultez l'article Gérer Google Workspace applications Marketplace figurant sur votre liste d'autorisation pour en savoir plus sur ce comportement.

Consultez la documentation sur les paramètres d'installation de Google Workspace Marketplace pour découvrir plus d'informations.

Intégration d'une application

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

Vous devez également spécifier tous les préfixes d'URI à partir desquels les pièces jointes sont autorisées. depuis votre module complémentaire. Cette fonctionnalité renforce la sécurité en empêchant les pièces jointes 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 afin de vérifier le comportement de votre un module complémentaire privé. Deux comptes élève sont nécessaires pour tester le basculement entre élèves dans l'iFrame de révision des devoirs des élèves.

Comptes de test suggérés:

  • Thomas, enseignant, 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.

Cliquez sur &quot;Ajouter un utilisateur&quot;. 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.

Cliquez sur &quot;Créer un groupe&quot; Figure 2. Emplacement du lien Créer un groupe dans la console d'administration.