Criar anexos fora do Google Sala de Aula

Este guia aborda a criação de anexos de complementos no seu site ou aplicativo. As interações são semelhantes à criação de atividades usando os endpoints da API CourseWork. Implemente essa jornada para permitir que os usuários criem anexos de complementos do seu site ou aplicativo.

Importante: é altamente recomendável implementar esse fluxo de criação de anexos se você já criar atribuições CourseWork. Estender uma implementação do CourseWork permite que você converta muito mais usuários para seu complemento e requer pouco trabalho extra.

Aviso: o endpoint de verificação de qualificação atual será substituído em breve por um novo framework de verificação de qualificação. Você pode solicitar acesso ao courses.checkAddOnCreationEligibility preenchendo o formulário de solicitação de acesso para verificação de qualificação.

Fluxo de trabalho

De modo geral, a jornada de criação de anexos segue esta sequência:

1. Um usuário professor abre seu site ou app e seleciona um conteúdo para atribuir aos estudantes.
2. Verifique se o usuário consegue criar anexos de complementos.
3. Se o usuário não conseguir criar anexos de complementos, crie uma atividade do CourseWork com o URL do conteúdo selecionado como um Link Material.
4. Se o usuário conseguir criar anexos de complementos, faça o seguinte:
   1. Crie uma atividade.
   2. Crie um anexo de complementos que vincule ao conteúdo selecionado e associe à nova atividade.
5. Informe ao professor que a atividade foi criada.

Cada ação é descrita nas seções a seguir.

Verificar se um usuário pode criar anexos de complementos

É possível criar anexos de complementos em nome de um usuário qualificado. Um usuário qualificado é um professor do curso em que você está tentando criar atividades de trabalho no curso e tem uma licença da edição Teaching & Learning ou Education Plus do Google Workspace for Education atribuída a ele.

Importante: a qualificação para criar anexos de complementos pode ser diferente para cada curso. Sempre verifique a qualificação do usuário antes de tentar criar anexos de complementos.

Comece determinando se o usuário pode criar complementos em um determinado Course. Emita uma solicitação para o endpoint courses.checkAddOnCreationEligibility, incluindo o ID do curso.

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

Se o usuário estiver qualificado, a resposta conterá o valor booleano isCreateAttachmentEligible definido como true. Se ele não estiver qualificado, a resposta não vai retornar o booleano isCreateAttachmentEligible.

Direcione o usuário com base na elegibilidade dele.

A qualificação determina se você pode criar anexos de complementos para um usuário.

Importante: os complementos oferecem vantagens significativas na experiência do usuário. Sempre crie anexos de complementos para usuários qualificados.

Usuário não qualificado

Se o usuário não conseguir criar anexos de complementos, crie uma nova atribuição CourseWork com o URL de conteúdo selecionado pelo usuário como um 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")}'
  )

A resposta contém uma atividade no curso solicitado com o conteúdo em anexo. Os usuários podem clicar no Link para abrir o conteúdo do site em uma nova guia.

Figura 1. Visualização de um rascunho de atividade do CourseWork com o link Material para os professores.

Usuário qualificado

Faça o seguinte se o usuário conseguir criar anexos de complementos.

1. Crie uma atividade CourseWork sem anexos.
2. Crie um anexo de complementos.
   • Defina o itemId da AddOnAttachment como o id da atribuição recém-criada.
   • Forneça URLs para o conteúdo selecionado pelo usuário em cada visualização compatível.

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

Observação: um token de complemento não será necessário ao criar um anexo em uma atribuição que você criou.

O complemento aparece como um card de anexo no Google Sala de Aula. Os URLs especificados na solicitação são abertos no iframe apropriado para cada visualização.