Fonctionnalités en mode Preview et feuille de route

Cette page contient des informations sur les fonctionnalités à venir de l'API Classroom et des informations sur la participation à la version Preview développeur.

Aperçu de l'API Classroom

La prévisualisation des fonctionnalités de l'API Classroom permet aux développeurs d'influencer la forme du développement des fonctionnalités grâce à leurs commentaires et de préparer les intégrations à une utilisation publique avant leur disponibilité générale.

Cycle de vie de l'aperçu

Les développeurs peuvent activer les versions de l'API qui contiennent de nouvelles fonctionnalités rétrocompatibles. Ces "versions Preview" sont disponibles au public pendant au moins 90 jours. Sous réserve de commentaires, la version preview et ses fonctionnalités sont ensuite intégrées à l'API v1 existante. Les versions Preview restent disponibles pendant au moins 90 jours supplémentaires avant d'être arrêtées.

Si les commentaires sur une version preview sont suffisamment pertinents pour nécessiter des modifications destructives, une nouvelle version est créée pour prendre en charge les fonctionnalités existantes. Les deux versions sont disponibles pendant au moins 90 jours pour permettre aux développeurs de migrer. Rejoignez la liste de diffusion de la version Preview développeur de l'API Classroom pour vous tenir informé des modifications apportées à la version Preview et abonnez-vous à la liste d'annonces pour obtenir des informations plus générales sur l'API Classroom.

Participer aux versions preview de l'API Classroom

Pour participer, rejoignez le programme Preview développeur Google Workspace. Les fonctionnalités disponibles en version Preview publique sont listées dans les Previews développeur actifs Google Workspace. Si vous testez une fonctionnalité en version Preview privée, il est possible qu'elle ne figure dans aucune documentation publique.

Fonctionnalités à venir

Voici notre feuille de route des fonctionnalités d'API attendues et de leurs délais. Il est mis à jour régulièrement.

La valeur de la version preview représente la date prévue de disponibilité de la version preview initiale. Consultez Accéder aux API Preview pour découvrir comment les versions Preview sont utilisées.

Versions précédentes

Une fois les nouvelles fonctionnalités validées, elles sont intégrées à l'API v1 et la version preview correspondante est arrêtée. Les développeurs disposent d'au moins 90 jours pour effectuer la migration avant la fermeture de la version Preview.

Conseils de migration

Une fois que les fonctionnalités d'une version preview sont intégrées à l'API v1, supprimez l'argument previewVersion des appels d'API associés pour vous assurer que votre application continue de se comporter comme prévu. Par exemple, si vous accédiez aux fonctionnalités de création de rubriques introduites dans la version V1_20231110_PREVIEW, vos appels d'API pouvaient se présenter comme suit:

rubric = service.courses().courseWork().rubrics().create(
        courseId=course_id, courseWorkId=coursework_id, body=body,
        # Specify the preview version. Rubrics CRUD capabilities are
        # supported in V1_20231110_PREVIEW and later.
        previewVersion="V1_20231110_PREVIEW"
        ).execute()

Pour migrer vers l'API GA v1, supprimez l'argument previewVersion:

rubric = service.courses().courseWork().rubrics().create(
        courseId=course_id, courseWorkId=coursework_id, body=body,
        ).execute()

Si vous utilisiez une bibliothèque cliente générée de manière statique spécifiquement pour accéder à une fonctionnalité d'une version preview donnée et que vous n'utilisez pas d'autres fonctionnalités de l'API Preview, passez à la bibliothèque cliente par défaut pour votre langage. Pour en savoir plus, consultez la page Accéder aux API Preview.

Commentaires

Envoyez vos commentaires sur les fonctionnalités en preview via IssueTracker dans la section Previews développeur actifs de la page de présentation du programme Preview développeur Google Workspace.

Utiliser les fonctionnalités preview de l'API Classroom en production

Si vous souhaitez utiliser les fonctionnalités Preview de l'API Classroom avec des utilisateurs finaux, y compris des enseignants, des administrateurs ou des élèves réels, vous devez accepter un amendement spécifique à Classroom des Conditions du programme Preview développeur Google Workspace en remplissant et en envoyant ce formulaire: