在 Google 课堂之外创建附件

本指南介绍了如何在您的网站或应用中创建插件附件。 这些交互类似于使用 CourseWork API 端点创建作业。实现此历程，以便用户通过您的网站或应用创建插件附件。

重要提示 ：如果您已创建 CourseWork 分配，我们强烈建议您实现此连接创建流程。通过扩展 CourseWork 实现，您可以将更多用户转换为您的插件，并且只需执行少量额外操作。

Workflows

大体上讲，连接创建流程如下：

1. 教师用户打开您的网站或应用，选择一段内容以分配给学生。
2. 检查用户是否可以创建插件附件。
3. 如果用户无法创建插件附件，请创建一项 CourseWork 作业，并将所选内容的网址作为链接资料。
4. 如果用户可以创建插件附件，请执行以下操作：
   1. 创建作业。
   2. 创建链接到所选内容的插件附件，并将其与新作业关联。
   3. 通知教师已成功创建作业。

以下各部分介绍了各种操作。

检查用户是否可以创建插件附件

您可以代表符合条件的用户创建插件附件。符合条件的用户是指，您正尝试在其中创建课程作业作业的课程中的教师，且该帐号已分配有教与学或教育 Plus 版 Google Workspace 教育版许可。

要点 ：每门课程的插件附件创建条件可能各不相同。在尝试创建插件连接之前，请务必检查用户是否符合条件。

首先，确定用户是否可以在给定的 Course 中创建插件。 向 courses.checkAddOnCreationEligibility 端点发出请求，包括课程 ID。

Python

eligibility_response = (
  classroom_service.courses()
  .checkAddOnCreationEligibility(courseId=course_id)
  .execute()
)
is_create_attachment_eligible = (
  eligibility_response.get('isCreateAttachmentEligible')
)
print(f'User eligibility for course {eligibility_response.get("courseId")}'
      f': {is_create_attachment_eligible}.')

如果用户符合条件，响应会包含设置为 true 的布尔值 isCreateAttachmentEligible。如果用户不符合条件，则响应不会返回 isCreateAttachmentEligible 布尔值。

根据用户的资格条件来转送用户

资格条件决定了您是否可以为用户创建插件附件。

重要提示 ：插件可带来显著的用户体验优势。请务必为符合条件的用户创建插件连接。

不符合条件的用户

如果用户无法创建插件附件，则创建新的 CourseWork 分配，并将用户选择的内容网址作为 Link。

Python

if not is_create_attachment_eligible:
  coursework = {
    'title': 'My CourseWork Assignment with Link Material',
    'description': 'Created using the Classroom CourseWork API.',
    'workType': 'ASSIGNMENT',
    'state': 'DRAFT',  # Set to 'PUBLISHED' to assign to students.
    'maxPoints': 100,
    'materials': [
      {'link': {'url': my_content_url}}
    ]
  }

  assignment = (
    service.courses()
    .courseWork()
    .create(courseId=course_id, body=coursework)
    .execute()
  )

  print(
    f'Link Material assignment created with ID: {assignment.get("id")}'
  )

响应中包含所请求课程中的作业以及附加的内容。用户可以点击 Link，在新标签页中打开网站中的内容。

图 1. 教师可以查看包含链接资料的课程作业作业草稿。

符合条件的用户

如果用户可以创建插件附件，请执行以下操作。

1. 创建一份不含任何附件的新“CourseWork”作业。
2. 创建插件附件。
   • 将 AddOnAttachment 的 postId 设置为新创建的分配作业的 id。
   • 确保为您支持的每个视图提供用户选择内容的网址。

Python

if is_create_attachment_eligible:
  coursework = {
    'title': 'My CourseWork Assignment with Add-on Attachment',
    'description': 'Created using the Classroom CourseWork API.',
    'workType': 'ASSIGNMENT',
    'state': 'DRAFT',  # Set to 'PUBLISHED' to assign to students.
    'maxPoints': 100,
  }

  assignment = (
    classroom_service.courses()
    .courseWork()
    .create(courseId=course_id, body=coursework)
    .execute()
  )

  print(
    f'Empty assignment created with ID: {assignment.get("id")}'
  )

  attachment = {
    'teacherViewUri': {'uri': teacher_view_url},
    'studentViewUri': {'uri': student_view_url},
    'studentWorkReviewUri': {'uri': grade_student_work_url},
    'title': f'Test Attachment {test_label}',
  }

  add_on_attachment = (
    service.courses()
    .courseWork()
    .addOnAttachments()
    .create(
      courseId=course_id,
      itemId=assignment.get("id"),  # ID of the new assignment.
      body=attachment,
    )
    .execute()
  )

  print(
    f'Add-on attachment created with ID: {add_on_attachment.get("id")}'
  )

注意 ：在您创建的作业中创建附件时，不需要使用插件令牌。

该插件会在 Google 课堂中显示为附件卡片。请求中指定的网址会在每个视图的相应 iframe 中打开。