プレビュー機能とロードマップ

このページでは、Classroom API の今後の機能と、デベロッパープレビューに参加する方法について説明します。

Classroom API をプレビューする

Classroom API 機能のプレビューでは、デベロッパーはフィードバックを通じて機能開発の形に影響を与え、一般提供に先立って統合を一般公開する準備を整えることができます。

プレビューのライフサイクル

デベロッパーは、下位互換性のある新しい機能を含む API のバージョンをオプトインできます。これらの「プレビュー版」は、少なくとも 90 日間一般公開されます。フィードバックに基づいて、プレビューバージョンとその機能が既存の v1 API に組み込まれます。プレビュー版は、終了するまで少なくとも 90 日間は引き続きご利用いただけます。

プレビュー版に関するフィードバックが強力で、互換性を破る変更が必要になる場合は、既存の機能をサポートする新しいバージョンが作成されます。両方のバージョンは、デベロッパーの移行を可能にするために、少なくとも 90 日間利用できます。Classroom API デベロッパープレビューのメーリングリストに登録してプレビューの変更に関する最新情報を入手し、お知らせリストに登録して Classroom API の一般的な最新情報を入手してください。

Classroom API プレビューに参加する

参加するには、Google Workspace のデベロッパープレビュープログラムに参加してください。利用可能なパブリックプレビュー機能は、Google Workspace のアクティブなデベロッパープレビューに記載されています。非公開プレビュー版の機能をテストしている場合、その機能は公開ドキュメントに記載されていないことがあります。

近日提供予定の機能

以下は、予定されている API 機能とそのタイムラインのロードマップです。定期的に更新されます。

プレビューバージョンの値は、バージョンの最初のプレビューが利用可能になる予定日を表します。プレビューバージョンの使用方法については、プレビュー API にアクセスするをご覧ください。

機能	説明	プレビューの対象	一般提供の予定	プレビューバージョン
採点期間	管理者と教師に代わって採点期間を作成、読み取り、更新、削除する。	2024 年上半期	`TBD`	`V1_20240401_PREVIEW`
ユーザーの機能	ユーザーが特定の Classroom 機能にアクセスできるかどうかを確認する。	2024 年第 4 四半期	2025 年上半期	`V1_20240930_PREVIEW`

以前のバージョン

新機能が検証されると、その機能は v1 API に組み込まれ、対応するプレビューバージョンは廃止されます。デベロッパーは、プレビュー版のサポート終了までに少なくとも 90 日間の移行期間が与えられます。

機能	説明	一般提供に組み込まれた	ターゲットプレビューの終了日	プレビューバージョン
ルーブリックの CRUD	教師に代わって Classroom のルーブリックを作成、読み取り、更新、削除する。	2024 年 12 月 5 日	2025 年 4 月 1 日	`V1_20231110_PREVIEW`

移行ガイダンス

プレビュー版の機能が v1 API に組み込まれたら、関連する API 呼び出しから previewVersion 引数を削除して、アプリが引き続き期待どおりに動作するようにします。たとえば、V1_20231110_PREVIEW バージョンで導入された評価尺度の作成機能にアクセスしていた場合、API 呼び出しは次のようになります。

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()

v1 GA API に移行するには、previewVersion 引数を削除します。

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

特定のプレビューバージョンの機能にアクセスするために静的に生成されたクライアントライブラリを使用していて、他のプレビュー API 機能を使用していない場合は、言語のデフォルトのクライアントライブラリに移行してください。詳細については、Access Preview API をご覧ください。

フィードバック

プレビュー機能に関するフィードバックは、Google Workspace デベロッパープレビュープログラムの概要ページの [有効なデベロッパープレビュー] セクションにあるリンク先の IssueTracker からお送りください。

本番環境で Classroom API プレビュー機能を使用

実際の教師、管理者、生徒などのエンドユーザーに対して Classroom API プレビュー機能を使用する場合、Google Workspace デベロッパープレビュープログラム利用規約の Classroom 固有の改定に同意する必要があります。同意するには、こちらのフォームに記入して送信してください。