アドオンの要件

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

変更履歴

バージョン 1.1 2024 年 12 月 5 日に更新
1.1、1.3、3.2、3.10、4.4、5.2 REQUIRED から RECOMMENDED に変更しました。
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 プログラムでコースワークの課題を作成するときに、デフォルトでアドオンの添付ファイルを作成するよう推奨する項目を追加しました。
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 を RECOMMENDED に変更しました。
5.1 REQUIRED を RECOMMENDED に変更しました。
5.3 「アドオンが iframe からポップアップする場合は、iframe にタスクのプレビュー を表示する必要があります。」を追加しました。
5.4 「アドオンが iframe からポップアップする場合は、生徒が Classroom に戻るためのプロンプト を表示する必要があります。」を追加しました。
8.1 「デバイスがサポートされていない場合は、サポート対象外のデバイスであることと、可能であればサポート対象のデバイスを伝えるメッセージがユーザーに表示される必要があります。」を追加しました。
8.2 モバイルでの生徒の課題を REQUIRED から RECOMMENDED に変更しました。
バージョン 0.1 2021 年 9 月 22 日に更新
  初回リリース。