Crea archivos adjuntos fuera de Google Classroom

En esta guía, se explica cómo crear archivos adjuntos de complementos en tu sitio web o aplicación. Las interacciones son similares a la creación de tareas con los extremos de la API de CourseWork. Implementa este recorrido para permitir que los usuarios creen archivos adjuntos de complementos desde tu sitio web o aplicación.

Flujo de trabajo

En términos generales, el recorrido de creación de archivos adjuntos sigue esta secuencia:

  1. Un usuario profesor abre tu sitio web o aplicación. Selecciona una parte del contenido para asignársela a sus alumnos.
  2. Verifica que el usuario pueda crear archivos adjuntos de complementos.
  3. Si el usuario no puede crear archivos adjuntos de complementos, crea una tarea de CourseWork con la URL del contenido seleccionado como material de vínculo.
  4. Si el usuario puede crear archivos adjuntos de complementos, haz lo siguiente:
    1. Crea una tarea.
    2. Crea un archivo adjunto de complemento que se vincule al contenido seleccionado y asócialo con la tarea nueva.
  5. Informa al profesor que la tarea se creó correctamente.

Cada acción se describe en las siguientes secciones.

Verifica si un usuario puede crear archivos adjuntos de complementos

Puedes crear archivos adjuntos de complementos en nombre de un usuario que cumpla con los requisitos. Un usuario que cumple con los requisitos es un usuario que es profesor en el curso en el que intentas crear tareas de CourseWork y tiene asignada la licencia de Google Workspace for Education de Teaching &Learning o Education Plus.

Comienza por determinar si el usuario puede crear archivos adjuntos de complementos. Para ello, envía una solicitud al userProfiles.checkUserCapability extremo con el CREATE_ADD_ON_ATTACHMENT parámetro de capacidad. Inspecciona el campo booleano allowed en la respuesta. Un valor true indica que el usuario es apto para crear archivos adjuntos de complementos.

Python

eligibility_response = (
  classroom_service.userProfiles()
  .checkUserCapability(
    userId="me",
    capability="CREATE_ADD_ON_ATTACHMENT",
    # The previewVersion is necessary while the method is available in the
    # Workspace Developer Preview Program.
    previewVersion="V1_20240930_PREVIEW",
  ).execute()
)
is_create_attachment_eligible = (
  eligibility_response.get('allowed')
)
print('User eligibility for add-on attachment creation: '
      f'{is_create_attachment_eligible}.')

Dirige al usuario según su elegibilidad

La elegibilidad determina si puedes crear archivos adjuntos de complementos para un usuario.

Usuario no apto

Si el usuario no puede crear archivos adjuntos de complementos, crea una CourseWork tarea nueva con la URL del contenido seleccionado por el usuario como 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")}'
  )

La respuesta contiene una tarea en el curso solicitado con el contenido adjunto. Los usuarios pueden hacer clic en el Link para abrir el contenido en tu sitio en una pestaña nueva.

Borrador de tarea de CourseWork con material de vínculo

Figura 1: Vista del profesor de una tarea de CourseWork en borrador con material de vínculo

Usuario que cumple con los requisitos

Haz lo siguiente si el usuario puede crear archivos adjuntos de complementos.

  1. Crea una tarea de CourseWork nueva sin archivos adjuntos.
  2. Crea un archivo adjunto de complemento.

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")}'
  )

El complemento aparece como una tarjeta de archivo adjunto en Classroom. Las URLs especificadas en la solicitud se abren en el iframe adecuado para cada vista.