Method: courses.courseWork.getAddOnContext

특정 게시물의 컨텍스트에서 클래스룸 부가기능의 메타데이터를 가져옵니다.

자체 데이터 및 권한 모델의 무결성을 유지하려면 부가기능이 iframe에서 열릴 때마다 이를 호출하여 쿼리 매개변수와 요청하는 사용자의 역할을 확인해야 합니다.

이 메서드는 다음 오류 코드를 반환합니다.

  • PERMISSION_DENIED: 액세스 오류
  • INVALID_ARGUMENT: 요청 형식이 잘못된 경우
  • NOT_FOUND: 식별된 리소스 중 하나가 존재하지 않는 경우

HTTP 요청

GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork/{itemId}/addOnContext

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
courseId

string

필수 항목입니다. 과정의 식별자입니다.
itemId

string

첨부파일이 첨부된 Announcement, CourseWork 또는 CourseWorkMaterial의 식별자입니다. 이 필드는 필수 필드이지만 postId에서 이전하는 동안에는 필수로 표시되지 않습니다.

쿼리 매개변수

매개변수
addOnToken

string

선택사항입니다. 요청을 승인하는 토큰입니다.

토큰은 사용자가 클래스룸에서 부가기능의 URL로 리디렉션될 때 쿼리 매개변수로 전달됩니다.

다음 중 어느 것도 참이 아닌 경우 승인 토큰이 필요합니다.

  • 부가기능에 게시물의 첨부파일이 있습니다.
  • 요청을 실행하는 개발자 프로젝트가 게시물을 만든 프로젝트와 동일합니다.
attachmentId

string

선택사항입니다. 첨부파일의 식별자입니다. 이 필드는 사용자가 첨부파일 검색 iframe에 있는 경우를 제외한 모든 요청에 필요합니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

성공한 경우 응답 본문에 AddOnContext의 인스턴스가 포함됩니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/classroom.addons.student
  • https://www.googleapis.com/auth/classroom.addons.teacher

자세한 내용은 승인 가이드를 참고하세요.