在 Google 课堂之外创建附件

本指南介绍了如何在网站或应用中创建插件附件。 这些互动类似于使用 CourseWork API 创建作业 endpoints。实现此历程，以允许用户创建插件附件 来自您的网站或应用

重要提示 ：在以下情况下，强烈建议您实施此附件创建流程 您已创建 CourseWork 分配。扩展 CourseWork 实现将更多用户转化为插件，并且需要 只需极少的额外工作即可。

警告： 当前的资格条件检查端点很快将被新的 资格检查框架。你可以申请访问 courses.checkAddOnCreationEligibility完成资格检查 权限申请表单。

工作流程

概括来讲，附件创建过程遵循以下顺序：

1. 教师用户打开您的网站或应用。他们会选择一段内容 分配给学生的作业。
2. 检查用户是否可以创建插件附件。
3. 如果用户无法创建插件附件，请创建 CourseWork 使用指向所选内容的网址作为链接材料。
4. 如果用户可以创建插件附件，请执行以下操作： <ph type="x-smartling-placeholder">
   </ph>
   1. 创建作业。
   2. 创建链接到所选内容的插件附件 并将其与新分配相关联。
5. 通知教师该作业已成功创建。

以下各部分介绍了每项操作。

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

您可以代表符合条件的用户创建插件附件。符合条件的 user 是您尝试创建的课程中的教师用户 包含“教学与学习版或教育 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}.')

如果用户符合条件，响应将包含布尔值 “isCreateAttachmentEligible”值已设置为“true”。如果用户不符合条件 响应不会返回 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. 教师视图，包含包含链接资料的 CourseWork 作业草稿。

符合条件的用户

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

1. 创建一项不包含任何附件的新“CourseWork”作业。
2. 创建插件附件。
   • 将 AddOnAttachment 的 itemId 设置为新创建的文件的 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 课堂中显示为附件卡片。网址 并在相应 每个 View 的 iframe。