アドオンの要件

バージョン 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 を使用して、ログイン プロンプトを表示せずに、ユーザーが次回アクセスしたときに自動的にログインさせる必要があります。
ログイン ヒントが現在ログインしているユーザーと一致しない場合、アドオンはログインボタンをユーザーに表示し、login_hint を認証ライブラリに渡して無効なアカウントを除外する必要があります。
REQUIRED
  2.7 Classroom ユーザーがアドオンにまだログインしていない場合(ログイン ヒントで判断)、ユーザーが明示的に操作してログイン プロセスを開始できるように、アドオンに [Google でログイン] ボタンを表示する必要があります。
: これは Google のブランディング ガイドラインを遵守するために必要であり、ポップアップ ブロッカーを回避するためにも役立ちます。
REQUIRED
  2.8 アドオンは、現在ログインしているユーザーを表示する必要があります。 おすすめ
3.0 全般
  3.1 アドオンは、Google Workspace Marketplace の一般的な承認ガイドラインに準拠している必要があります。 REQUIRED
  3.2 タスクが iframe のいずれかの経路から新しいタブまたはウィンドウで起動される場合は、Classroom に戻るためのユーザー フレンドリーなメッセージを表示する必要があります。 おすすめ
  3.3 ユーザーは、アドオン ワークフローを使用してのみジャーニーを完了する必要があります。コースワーク ワークフローに切り替えたり、Classroom の共有ボタンを使用したりしてはなりません。 REQUIRED
  3.4 ローカライズの選択: 言語は、ブラウザで設定されたローカル設定に基づく必要があります(利用可能な場合)。 おすすめ
  3.5 アドオンで maxPoints を定義する場合は、生徒が保存された教師の認証情報を使用して提出を完了したとき(推奨)または教師が生徒の課題の確認 iframe で提出を開いたときに、pointsEarned も設定する必要があります。 REQUIRED
  3.9 アドオンは、ユーザー補助に関する WCAG 2.1 レベル AA ガイドラインに準拠している必要があります。アドオン デベロッパーは、送信時にこの要件を満たしていること、およびアドオンの今後の変更においても引き続き要件を満たすことを自己申告する必要があります。 おすすめ
  3.10 ユーザーが遭遇するエラーは、人間が読める形式にする必要があります。 おすすめ
  3.11 コピーされた課題またはコピーされたコースから studentViewUriteacherViewUri、または studentWorkViewUri が起動された場合、アドオンは iframe にエラーページを表示してはなりません。 REQUIRED
4.0 アタッチメントの検出
  4.1 添付ファイルに生徒の提出が必要な場合は、コンテンツ タイプの添付ファイルではなくアクティビティ タイプとして扱われるように、添付ファイルに studentWorkReviewUri を含める必要があります。 REQUIRED
  4.2 アタッチメント検出の iframe は、次のいずれかを提供するユーザー インターフェースを提供する必要があります。
  • 関連付ける新しいコンテンツを作成する
  • コンテンツ ライブラリからコンテンツを参照、選択、添付する
  • ウェブサイトや他のプロダクトからコンテンツを添付する手順
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 モバイルアプリで teacherViewUristudentViewUri、または studentWorkReviewUri を起動したときに、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)。また、必須から推奨に変更されました。
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 必須を推奨に変更しました。
5.3 「アドオンが iframe からポップアウトする場合は、iframe 内にタスクに関するプレビューが必要です」を追加しました。
5.4 「アドオンが iframe からポップアウトした場合は、生徒が Classroom に戻るよう求めるメッセージが表示される必要があります」を追加しました。
8.1 「デバイスがサポートされていない場合は、サポート対象外のデバイスであることと、可能であればサポート対象のデバイスを伝えるメッセージがユーザーに表示される必要があります」を追加しました。
8.2 生徒のモバイル デバイスでの提出物を「必須」から「推奨」に変更しました。
バージョン 0.1 更新日: 2021 年 9 月 22 日
  初回リリース。