Google Classroom 外掛程式現已全面開放開發人員使用！詳情請參閱外掛程式說明文件。

本頁面由 Cloud Translation API 翻譯而成。

管理課程作業

Classroom 應用程式支援三種串流項目：CourseWork、CourseWorkMaterials 和 Announcements。本指南說明如何管理 CourseWork，但所有串流項目的 API 都類似。如要進一步瞭解串流項目類型及其差異，請參閱 API 資源。

CourseWork 資源代表已指派給特定課程學生的工作項目，包括任何額外素材和詳細資料，例如截止日期或最高分數。CourseWork 有四個子類型：作業、測驗作業、簡答題和選擇題。Classroom API 支援三種子類型：作業、簡答題和選擇題。這些類型由 CourseWork.workType 欄位代表。

除了 CourseWork 資源外，您也可以使用 StudentSubmission 資源管理已完成的工作。

建立課堂作業

CourseWork 只能由課程老師代表建立。如果嘗試代表學生或非課程老師的網域管理員建立 CourseWork，系統會顯示 PERMISSION_DENIED 錯誤。請參閱「使用者類型」，進一步瞭解 Classroom 中的不同角色。

使用 courses.courseWork.create 方法建立 CourseWork 時，您可以將連結附加為 materials，如以下程式碼範例所示：

Java

classroom/snippets/src/main/java/CreateCourseWork.java

前往 GitHub 查看

CourseWork courseWork = null;
try {
  // Create a link to add as a material on course work.
  Link articleLink =
      new Link()
          .setTitle("SR-71 Blackbird")
          .setUrl("https://www.lockheedmartin.com/en-us/news/features/history/blackbird.html");

  // Create a list of Materials to add to course work.
  List<Material> materials = Arrays.asList(new Material().setLink(articleLink));

  /* Create new CourseWork object with the material attached.
  Set workType to `ASSIGNMENT`. Possible values of workType can be found here:
  https://developers.google.com/classroom/reference/rest/v1/CourseWorkType
  Set state to `PUBLISHED`. Possible values of state can be found here:
  https://developers.google.com/classroom/reference/rest/v1/courses.courseWork#courseworkstate */
  CourseWork content =
      new CourseWork()
          .setTitle("Supersonic aviation")
          .setDescription(
              "Read about how the SR-71 Blackbird, the world’s fastest and "
                  + "highest-flying manned aircraft, was built.")
          .setMaterials(materials)
          .setWorkType("ASSIGNMENT")
          .setState("PUBLISHED");

  courseWork = service.courses().courseWork().create(courseId, content).execute();

  /* Prints the created courseWork. */
  System.out.printf("CourseWork created: %s\n", courseWork.getTitle());
} catch (GoogleJsonResponseException e) {
  // TODO (developer) - handle error appropriately
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf("The courseId does not exist: %s.\n", courseId);
  } else {
    throw e;
  }
  throw e;
} catch (Exception e) {
  throw e;
}
return courseWork;

Python

classroom/snippets/classroom_create_coursework.py

前往 GitHub 查看

import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def classroom_create_coursework(course_id):
  """
  Creates the coursework the user has access to.
  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """

  creds, _ = google.auth.default()
  # pylint: disable=maybe-no-member

  try:
    service = build("classroom", "v1", credentials=creds)
    coursework = {
        "title": "Ant colonies",
        "description": """Read the article about ant colonies
                              and complete the quiz.""",
        "materials": [
            {"link": {"url": "http://example.com/ant-colonies"}},
            {"link": {"url": "http://example.com/ant-quiz"}},
        ],
        "workType": "ASSIGNMENT",
        "state": "PUBLISHED",
    }
    coursework = (
        service.courses()
        .courseWork()
        .create(courseId=course_id, body=coursework)
        .execute()
    )
    print(f"Assignment created with ID {coursework.get('id')}")
    return coursework

  except HttpError as error:
    print(f"An error occurred: {error}")
    return error


if __name__ == "__main__":
  # Put the course_id of course whose coursework needs to be created,
  # the user has access to.
  classroom_create_coursework(453686957652)

title 和 workType 為必要欄位，所有其他欄位均為選填欄位。如果未指定 state，系統會以草稿狀態建立 CourseWork。

使用具有指定目標 url 的連結資源，即可在 CourseWork 中納入連結的素材資源。Classroom 會自動擷取 title 和縮圖圖片網址 (thumbnailUrl)。Classroom API 也原生支援 Google 雲端硬碟和 YouTube 教材，可透過類似方式加入 DriveFile 資源或 YouTubeVideo 資源。

如要指定截止日期，請將 dueDate 和 dueTime 欄位設為對應的世界標準時間。截止日必須是未來的日期。

CourseWork 回應包含伺服器指派的 ID，可用於在其他 API 要求中參照指派。

擷取 CourseWork

您可以代表對應課程的學生和老師擷取 CourseWork。您也可以代表網域管理員擷取 CourseWork，即使他們不是課程老師也沒關係。如要擷取特定 CourseWork，請使用 courses.courseWork.get。如要擷取所有 CourseWork (可選配符合某些條件)，請使用 courses.courseWork.list。

所需的範圍取決於要求使用者在課程中的角色。如果使用者是學生，請使用下列其中一個權限範圍：

https://www.googleapis.com/auth/classroom.coursework.me.readonly
https://www.googleapis.com/auth/classroom.coursework.me

如果使用者是老師或網域管理員，請使用下列任一權限範圍：

https://www.googleapis.com/auth/classroom.coursework.students.readonly
https://www.googleapis.com/auth/classroom.coursework.students

即使您有權存取 CourseWork，也不代表您有權存取素材資源或素材資源中繼資料。實際上，如果管理員不是課程成員，可能就看不到附加的雲端硬碟檔案標題。

管理學生回應

StudentSubmission 資源代表學生為 CourseWork 完成的作業。資源包含與工作相關的中繼資料，例如工作狀態和成績。建立新 CourseWork 時，系統會為每位學生隱含建立 StudentSubmission。

以下各節將說明管理學生回應的常見動作。

擷取學生回覆

學生可以擷取自己的提交內容、老師可以擷取課程內所有學生的提交內容，而網域管理員則可以擷取網域內所有學生的提交內容。每個 StudentSubmission 都會指派一個 ID。如果您知道 ID，請使用 courses.courseWork.studentSubmissions.get 擷取提交內容。

使用 courses.courseWork.studentSubmissions.list 方法，取得符合某些條件的所有 StudentSubmission 資源，如以下範例所示：

Java

classroom/snippets/src/main/java/ListSubmissions.java

前往 GitHub 查看

List<StudentSubmission> studentSubmissions = new ArrayList<>();
String pageToken = null;

try {
  do {
    ListStudentSubmissionsResponse response =
        service
            .courses()
            .courseWork()
            .studentSubmissions()
            .list(courseId, courseWorkId)
            .setPageToken(pageToken)
            .execute();

    /* Ensure that the response is not null before retrieving data from it to avoid errors. */
    if (response.getStudentSubmissions() != null) {
      studentSubmissions.addAll(response.getStudentSubmissions());
      pageToken = response.getNextPageToken();
    }
  } while (pageToken != null);

  if (studentSubmissions.isEmpty()) {
    System.out.println("No student submission found.");
  } else {
    for (StudentSubmission submission : studentSubmissions) {
      System.out.printf(
          "Student id (%s), student submission id (%s)\n",
          submission.getUserId(), submission.getId());
    }
  }
} catch (GoogleJsonResponseException e) {
  // TODO (developer) - handle error appropriately
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf(
        "The courseId (%s) or courseWorkId (%s) does not exist.\n", courseId, courseWorkId);
  } else {
    throw e;
  }
} catch (Exception e) {
  throw e;
}
return studentSubmissions;

Python

classroom/snippets/classroom_list_submissions.py

前往 GitHub 查看

import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def classroom_list_submissions(course_id, coursework_id):
  """
  Creates the courses the user has access to.
  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """

  creds, _ = google.auth.default()
  # pylint: disable=maybe-no-member
  submissions = []
  page_token = None

  try:
    service = build("classroom", "v1", credentials=creds)
    while True:
      coursework = service.courses().courseWork()
      response = (
          coursework.studentSubmissions()
          .list(
              pageToken=page_token,
              courseId=course_id,
              courseWorkId=coursework_id,
              pageSize=10,
          )
          .execute()
      )
      submissions.extend(response.get("studentSubmissions", []))
      page_token = response.get("nextPageToken", None)
      if not page_token:
        break

    if not submissions:
      print("No student submissions found.")

    print("Student Submissions:")
    for submission in submissions:
      print(
          "Submitted at:"
          f"{(submission.get('id'), submission.get('creationTime'))}"
      )

  except HttpError as error:
    print(f"An error occurred: {error}")
    submissions = None
  return submissions


if __name__ == "__main__":
  # Put the course_id and coursework_id of course whose list needs to be
  # submitted.
  classroom_list_submissions(453686957652, 466086979658)

指定 userId 參數，即可擷取屬於特定學生的 StudentSubmission 資源，如以下範例所示：

Java

classroom/snippets/src/main/java/ListStudentSubmissions.java

前往 GitHub 查看

List<StudentSubmission> studentSubmissions = new ArrayList<>();
String pageToken = null;

try {
  do {
    // Set the userId as a query parameter on the request.
    ListStudentSubmissionsResponse response =
        service
            .courses()
            .courseWork()
            .studentSubmissions()
            .list(courseId, courseWorkId)
            .setPageToken(pageToken)
            .set("userId", userId)
            .execute();

    /* Ensure that the response is not null before retrieving data from it to avoid errors. */
    if (response.getStudentSubmissions() != null) {
      studentSubmissions.addAll(response.getStudentSubmissions());
      pageToken = response.getNextPageToken();
    }
  } while (pageToken != null);

  if (studentSubmissions.isEmpty()) {
    System.out.println("No student submission found.");
  } else {
    for (StudentSubmission submission : studentSubmissions) {
      System.out.printf("Student submission: %s.\n", submission.getId());
    }
  }

Python

classroom/snippets/classroom_list_student_submissions.py

前往 GitHub 查看

import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def classroom_list_student_submissions(course_id, coursework_id, user_id):
  """
  Creates the courses the user has access to.
  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """

  creds, _ = google.auth.default()
  # pylint: disable=maybe-no-member
  submissions = []
  page_token = None

  try:
    service = build("classroom", "v1", credentials=creds)
    while True:
      coursework = service.courses().courseWork()
      response = (
          coursework.studentSubmissions()
          .list(
              pageToken=page_token,
              courseId=course_id,
              courseWorkId=coursework_id,
              userId=user_id,
          )
          .execute()
      )
      submissions.extend(response.get("studentSubmissions", []))
      page_token = response.get("nextPageToken", None)
      if not page_token:
        break

    if not submissions:
      print("No student submissions found.")

    print("Student Submissions:")
    for submission in submissions:
      print(
          "Submitted at:"
          f"{(submission.get('id'), submission.get('creationTime'))}"
      )

  except HttpError as error:
    print(f"An error occurred: {error}")
  return submissions


if __name__ == "__main__":
  # Put the course_id, coursework_id and user_id of course whose list needs
  # to be submitted.
  classroom_list_student_submissions(453686957652, 466086979658, "me")

學生的識別資訊是專屬 ID 或電子郵件地址，如 Student 資源所示。目前使用者也可以使用 "me" 縮寫參照自己的 ID。

您也可以擷取課程中所有作業的學生繳交內容。如要這麼做，請使用 "-" 文字常值做為 courseWorkId，如以下範例所示：

Java

service.courses().courseWork().studentSubmissions()
    .list(courseId, "-")
    .set("userId", userId)
    .execute();

Python

service.courses().courseWork().studentSubmissions().list(
    courseId=<course ID or alias>,
    courseWorkId='-',
    userId=<user ID>).execute()

所需的範圍取決於要求使用者在課程中的角色。如果使用者是老師或網域管理員，請使用下列範圍：

https://www.googleapis.com/auth/classroom.coursework.students.readonly
https://www.googleapis.com/auth/classroom.coursework.students

如果使用者是學生，請使用下列範圍：

https://www.googleapis.com/auth/classroom.coursework.me.readonly
https://www.googleapis.com/auth/classroom.coursework.me

即使您有權存取 StudentSubmission，也不代表您有權存取附件或附件中繼資料。實際上，如果管理員不是課程成員，可能就看不到附加的 Google 雲端硬碟檔案名稱。

在學生回覆中加入附件

您可以附加 Link、DriveFile 或 YouTubeVideo 資源，藉此附加學生提交作業的連結。這項操作會使用 courses.courseWork.studentSubmissions.modifyAttachments，如以下範例所示：

Java

classroom/snippets/src/main/java/ModifyAttachmentsStudentSubmission.java

前往 GitHub 查看

StudentSubmission studentSubmission = null;
try {
  // Create ModifyAttachmentRequest object that includes a new attachment with a link.
  Link link = new Link().setUrl("https://en.wikipedia.org/wiki/Irrational_number");
  Attachment attachment = new Attachment().setLink(link);
  ModifyAttachmentsRequest modifyAttachmentsRequest =
      new ModifyAttachmentsRequest().setAddAttachments(Arrays.asList(attachment));

  // The modified studentSubmission object is returned with the new attachment added to it.
  studentSubmission =
      service
          .courses()
          .courseWork()
          .studentSubmissions()
          .modifyAttachments(courseId, courseWorkId, id, modifyAttachmentsRequest)
          .execute();

  /* Prints the modified student submission. */
  System.out.printf(
      "Modified student submission attachments: '%s'.\n",
      studentSubmission.getAssignmentSubmission().getAttachments());
} catch (GoogleJsonResponseException e) {
  // TODO (developer) - handle error appropriately
  GoogleJsonError error = e.getDetails();
  if (error.getCode() == 404) {
    System.out.printf(
        "The courseId (%s), courseWorkId (%s), or studentSubmissionId (%s) does "
            + "not exist.\n",
        courseId, courseWorkId, id);
  } else {
    throw e;
  }
} catch (Exception e) {
  throw e;
}
return studentSubmission;

Python

classroom/snippets/classroom_add_attachment.py

前往 GitHub 查看

def classroom_add_attachment(course_id, coursework_id, submission_id):
  """
  Adds attachment to existing course with specific course_id.
  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """
  creds, _ = google.auth.default()
  # pylint: disable=maybe-no-member
  request = {
      "addAttachments": [
          {"link": {"url": "http://example.com/quiz-results"}},
          {"link": {"url": "http://example.com/quiz-reading"}},
      ]
  }

  try:
    service = build("classroom", "v1", credentials=creds)
    while True:
      coursework = service.courses().courseWork()
      coursework.studentSubmissions().modifyAttachments(
          courseId=course_id,
          courseWorkId=coursework_id,
          id=submission_id,
          body=request,
      ).execute()

  except HttpError as error:
    print(f"An error occurred: {error}")


if __name__ == "__main__":
  # Put the course_id, coursework_id and submission_id of course in which
  # attachment needs to be added.
  classroom_add_attachment("course_id", "coursework_id", "me")

Link 附件是由目標 url 定義；Classroom 會自動擷取 title 和縮圖 (thumbnailUrl)。請參閱 Material，瞭解可附加至 StudentSubmissions 的素材。

只有課程老師或課程擁有者可以修改 StudentSubmission。只有在 StudentSubmission 的 CourseWorkType 為 ASSIGNMENT 時，才能附加 Materials。

所需的範圍取決於要求使用者在課程中的角色。如果使用者是老師，請使用下列範圍：

https://www.googleapis.com/auth/classroom.coursework.students

如果使用者是學生，請使用下列範圍：

https://www.googleapis.com/auth/classroom.coursework.me

建立及管理主題