부가기능 요구사항

버전 1.1, 2024년 12월 5일

이 페이지의 기준은 모든 클래스룸 부가기능에 적용됩니다. 부가기능이 Google Workspace Marketplace에 등록되고 '클래스룸과 호환'되는 부가기능으로 승인되려면 관련 요구사항을 모두 충족해야 합니다.

이 문서의 키워드인 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', 'OPTIONAL'은 RFC 2119에 설명된 대로 해석됩니다.

요구사항

ID 유형
1.0 최종 사용자 라이선스 (해당하는 경우)
  1.1 사용자에게 라이선스가 없는 경우 사용자 친화적인 메시지를 표시해야 합니다. 메시지는 부가기능을 사용할 수 없는 이유를 명확하게 설명하고 사용자가 상황을 해결할 수 있는 조치를 제안해야 합니다(SHOULD). 추천
  1.3 부가기능의 Google Workspace Marketplace 등록정보에는 부가기능을 사용하기 위해 필요할 수 있는 라이선스 및 구독 요구사항에 관한 세부정보를 명시해야 합니다. 부가기능에 유료 등급이 있는 경우 마켓플레이스 등록정보에 가격 또는 영업사원에게 문의하는 방법에 관한 자세한 정보를 제공하는 웹페이지 링크를 제공해야 합니다. 추천
2.0 최종 사용자 로그인
  2.1 교사 사용자는 Google SSO를 사용하여 부가기능에 로그인해야 합니다.
학생 사용자에게 부가기능에 로그인하라는 메시지가 표시되면 Google SSO를 사용하여 로그인해야 합니다.
REQUIRED
  2.2 부가기능은 Google SSO를 사용하여 로그인 메시지를 표시하지 않고도 후속 방문 시 사용자를 자동으로 로그인해야 합니다.
로그인 힌트가 현재 로그인한 사용자와 일치하지 않는 경우 부가기능은 사용자에게 로그인 버튼을 표시하고 login_hint를 인증 라이브러리에 전달하여 잘못된 계정을 필터링해야 합니다.
REQUIRED
  2.7 로그인 힌트를 확인하여 클래스룸 사용자가 아직 부가기능에 로그인하지 않은 경우 부가기능은 'Google 계정으로 로그인' 버튼을 표시해야 합니다. 그러면 사용자가 직접 로그인 프로세스를 트리거할 수 있습니다.
참고: 이는 Google 브랜딩 가이드라인을 준수하는 데 필요하며 팝업 차단기를 피하는 데도 도움이 됩니다.
REQUIRED
  2.8 부가기능은 현재 로그인한 사용자를 표시해야 합니다. 추천
3.0 일반
  3.1 부가기능은 일반적인 Google Workspace Marketplace 승인 가이드라인을 준수해야 합니다. REQUIRED
  3.2 iframe 여정에서 작업이 새 탭 또는 창으로 실행되는 경우 클래스룸으로 돌아가라는 사용자 친화적인 메시지를 제공해야 합니다. 추천
  3.3 사용자는 부가기능 워크플로를 사용하여 여정을 완료해야 하며, 과정 워크플로로 전환하거나 클래스룸 공유 버튼을 사용해서는 안 됩니다. REQUIRED
  3.4 현지화 선택: 언어는 가능한 경우 브라우저에서 설정한 로컬 환경설정을 기반으로 해야 합니다. 추천
  3.5 부가기능이 maxPoints를 정의하는 경우 학생이 저장된 교사 사용자 인증 정보를 사용하여 제출물을 완료하거나 (권장) 교사가 학생 과제물 검토 iframe에서 제출물을 열 때도 pointsEarned를 설정해야 합니다. REQUIRED
  3.9 부가기능은 접근성에 관한 WCAG 2.1 수준 AA 가이드라인을 준수해야 합니다. 부가기능 개발자는 제출 시 이 요구사항이 충족되었으며 향후 부가기능 변경사항과도 계속해서 일치한다고 자체 보고합니다. 추천
  3.10 사용자가 경험하는 모든 오류는 사람이 읽을 수 있어야 합니다(SHOULD). 추천
  3.11 복사된 과제 또는 복사된 과정에서 studentViewUri, teacherViewUri 또는 studentWorkViewUri가 실행되는 경우 부가기능은 iframe에 오류 페이지를 표시해서는 안 됩니다(MUST NOT). REQUIRED
4.0 첨부파일 검색
  4.1 첨부파일에 학생 제출이 필요한 경우 첨부파일에 studentWorkReviewUri가 포함되어야 콘텐츠 유형 첨부파일이 아닌 활동 유형으로 취급됩니다. REQUIRED
  4.2 첨부파일 검색 iframe은 다음 중 하나 이상을 제공하는 사용자 인터페이스를 제공해야 합니다(MUST).
  • 연결할 새 콘텐츠 만들기
  • 콘텐츠 라이브러리에서 둘러보고 선택하고 첨부하기
  • 웹사이트 또는 다른 제품의 콘텐츠를 첨부하는 방법
REQUIRED
  4.3 교사는 사용 가능한 모든 콘텐츠/활동을 찾아 액세스할 수 있어야 합니다. 추천
  4.4 교사는 콘텐츠/활동을 과제에 첨부하기로 결정하기 전에 미리 볼 수 있어야 합니다. 추천
  4.5 콘텐츠/활동을 첨부하기 전에 교사가 콘텐츠/활동을 만들어야 하는 경우 이 작업은 iframe에서 완료해야 합니다. 추천
5.0 학생 뷰
  5.1 studentViewUri가 실행되면 부가기능이 작업을 완료하기 위해 사용자를 iframe 외부로 팝업해서는 안 됩니다.
부가기능이 사용자를 iframe 외부로 팝업하는 경우 학생이 클래스룸으로 돌아가도록 메시지 또는 기타 표시가 있어야 합니다.
추천
  5.2 부가기능 활동이 iframe에서 튀어나오면 iframe에 태스크에 관한 미리보기가 있어야 합니다. 추천
  5.3 있는 경우 활동에 제출이라고 라벨이 지정된 버튼이나 링크가 있으면 교사 검토를 위해 학생의 과제물을 제출하는 API 요청을 실행해야 합니다(MUST). REQUIRED
6.0 교사 보기
  6.1 교사는 학생이 과제를 할 때 표시되는 내용을 볼 수 있어야 합니다. 추천
7.0 학생 과제물 검토
  7.1 studentWorkReviewUri가 실행되면 부가기능은 iframe 내에서 교사 검토를 위해 해당 학생의 과제물을 렌더링해야 합니다. 보충 자료는 iframe 외부에 연결될 수 있습니다. REQUIRED
  7.2 부가기능은 studentWorkReviewUri 뷰에서 학생 간에 탐색을 사용 설정해서는 안 됩니다. 학생 간의 탐색은 클래스룸 UI에서만 이루어져야 합니다(MUST). REQUIRED
8.0 클래스룸 모바일 지원
  8.1 클래스룸 모바일 앱에서 teacherViewUri, studentViewUri 또는 studentWorkReviewUri를 실행하면 URL이 파트너의 모바일 네이티브 앱 또는 파트너의 모바일 웹 앱을 열고, 어느 쪽이든 올바른 뷰로 딥 링크를 연결해야 합니다. 기기가 지원되지 않는 경우 사용자에게 지원되지 않는 기기임을 알리는 메시지와 이상적으로는 지원되는 기기를 알리는 메시지를 표시해야 합니다(MUST). REQUIRED
  8.2 학생 과제는 휴대기기에서 완료할 수 있어야 합니다. 추천
9.0 추가 기능
  9.1 교사가 콘텐츠 링크를 링크 첨부파일로 붙여넣을 수 있는 경우 링크를 부가기능 첨부파일로 업그레이드해야 합니다. 추천
  9.2 CourseWork 통합을 사용하여 클래스룸 외부에서 과제를 만드는 경우 부가기능과 호환되는 모든 링크에 기본적으로 부가기능 첨부파일을 만들어야 합니다. 추천

변경 로그

버전 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를 단일 요구사항으로 결합했습니다.
2.1 2.1과 2.5를 단일 요구사항으로 결합했습니다.
2.2 2.2, 2.3, 2.4를 단일 요구사항으로 결합했습니다.
3.5 3.5, 3.6, 3.7을 단일 요구사항으로 결합했습니다.
3.10 부가기능이 이해할 수 없거나 복구할 수 없는 상태로 전환되지 않도록 하는 요구사항을 추가했습니다.
3.11, 3.12 5.5, 5.6, 6.3, 6.4, 7.5, 7.6을 두 가지 새로운 요구사항으로 결합했습니다.
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 studentViewUri, teacherViewUri, studentWorkReviewUri에 필요한 과정 문구 및 권장 안내를 추가했습니다.
버전 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에서 튀어나오면 학생이 클래스룸으로 돌아가라는 메시지가 표시되어야 합니다.'를 추가했습니다.
8.1 '기기가 지원되지 않는 경우 사용자에게 지원되지 않는 기기임을 알리는 메시지와 이상적으로는 지원되는 기기를 알리는 메시지를 표시해야 합니다(MUST).'를 추가했습니다.
8.2 모바일 학생 과제물의 필수 여부가 '필수'에서 '권장'으로 변경되었습니다.
버전 0.1 업데이트: 2021년 9월 22일
  첫 출시입니다.