アドオンの要件

バージョン 1.0、2024 年 4 月 30 日。

このページの条件は、すべての Classroom アドオンに適用されます。アドオンが Google Workspace Marketplace へのリスティングの承認を受けるには、該当するすべての項目と、「Works with Classroom」というアドオンを満たす必要があります

このドキュメントのキーワード「しなければならない」、「してはならない」、「必須」、「するべき」、「べきでない」、「すべきである」、「すべきである」、「推奨」、「しても構わない」、「任意」は、RFC 2119 に記載されているとおりに解釈されます。

要件

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

変更履歴

バージョン 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 を「REQUIRED」に変更しました。
5.1 「REQUIRED」から「Recommended」に変更しました。
5.3 「アドオンが iframe からポップされた場合、iframe のタスクに関するプレビューがなければなりません」を追加しました。
5.4 「アドオンが iframe からポップされた場合、Classroom に戻るよう生徒に促すプロンプトを表示すべきです」を追加しました。
8.1 「デバイスがサポートされていない場合は、サポートされていないデバイスであること、理想的にはどのデバイスがサポートされているかをユーザーに知らせるメッセージを表示しなければなりません」を追加しました。
8.2 モバイルの生徒の提出物を「必須」から「推奨」に変更しました。
バージョン 0.1 更新日: 2021 年 9 月 22 日
  初回リリース。