管理课业

Classroom 应用支持三种类型的流项： CourseWork、CourseWorkMaterials 和 Announcements。本指南介绍了如何管理 CourseWork，但所有流项的 API 都是类似的。如需详细了解流项类型及其 差异，请参阅 API 资源。

CourseWork 资源表示已分配给特定课程中的学生的一项作业，包括任何其他资料和详细信息，例如截止日期或最高分数。CourseWork 有四种子类型： 作业 、测验作业 、简答题 和 多项选择题 。Classroom API 支持其中三种子类型：作业、简答题和多项选择题。这些类型由 CourseWork.workType 字段表示。

除了 CourseWork 资源之外，您还可以管理已完成的工作 并使用 StudentSubmission 资源。

创建 CourseWork

CourseWork 只能代表课程的教师创建。 尝试代表学生或并非课程教师的网域管理员创建 CourseWork 会导致 PERMISSION_DENIED 错误。如需详细了解 Classroom 中的不同 角色，请参阅用户类型。

使用 CourseWork 方法创建 courses.courseWork.create 时，您可以将链接作为 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的Link resource，将链接的材料包含在CourseWork中。Classroom 会自动提取 title 和缩略图网址 (thumbnailUrl)。 Classroom API 还原生支持 Google 云端硬盘和 YouTube 材料，这些材料可以采用类似的方式包含在 DriveFile 资源 或 YouTubeVideo 资源 中。

如需指定截止日期，请将 dueDate 和 dueTime 字段设置为相应的 UTC 时间。截止日期必须是未来的日期。

CourseWork 响应包含服务器分配的标识符，该标识符可用于在其他 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。

警告： 学生提交的内容只能由创建相应CourseWork资源的开发者控制台 项目修改。这不包括发出请求的用户的权限限制。该项目中的任何 OAuth2 客户端都可以进行修改；associatedWithDeveloper 字段表示当前 OAuth2 客户端是否可以修改给定的 StudentSubmission。

以下部分介绍了管理学生回答的常见操作。

检索学生回答

学生可以检索自己提交的内容，教师可以检索其课程中所有学生的提交内容，而网域管理员可以检索其网域中所有学生的提交内容。每个 StudentSubmission 都会分配一个标识符。如果您知道标识符，请使用 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 的权限并不意味着拥有访问附件或附件元数据的权限。实际上，这意味着如果管理员不是课程的成员，则可能无法看到附加的云端硬盘文件的标题。

向学生回答添加附件

您可以通过附加 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)。如需了解可以附加到 StudentSubmissions 的材料，请参阅 Material。

StudentSubmission 只能由课程教师或拥有该提交内容的学生修改。只有当 StudentSubmission 的 CourseWorkType 为 ASSIGNMENT 时，您才能附加 Materials。

所需的范围取决于发出请求的用户在课程中所扮演的角色。如果用户是教师，请使用以下范围：

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

如果用户是学生，请使用以下范围：

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