Method: courses.courseWork.getAddOnContext
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Recupera i metadati dei 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 chiamare questa funzione per convalidare i parametri di query e il ruolo dell'utente che effettua la richiesta ogni volta che il componente aggiuntivo viene aperto in un iframe.
Questo metodo restituisce i seguenti codici di errore:
PERMISSION_DENIED per 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 |
postId
(deprecated) |
string
Facoltativo. È deprecato. Utilizza itemId.
|
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 è obbligatorio quando non è vera nessuna delle seguenti condizioni:
- Il componente aggiuntivo ha allegati nel post.
- Il progetto dello sviluppatore che ha effettuato 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.
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-25 UTC.
[null,null,["Ultimo aggiornamento 2025-07-25 UTC."],[],[],null,["# Method: courses.courseWork.getAddOnContext\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n\nGets metadata for Classroom add-ons in the context of a specific post.\n\nTo maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/iframes-overview).\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` for [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if the request is malformed.\n- `NOT_FOUND` if one of the identified resources does not exist.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork/{itemId}/addOnContext`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseId` | `string` Required. Identifier of the course. |\n| `itemId` | `string` Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from postId. |\n\n### Query parameters\n\n| Parameters ||\n|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `postId` **(deprecated)** | `string` Optional. Deprecated, use `itemId` instead. |\n| `addOnToken` | `string` Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: - The add-on has attachments on the post. - The developer project issuing the request is the same project that created the post. |\n| `attachmentId` | `string` Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [AddOnContext](/workspace/classroom/reference/rest/v1/AddOnContext).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.addons.student`\n- `\n https://www.googleapis.com/auth/classroom.addons.teacher`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
