アドオンの要件

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

このページの基準は、すべての Classroom アドオンに適用されます。アドオンは、Google Workspace Marketplace での掲載が承認されるために、該当するすべての必須アイテムと「Works with Classroom」のアドオンを満たしている必要があります

このドキュメントにおけるキーワード「MUST」、「MUST NOT」、「REQUIRED」、「SHALL」、「SHALL NOT」、「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 ユーザーはアドオン ワークフローを使用してジャーニーを完了しなければならず、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 studentViewUriteacherViewUristudentWorkViewUri がコピーした課題またはコピーされたコースから起動された場合、アドオンは生徒が完了するための新しい添付ファイルを表示すべきであり、以前の課題またはコースからの生徒の回答を iframe に表示すべきではありません。 おすすめ
4.0 添付ファイルの検出
  4.1 添付ファイルに生徒の提出物が必要な場合は、コンテンツ タイプの添付ファイルではなくアクティビティ タイプとして扱われるように、studentWorkReviewUri を含める必要があります。 REQUIRED
  4.2 添付ファイルの検出 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
800 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 が「必須」を「推奨」に変更しました。
5.1 「REQUIRED」を「Recommended」に変更しました。
5.3 「アドオンが iframe の外に出た場合は、iframe にタスクに関するプレビューがなければなりません」を追加しました。
5.4 「アドオンが iframe の外に出た場合は、生徒に Classroom に戻るよう求めるメッセージを表示すべきです。」を追加しました。
8.1 「デバイスがサポートされていない場合は、そのデバイスがサポートされていないデバイスであること、理想的にはどのデバイスがサポートされているかをユーザーに知らせるメッセージを表示しなければなりません」を追加しました。
8.2 生徒のモバイル課題を「必須」から「推奨」に変更しました。
バージョン 0.1 更新日: 2021 年 9 月 22 日
  初回リリース。