Method: courses.courseWork.getAddOnContext

Recupera i metadati per i componenti aggiuntivi di Classroom nel contesto di un post specifico.

Per mantenere l'integrità del proprio modello di dati e autorizzazioni, un componente aggiuntivo deve chiamarlo per convalidare i parametri di query e il ruolo dell'utente richiedente ogni volta che il componente aggiuntivo viene aperto in un iframe.

Questo metodo restituisce i seguenti codici di errore:

  • PERMISSION_DENIED per gli errori di accesso.
  • INVALID_ARGUMENT se la richiesta non è valida.
  • NOT_FOUND se una delle risorse identificate non esiste.

Richiesta HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork/{itemId}/addOnContext

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
courseId

string

Obbligatorio. Identificatore del corso.
itemId

string

Identificatore di Announcement, CourseWork o CourseWorkMaterial a cui è allegato l'allegato. Questo campo è obbligatorio, ma non è contrassegnato come tale durante la migrazione da postId.

Parametri di query

Parametri
addOnToken

string

(Facoltativo) Token che autorizza la richiesta.

Il token viene passato come parametro di query quando l'utente viene reindirizzato da Classroom all'URL del componente aggiuntivo.

Il token di autorizzazione è necessario quando nessuna delle seguenti condizioni è vera:

  • Il componente aggiuntivo contiene allegati.
  • Il progetto sviluppatore che invia la richiesta è lo stesso che ha creato il post.
attachmentId

string

(Facoltativo) L'identificatore dell'allegato. Questo campo è obbligatorio per tutte le richieste, tranne quando l'utente si trova nell'iframe di rilevamento degli allegati.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di AddOnContext.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/classroom.addons.student
  • https://www.googleapis.com/auth/classroom.addons.teacher

Per ulteriori informazioni, consulta la Guida all'autorizzazione.