アドオンの要件

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

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

このドキュメントのキーワード「MUST」、「MUST NOT」、「REQUIRED」、「SHALL」、「SHALL NOT」、「SHOULD」、「SHOULD NOT」、「RECOMMENDED」、「MAY」、「OPTIONAL」は、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 ユーザーは、アドオン ワークフローを使用してのみジャーニーを完了する必要があります。コースワーク ワークフローに切り替えたり、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 添付ファイル検出の iframe は、次のいずれかを提供できるユーザー インターフェースを提供する必要があります。
  • 関連付ける新しいコンテンツを作成する
  • コンテンツ ライブラリからコンテンツを参照、選択、添付する
  • ウェブサイトや他のプロダクトからコンテンツを添付する手順
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
6.0 教師ビュー
  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 生徒の課題はモバイル デバイスで完了できるようにすることをおすすめします。 おすすめ
9.0 その他の機能
  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)。また、必須から推奨に変更しました。
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 必須を推奨に変更しました。
5.3 「アドオンが iframe からポップアウトする場合は、iframe 内にタスクに関するプレビューが必要です」を追加しました。
5.4 「アドオンが iframe からポップされた場合、Classroom に戻るよう生徒に促すプロンプトを表示すべきです」を追加しました。
8.1 「デバイスがサポートされていない場合は、サポート対象外のデバイスであることと、可能であればサポート対象のデバイスを伝えるメッセージがユーザーに表示される必要があります」を追加しました。
8.2 生徒のモバイル デバイスでの提出物を「必須」から「推奨」に変更しました。
バージョン 0.1 更新日: 2021 年 9 月 22 日
  初回リリース。