アドオンの要件

バージョン 1.1、2024 年 12 月 5 日。

このページの条件は、すべての Classroom アドオンに適用されます。Google Workspace Marketplace と「Classroom 対応」のアドオンとして承認されるには、アドオンが該当するすべての必須項目を満たしている必要があります

このドキュメントのキーワード「しなければならない」(MUST)、「してはならない」(MUST NOT)、「要求される」(REQUIRED)、「するものとする」(SHALL)、「しないものとする」(SHALL NOT)、「すべきである」(SHOULD)、「すべきではない」(SHOULD NOT)、「推奨される」(RECOMMENDED)、「しても構わない」(MAY)、「任意」(OPTIONAL)は、RFC 2119 に記載されているように解釈されます。

要件

ID タイプ
1.0 エンドユーザー ライセンス(該当する場合)
  1.1 ユーザーがライセンスを持っていない場合は、ユーザーにわかりやすいメッセージを表示すべきです。メッセージでは、アドオンを使用できない理由を明確に説明し、状況を改善するためのユーザーの行動を提案すべきです。 推奨
  1.3 アドオンの Google Workspace Marketplace の掲載情報には、アドオンの使用に必要となるライセンスとサブスクリプションの要件に関する詳細を指定すべきです。アドオンに有料プランがある場合、Marketplace のリスティングには、料金や営業担当者への連絡方法に関する詳細情報を提供するウェブページへのリンクを含めるべきです。 推奨
2.0 エンドユーザーのログイン
  2.1 教師ユーザーは、Google SSO を使用してアドオンにログインしなければなりません。
生徒ユーザーがアドオンへのログインを求められた場合は、Google SSO を使用してログインしなければなりません。
REQUIRED
  2.2 アドオンは、Google SSO を使用して、ログイン プロンプトを表示せずに、その後のアクセス時にユーザーを自動的にログインさせなければなりません。
ログイン ヒントが現在ログインしているユーザーと一致しない場合、アドオンはログイン ボタンを表示してユーザーにプロンプトを表示し、ログイン ヒントを認証ライブラリに渡して無効なアカウントを除外しなければなりません。
REQUIRED
  2.7 Classroom ユーザーがアドオンにまだログインしていない場合(ログイン ヒントを確認して判断)、アドオンは、ログイン プロセスをトリガーする明示的なユーザー操作のために [Google でログイン] ボタンを表示しなければなりません。
: これは、Google のブランディング ガイドラインを満たすために必要であり、ポップアップ ブロックを回避するうえでも役立ちます。
REQUIRED
  2.8 アドオンは、現在ログインしているユーザーを表示すべきです。 推奨
3.0 全般
  3.1 アドオンは、Google Workspace Marketplace の一般的な承認ガイドラインに準拠しなければなりません。 REQUIRED
  3.2 iframe ジャーニーのいずれかから新しいタブまたはウィンドウでタスクが起動された場合、クラスルームに戻るためのわかりやすいメッセージを表示すべきです。 推奨
  3.3 ユーザーは、アドオン ワークフローを使用してのみジャーニーを完了しなければなりません。課題ワークフローに切り替えたり、Classroom の共有ボタンを使用したりしてはなりません。 REQUIRED
  3.4 ローカライズの選択: 言語は、利用可能な場合はブラウザで設定されたローカル設定に基づくべきです。 推奨
  3.5 アドオンが maxPoints を定義する場合、生徒が保存された教師の認証情報を使用して提出を完了したとき(推奨)、または教師が生徒の課題のレビュー iframe で提出を開いたときに、pointsEarned も設定しなければなりません。 REQUIRED
  3.9 アドオンは、アクセシビリティに関する WCAG 2.1 レベル AA のガイドラインに準拠すべきです。アドオン デベロッパーは、送信時にこの要件を満たしていること、およびアドオンの今後の変更にも引き続き準拠することを自己申告します。 推奨
  3.10 ユーザーが経験するエラーは、人が読める形式にすべきです。 推奨
  3.11 コピーされた課題またはコピーされたコースから studentViewUriteacherViewUristudentWorkViewUri が起動された場合、アドオンは iframe にエラーページを表示してはなりません。 REQUIRED
4.0 添付ファイルの検出
  4.1 添付ファイルで生徒の提出が必要な場合、添付ファイルはコンテンツ タイプの添付ファイルではなくアクティビティ タイプとして扱われるように、studentWorkReviewUri を含めなければなりません。 REQUIRED
  4.2 添付ファイル検出 iframe は、次のいずれか 1 つ以上を提供するユーザー インターフェースを提供しなければなりません。
  • 関連付ける新しいコンテンツを作成する
  • コンテンツ ライブラリから参照、選択、添付する
  • ウェブサイトや他のプロダクトのコンテンツを添付する手順
REQUIRED
  4.3 教師は、教師が利用できるすべてのコンテンツ/アクティビティを見つけてアクセスできるべきです。 推奨
  4.4 教師は、課題に添付する前にコンテンツやアクティビティをプレビューできるべきです。 推奨
  4.5 コンテンツやアクティビティを添付する前に教師が作業を行う必要がある場合、その作業は iframe 内で完了させるべきです。 推奨
5.0 生徒ビュー
  5.1 studentViewUri が起動されたとき、アドオンはタスクを完了するためにユーザーを iframe からポップアウトさせるべきではありません。
アドオンがユーザーを iframe からポップアウトさせる場合、生徒が Classroom に戻るためのメッセージまたはその他の表示がなければなりません。
推奨
  5.2 アドオン アクティビティが iframe からポップアウトする場合、iframe 内にタスクのプレビューが表示されるべきです。 推奨
  5.3 存在する場合、アクティビティの [提出] というラベルのボタンまたはリンクは、教師が確認できるように 生徒の課題を提出する API リクエストを発生させなければなりません。 REQUIRED
6.0 教師ビュー
  6.1 教師は、生徒が課題に取り組む際に表示される内容を確認できるようにすべきです。 推奨
7.0 生徒の提出物の確認
  7.1 studentWorkReviewUri が起動された場合、アドオンは、教師が確認できるように、その生徒の課題を iframe 内にレンダリングしなければなりません。補足資料は iframe の外部にリンクできます。 REQUIRED
  7.2 アドオンは、studentWorkReviewUri ビューで生徒間のナビゲーションを有効にしてはなりません。生徒間の移動は Classroom UI でのみ行わなければなりません。 REQUIRED
8.0 Classroom モバイルのサポート
  8.1 Classroom モバイルアプリで teacherViewUristudentViewUristudentWorkReviewUri を起動したときに、URL がパートナーのモバイル ネイティブ アプリまたはパートナーのモバイル ウェブアプリを開き、いずれの場合も正しいビューにディープリンクする必要があります。デバイスがサポートされていない場合は、サポート対象外のデバイスであることと、可能であればサポート対象のデバイスを伝えるメッセージがユーザーに表示される必要があります。 REQUIRED
  8.2 生徒の課題はモバイル デバイスで完了できるようにすることを推奨します。 推奨
9.0 その他の機能
  9.1 教師がコンテンツへのリンクをリンクの添付ファイルとして貼り付けることができる場合、リンクをアドオンの添付ファイルにアップグレードすべきです。 推奨
  9.2 CourseWork 統合を使用して Classroom の外部から課題を作成する場合は、アドオンと互換性のあるすべてのリンクに対して、デフォルトでアドオンの添付ファイルを作成すべきです。 推奨

変更履歴

バージョン 1.1 更新日: 2024 年 12 月 5 日
1.1、1.3、3.2、3.10、4.4、5.2 「必須」から「推奨」に変更しました。
3.12 削除しました。
5.3 言い換えました。最近の変更により、アドオン デベロッパーは API を使用して生徒の提出物を確実に提出できるようになりました。
バージョン 1.0 更新日: 2024 年 4 月 30 日
1.1 1.1 と 1.2 を 1 つの要件に統合しました。
2.1 2.1 と 2.5 を 1 つの要件に統合しました。
2.2 2.2、2.3、2.4 を 1 つの要件に統合しました。
3.5 3.5、3.6、3.7 を 1 つの要件に統合しました。
3.10 アドオンが理解不能または復元不能な状態にならないようにする要件を追加しました。
3.11、3.12 5.5、5.6、6.3、6.4、7.5、7.6 を 2 つの新しい要件に統合しました。
4.2 許容される添付ファイル検出エクスペリエンスの説明を拡充しました。
4.3 番号が変更されました(以前は 4.2)。また、REQUIRED から RECOMMENDED に変更しました。
4.4 番号を変更しました。以前は 4.3 でした。
4.5 番号が変更されました(以前は 4.4)。
5.2 番号が変更されました。以前は 5.3 でした。
5.3 番号が変更されました(以前は 5.2)。
9.1 貼り付けたリンクを添付ファイルにアップグレードするよう推奨する機能を追加しました。
9.2 CourseWork の課題をプログラムで作成する際に、アドオンの添付ファイルをデフォルトで作成するよう推奨事項を追加しました。
2.6、3.7、3.8、6.2、7.3、7.4 削除しました。
バージョン 0.3 更新日: 2022 年 11 月 22 日
2.3 ログイン ヒントのガイダンスを修正しました。
2.4 hd の実装が必要なシナリオを組み込みました。
3.2 「パスを指定する」の文言を変更しました。
5.5、5.6、6.3、6.4、7.5、7.6 studentViewUriteacherViewUristudentWorkReviewUri のコースコピーの必須ガイダンスと推奨ガイダンスを追加しました。
バージョン 0.2 更新日: 2021 年 10 月 29 日
1.3 意図がより明確になるようにテキストを調整しました。
3.1 「アドオンは、ウェブサイトに記載されている GWM の一般的な承認ガイドラインに準拠しなければなりません。」を追加しました。
3.9 WCAG で「必須」が「推奨」に変更されました。
5.1 REQUIRED を RECOMMENDED に変更しました。
5.3 「アドオンが iframe からポップアウトする場合は、iframe 内にタスクのプレビューがなければなりません。」を追加しました。
5.4 「アドオンが iframe からポップアウトした場合は、生徒が Classroom に戻るためのプロンプトを表示すべきです。」を追加しました。
8.1 「デバイスがサポートされていない場合は、サポート対象外のデバイスであることと、可能であればサポート対象のデバイスを伝えるメッセージがユーザーに表示される必要があります。」を追加しました。
8.2 モバイルでの生徒の課題が「必須」から「推奨」に変更されました。
バージョン 0.1 更新日: 2021 年 9 月 22 日
  初回リリース。