이 페이지에는 API를 사용하여 애플리케이션을 만들고 클래스룸 부가기능용 Google Cloud 프로젝트 구성 OAuth 2.0을 통해 Google 싱글 사인온(SSO)을 구현하는 데 사용되는 Google Cloud 프로젝트 Google SSO(Google SSO)를 통해 부가기능에 의한 요청을 승인하고 Google Workspace Marketplace의 부가기능 등록정보 있습니다.
부가기능 게시에 대한 보다 일반적인 정보는 Marketplace는 앱 게시를 참조하세요.
Google Cloud 프로젝트 만들기
만들 수 있는 프로젝트에는 두 가지 유형이 있습니다. 즉, 비공개 프로젝트, 개발 및 최종 사용자가 도달할 수 있는 공개 프로젝트 '공개' 및 'private' 라벨은 애플리케이션이 눈에 잘 띄도록 Google Workspace Marketplace 비공개 Marketplace 설치된 도메인 내의 사용자만 애플리케이션을 설치할 수 있음 공개 Marketplace 애플리케이션이 모든 Google Workspace 도메인에서 사용할 수 있습니다. 이 둘은 반드시 서로 별개로 프로젝트가 공개 및 비공개가 될 수 없습니다. 공개 애플리케이션 마켓에 출시되기 전에 검토 및 승인을 받아야 합니다.
일반적인 Google Cloud 프로젝트 생성 정보는 프로젝트 만들기 Google Cloud 프로젝트에 할당됩니다.
공개 Google Cloud 프로젝트 만들기
이 프로젝트는 프로젝트 모음에 속한 사용자들에 의해 액세스 가능한 액세스할 수 있습니다 공개 프로젝트는 검토를 거쳐야 하고 Google Workspace Marketplace팀의 승인을 받아야 합니다. 설치해야 합니다.
프로덕션 도메인에 새 Google Cloud 프로젝트를 만듭니다.
클라우드 프로젝트에서 Classroom API를 사용 설정합니다.
Cloud 프로젝트에서 Google Workspace Marketplace SDK를 사용 설정합니다.
Marketplace SDK 설정 앱 구성 앱 공개 상태를 공개로 설정하고 일부 공개 체크박스를 선택합니다.
Marketplace SDK에서 필수 입력란을 작성합니다. 스토어 등록정보 페이지를 열고 게시.
Google Workspace Marketplace팀에서 앱을 검토합니다. 그들은 에 지정된 개발자 이메일 주소를 사용하여 Marketplace SDK 앱이 승인된 후 일부 공개 체크박스를 선택하시기 바랍니다. 마켓플레이스.
비공개 Google Cloud 프로젝트 만들기
이 비공개 프로젝트는 개발에 사용되는 부가기능 애플리케이션을 나타냅니다. 생성된 도메인 외부의 사용자는 액세스할 수 없지만 설치하기 전에 승인을 받을 필요가 없습니다. 따라서 Google에서는 이 프로젝트를 사용하여 통제된 환경에서 부가기능을 개발하고 테스트합니다.
Google Workspace for Education 도메인에 대한 액세스 권한이 필요한 경우 학습 또는 플러스 라이선스가 필요합니다. 이러한 도메인에 있는 경우 다음 단계에 따라 Google Workspace for Education 데모 도메인을 설정하고 라이선스를 받고 클래스룸 부가기능 API에 액세스하도록 허용합니다.
- 개발자 테스트 도메인 받기 단계를 완료하세요.
데모 도메인에서 관리자로 로그인한 상태에서 Google Cloud 프로젝트입니다.
Google Cloud 콘솔에 액세스할 수 없거나 Cloud 프로젝트의 경우 관리 콘솔:
- 계정 설정 > 연령별 액세스 설정 페이지 및 이 그룹 또는 조직 단위의 모든 사용자는 만 18세 또는 이전 버전으로 설정합니다.
- 앱 > 추가 Google 서비스:
- Google Cloud Platform이 모든 사용자에 대해 사용 설정됩니다.
- 프로젝트 생성 설정은 사용자가 프로젝트를 만들도록 허용입니다.
- Cloud Shell 액세스 설정은 Cloud Shell에 대한 액세스 허용입니다.
데모 도메인 업그레이드 요청 양식을 작성하여 제출합니다. 제출 중 10개월 동안 데모 도메인을 Google Workspace for Education Plus로 Cloud 프로젝트가 클래스룸 부가기능 API
업그레이드 및 허용 목록 프로세스가 완료되면 이메일이 전송됩니다. 합니다. 에서 테스트 교사 계정에 Plus 라이선스를 할당합니다. 관리 콘솔로 이동합니다. 미달 디렉터리 > 사용자의 테스트 교사 계정을 만들거나 선택합니다. 각 교사의 라이선스가 있으면 Google Workspace for Education Plus가 할당되었는지 확인합니다.
클라우드 프로젝트에서 Classroom API를 사용 설정합니다.
Cloud 프로젝트에서 Google Workspace Marketplace SDK를 사용 설정합니다.
Marketplace SDK 설정 앱 구성 앱 공개 상태를 비공개로 설정합니다.
Marketplace SDK에서 필수 입력란을 작성합니다. 스토어 등록정보 페이지를 열고 게시. 앱 등록정보가 게시된 후 도메인의 사용자는 Google Workspace Marketplace에서 앱을 찾아 설치할 수 있음 스토어 등록정보 페이지에 표시된 앱 URL을 방문하세요.
OAuth 2.0
Classroom API에 액세스하려면 사용자 데이터 액세스 동의가 필요합니다. 이러한 로그인한 계정의 OAuth 범위에 대한 Google 액세스를 요청하여 가져오기 이후에 Google 클래스룸 범위는 Google Workspace Marketplace 스토어 등록정보가 사용자가 부가기능을 설치하는 경우 도메인 사용자를 대신하여 동의할 수 있습니다.
사용 가능한 모든 API의 자세한 목록은 Google API의 OAuth 범위 페이지를 참조하세요. 살펴보겠습니다 Workspace 문서에서 OAuth 페이지 구성을 참고하세요. 참조하세요.
사용자 권한
웹 앱은 다음 범위 중 하나 이상을 요청해야 합니다.
https://www.googleapis.com/auth/userinfo.email
를 사용하면 애플리케이션을 사용하여 사용자의 이메일 주소를 확인합니다.https://www.googleapis.com/auth/userinfo.profile
를 사용하면 세로 모드, 이름, 성 등의 개인 정보를 볼 수 있는 이름 및 기타 개인 정보 있습니다.
사용자가 부가기능에서 이러한 범위 중 하나를 승인한 후에는
login_hint
쿼리 매개변수로 식별됩니다. 이 매개변수는
웹 앱의 URL에 대한 정보를 제공합니다. 사용자가 승인하지 않은 경우
이 범위 중 login_hint
개는 전송되지 않습니다.
login_hint
는 선택적으로 사용할 수 있는 표준 OpenID Connect 매개변수입니다.
Google 로그인을 사용하거나 OAuth 토큰을 요청할 때 Google에 전달합니다. 그것은
이는 최종 사용자에게 보다 원활한 승인 환경을 제공하기 위한 것입니다.
클래스룸 부가기능 범위
다음은 클래스룸 부가기능에만 해당하는 범위입니다.
https://www.googleapis.com/auth/classroom.addons.teacher
를 사용하면 모든 API 메서드에 액세스할 수 있습니다.https://www.googleapis.com/auth/classroom.addons.student
를 사용하면 유효성 검사 및 첨부파일 읽기 작업을 시작할 수 있는 액세스 권한입니다.
사용자의 인증 정보를 표시하는 유효한 OAuth 액세스 토큰이 있어도 다음과 같은 추가 요구사항이 적용됩니다.
- 어떤 방법을 사용하든 사용자는 과정의 교사 또는 학생이어야 합니다.
요청의
courseId
에 의해 지정됩니다. - 사용자는 첨부파일 생성, 업데이트, 삭제, 채점을 할 수 있어야 합니다. 선생님이 되는 거에요.
- 특정 Google 클래스룸 게시물에 대한 호출은 다음을 통해 관리됩니다.
확인합니다
- 부가기능에서 게시물에 이미 하나 이상의 첨부파일이 있는 경우 다음을 수행할 수 있습니다.
다음과 같이 요청합니다.
- iframe 실행 유효성 검사
- 첨부파일 읽기, 업데이트, 삭제 작업
- 게시물의 성적 업데이트
- 첨부파일 검색 iframe이 처음 열리면 부가기능이
게시물에 첨부파일이 없습니다.
addOnToken
쿼리 매개변수 는 다음을 요청하는 데 사용할 수 있습니다.- 게시물 아래에 첨부파일 만들기 (
addOnToken
필요) - 실행 유효성 검사 (
addOnToken
가 제공된 경우 유효성이 검증되고 부가기능에 기존 첨부파일이 없는 경우 게시물)
- 게시물 아래에 첨부파일 만들기 (
- 부가기능에서 게시물에 이미 하나 이상의 첨부파일이 있는 경우 다음을 수행할 수 있습니다.
다음과 같이 요청합니다.
OAuth 확인
클래스룸 부가기능은 Google API를 사용하여 Google 사용자의 데이터입니다.
OAuth API 인증 FAQ에서 확인 절차입니다.
Google Workspace Marketplace 등록정보
일반적인 Google Workspace Marketplace SDK 구성 정보는 다음을 참고하세요. Google Workspace Marketplace SDK 사용 설정 및 구성하기 Google Workspace Marketplace 스토어 등록정보 만들기
등록정보 고려사항
공개 Google Cloud 프로젝트의 Marketplace SDK 스토어 Listing은 애플리케이션의 이름과 최종 사용자에게 제공하는 설명입니다 이러한 세부정보를 여러 형식으로 제공할 수 있습니다. 앱 세부정보에서 언어를 확인하세요.
등록정보에서 다음 가이드라인을 따르세요.
앱 세부정보에서 다음 단계를 따릅니다.
애플리케이션 이름에는 구두점을 사용하지 않습니다. 예를 들어 '내 부가기능'을 사용합니다. 작성자: My Company' 'My Company: My Add-on' 대신 사용합니다. 또는 '내 부가기능 회사'.
간단한 설명 및 상세 설명에는 동일한 텍스트일 수 있습니다
+ Pricing(가격 책정) 필드의 값을 선택했는지 확인합니다. 이 필드에 무료, 무료 체험판으로 결제, 결제 수단: 무료 기능 및 유료 가격 책정을 지원합니다. 비용을 지정할 필요가 없음 금액을 명시해야 합니다.
카테고리 필드의 값을 선택했는지 확인합니다. 다음 경우에 학습 리소스 또는 교사 및 관리자 도구가 유용할 수 있습니다. 클래스룸 부가기능
Marketplace의 앱에 등록된 항목을 확인하세요. 세부정보 설명을 참조하세요.
그래픽 저작물에서 다음을 수행합니다.
제공된 그래픽 저작물이 흐릿하지 않으며 지정된 크기를 충족합니다. Google Workspace Marketplace 표준
제공된 스크린샷은 부가기능을 정확하게 나타냅니다. 사용자 환경을 참고하세요.
지원 링크에서 다음 단계를 따릅니다.
- 애플리케이션의 이용약관에 대한 링크를 제공했는지 확인합니다. 서비스를 제공합니다.
Google API 브랜드 가이드라인을 준수하는지 확인합니다. 허용되는 이름과 설명을 포함합니다.
등록정보에서 Google 제품을 언급하는 경우 상표 목록에 제공된 형식이어야 합니다. 반드시 상표(TM) 기호(지정된 경우) 'Google'이 아닌 'Google DocsTM'를 사용합니다. 문서'.
Google의 라이선스 및 결제 서비스와 통합
Google Workspace Marketplace 애플리케이션을 사용하도록 허용하는 데 관심이 있는 경우 Google의 라이선스 및 결제 서비스와 통합하려면 다음 페이지를 방문하세요. Marketplace API를 참조하세요.
설치 설정
부가기능은 관리자 외에도 개별 설치를 허용할 수 있습니다. 설치해야 합니다 이 페이지에서는 두 설치의 몇 가지 차이점을 주로 설명합니다. 있습니다. 두 설치 유형 중 하나를 승격하기 위한 것이 아닙니다. 선택할 수 있는 옵션은 다음과 같습니다. Google Workspace Marketplace SDK에서 개별 설치 허용 여부 App Configuration(앱 구성) 페이지로 이동합니다.
관리자 설치
관리자 설치를 통해 관리자는 모든 조직 단위에 부가기능을 추가할 수 있습니다. 특정 액세스 그룹이나 조직 단위에 액세스할 수 있습니다. 단 도메인 관리자는 관리자 설치를 수행할 수 있습니다. 이 관리자는 원하는 경우 모든 사용자를 대신하여 모든 액세스 범위에 동의할 수 있습니다. 도메인 다음과 같은 경우 사용자에게 액세스 범위에 동의하라는 메시지가 표시되지 않습니다. 관리자가 선택합니다.
다음은 관리자 설치와 관련된 몇 가지 고려사항입니다.
- 더욱 세밀한 제어. 관리자는 계정에 액세스할 수 있는 사용자를 부가기능
- 라이선스와의 호환성. 애플리케이션에 라이선스가 필요한 경우 관리자를 통해 설치 채널을 제공하면 적절하게 배포 및 사용되어야 합니다. 기관입니다.
- 최종 사용자의 부담 감소 관리자 설치는 교사와 학생 모두의 업무 부담을 줄여줍니다 이렇게 하면 보다 원활한 사용자 경험을 제공할 수 있습니다. 더 적은 클릭과 혼란을 야기할 수 있는 기회가 줄어듭니다.
다음 방법에 대한 자세한 내용은 도메인에 Marketplace 앱 설치를 참조하세요. 관리자 설치 수행 및 조직 구조 작동 방식 조직 단위 및 액세스 그룹에 대해 자세히 알아보세요.
개별 설치
개별 설치의 경우 사용자 자신의 계정에 부가기능이 추가됩니다. 사용자 설치 중에 부가기능의 액세스 범위에 동의하라는 메시지가 표시됩니다.
다음은 개별 설치와 관련된 몇 가지 고려사항입니다.
- 도입을 용이하게 합니다. 더 많은 사용자가 다음에서 부가기능을 보고 설치할 수 있습니다. Google Workspace Marketplace 개별 설치를 허용하면 메시지가 표시될 수 있습니다. 제품을 채택하거나 옹호하는 교사의 수를 늘릴 수 있습니다.
- 관리자 테스트. 관리자는 사용자가 컨테이너 이미지를 승인하거나 설치하기 전에 테스트하거나 평가할 수 있습니다. 더 넓어진 그룹이라고 할 수 있습니다.
관리자는 사용자를 대신하여 부가기능을 설치할 뿐 아니라 허용 목록을 유지 관리하여 사용자가 개별 권한을 부여하는 부가기능을 설치해야 합니다 부가기능이 허용 목록에 없는 경우에도 사용자는 Google Workspace Marketplace에 부가기능이 등록되어 있지만 앱을 설치할 수 없습니다. add-on; 대신 해당 애드온이 설치되지 않았음을 설명하는 메시지가 표시됩니다. 도메인 관리자가 설치를 허용했습니다. Google Workspace 관리하기 허용 목록에 있는 Marketplace 앱에서 이 동작에 대해 자세히 알아보세요.
자세한 내용은 Google Workspace Marketplace 설치 설정 문서를 참고하세요. 참조하세요.
앱 통합
첨부파일 설정 URI 입력란에 실행 iframe URL을 입력해야 합니다. 이
URL은 첨부파일 검색 iframe의 iframe src
값으로 사용됩니다. 이
첨부파일 검색 iframe은 교사들이
과제에 첨부할 수 있습니다.
또한 연결이 허용되는 모든 URI 프리픽스를 지정해야 합니다. 선택합니다. 이 기능은 다음에서 첨부파일을 차단하여 보안을 강화합니다. 표시됩니다.
이러한 필드에 대한 자세한 내용은 iframe 가이드 페이지를 참조하세요.
테스트 계정
데모 도메인에서 테스트 계정을 만들어 비공개 부가기능입니다. 계정 간 전환을 테스트하려면 2개의 학생 계정이 필요합니다. 학생 과제물 검토 iframe에 있는 학생.
추천 테스트 계정:
- Tammy 교사, tammy.teacher@<데모 도메인>
- 샘 학생, sam.student@<데모 도메인>
- 샐리 학생, sally.student@<데모 도메인>
다음 절차에 따라 새 테스트 계정을 만듭니다.
- 관리 콘솔에 로그인합니다.
- 사용자로 이동합니다.
- 새 사용자 추가를 클릭합니다 (그림 1 참고).
- 사용자 정보를 입력하고 적절한 역할을 할당합니다.
그림 1. 새 사용자 추가 링크의 위치
관리할 수 있습니다
다음 절차에 따라 새 테스트 그룹을 만듭니다.
- 관리 콘솔에 로그인합니다.
- 그룹스로 이동합니다.
- 그룹 만들기를 클릭합니다 (그림 2 참고).
- 그룹의 회원 및 소유자를 입력합니다.
그림 2. 다음 내의 그룹 만들기 링크 위치
관리할 수 있습니다