Creare allegati al di fuori di Google Classroom

Questa guida illustra la creazione di allegati di componenti 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.

Importante: ti consigliamo vivamente di implementare questo flusso di creazione degli allegati se crei già compiti CourseWork. L'estensione di un'implementazione di CourseWork ti consente di convertire molti più utenti al tuo componente aggiuntivo e richiede poco lavoro aggiuntivo.

Avviso: l'attuale endpoint di controllo dell'idoneità verrà presto sostituito da un nuovo framework di controllo dell'idoneità. Puoi richiedere l'accesso a courses.checkAddOnCreationEligibility compilando il modulo di richiesta di accesso al controllo dell'idoneità.

Flusso di lavoro

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

1. Un utente 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 di componenti aggiuntivi.
3. Se l'utente non riesce a creare allegati di componenti aggiuntivi, crea un compito di CourseWork con l'URL dei contenuti selezionati come materiale per i link.
4. Se l'utente può creare allegati di componenti aggiuntivi:
   1. Crea un compito.
   2. Crea un allegato di un componente aggiuntivo che rimandi ai contenuti selezionati e associalo al nuovo compito.
5. Comunica all'insegnante che il compito è stato creato correttamente.

Ciascuna azione è descritta nelle sezioni seguenti.

Verificare se un utente può creare allegati di componenti aggiuntivi

Puoi creare allegati di componenti aggiuntivi per conto di un utente idoneo. Un utente idoneo è un utente che è un insegnante del corso in cui stai cercando di creare compiti di lavoro del corso e a cui è assegnata la licenza della versione Teaching & Learning o Education Plus Google Workspace for Education.

Punto chiave: l'idoneità alla creazione di allegati aggiuntivi può essere diversa per ogni corso. Verifica sempre l'idoneità dell'utente prima di tentare di creare allegati di componenti aggiuntivi.

Inizia determinando se l'utente può creare componenti aggiuntivi in una determinata Course. Invia una richiesta all'endpoint courses.checkAddOnCreationEligibility, includendo l'ID corso.

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 l'utente è idoneo, la risposta contiene il valore booleano isCreateAttachmentEligible impostato su true. Se l'utente non è idoneo, la risposta non restituirà il valore booleano isCreateAttachmentEligible.

Indirizzare l'utente in base alla sua idoneità

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

Importante: i componenti aggiuntivi offrono vantaggi significativi per l'esperienza utente. Crea sempre allegati di componenti aggiuntivi per gli utenti idonei.

Utente non idoneo

Se l'utente non riesce a creare allegati di componenti aggiuntivi, crea un nuovo compito CourseWork con l'URL dei contenuti selezionati dall'utente come 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 risposta contiene un compito nel corso richiesto con il contenuto allegato. Gli utenti possono fare clic sulla Link per aprire i contenuti del tuo sito in una nuova scheda.

Figura 1. Vista dell'insegnante di una bozza di compito di CourseWork con Link Material.

Utente idoneo

Procedi nel seguente modo se l'utente può creare allegati di componenti aggiuntivi.

1. Crea un nuovo compito in CourseWork senza allegati.
2. Crea l'allegato di un componente aggiuntivo.
   • Imposta il itemId di AddOnAttachment sul valore id del compito appena creato.
   • Assicurati di fornire gli URL dei contenuti selezionati dall'utente per ogni vista supportata.

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

Nota: non è necessario un token del componente aggiuntivo se crei un allegato per un compito creato da te.

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