Creare allegati al di fuori di Google Classroom

Questa guida spiega come creare allegati aggiuntivi nel tuo sito web o nella tua applicazione. Le interazioni sono simili alla creazione di compiti utilizzando gli endpoint dell'API CourseWork. Implementa questo percorso per consentire agli utenti di creare allegati aggiuntivi dal tuo sito web o dalla tua applicazione.

Flusso di lavoro

A livello generale, il percorso di creazione degli allegati segue questa sequenza:

1. Un insegnante apre il tuo sito web o la tua app e seleziona un contenuto da assegnare ai suoi studenti.
2. Verifica che l'utente possa creare allegati dei componenti aggiuntivi.
3. Se l'utente non può creare allegati aggiuntivi, crea un compito con l'URL dei contenuti selezionati come materiale di tipo link.
4. Se l'utente può creare allegati dei componenti aggiuntivi, procedi nel seguente modo:
   1. Crea un compito.
   2. Crea un allegato del componente aggiuntivo che rimandi ai contenuti selezionati e associarlo al nuovo compito.
5. Comunica all'insegnante che il compito è stato creato correttamente.

Ogni azione è descritta nelle sezioni seguenti.

Verificare se un utente può creare allegati dei componenti aggiuntivi

Puoi creare allegati aggiuntivi per conto di un utente idoneo. Un utente idoneo è un insegnante del corso in cui stai tentando di creare compiti in e dispone della licenza Teaching and Learning o Education Plus di Google Workspace for Education.

Inizia determinando se l'utente può creare allegati dei componenti aggiuntivi. Puoi farlo inviando una richiesta all'endpoint userProfiles.checkUserCapability con il parametro di funzionalità CREATE_ADD_ON_ATTACHMENT. Esamina il campo booleano allowed nella risposta; un valore true indica che l'utente è idoneo a creare allegati dei componenti aggiuntivi.

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

Instradare l'utente in base alla sua idoneità

L'idoneità determina se puoi creare allegati dei componenti aggiuntivi per un utente.

Utente non idoneo

Se l'utente non può creare allegati di componenti aggiuntivi, crea una nuova assegnazione CourseWork con l'URL dei contenuti selezionati dall'utente come Link.

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 risposta contiene un compito nel corso richiesto con i contenuti allegati. Gli utenti possono fare clic su Link per aprire i contenuti del tuo sito in una nuova scheda.

Figura 1. Visualizzazione lato insegnante di una bozza di compito di Coursework con materiale del link.

Utente idoneo

Se l'utente può creare allegati dei componenti aggiuntivi, procedi nel seguente modo.

1. Crea un nuovo compito CourseWork senza allegati.
2. Creare un allegato del componente aggiuntivo.
   • Imposta itemId di AddOnAttachment su id dell'assegnazione appena creata.
   • Assicurati di fornire gli URL dei contenuti selezionati dall'utente per ogni visualizzazione che supporti.

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

Il componente aggiuntivo viene visualizzato come scheda allegato in Classroom. Gli URL specificati nella richiesta si aprono nell'iframe appropriato per ogni visualizzazione.