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

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

Classroom API をプレビューする

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

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

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

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

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

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

近日提供予定の機能

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

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

以前のバージョン

新機能が検証されると、その機能は v1 API に組み込まれ、対応するプレビュー バージョンはシャットダウンされます。プレビュー バージョンがシャットダウンされるまでに、デベロッパーは少なくとも 90 日間移行できます。

移行ガイダンス

プレビュー バージョンの機能が 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 機能を使用していない場合は、言語のデフォルトのクライアント ライブラリに移行します。詳細については、プレビュー版 API にアクセスするをご覧ください。

フィードバック

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

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

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