Method: courses.courseWork.getAddOnContext
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recebe metadados de complementos do Google Sala de aula no contexto de uma postagem específica.
Para manter a integridade dos próprios dados e do modelo de permissões, um complemento precisa chamar esse método para validar os parâmetros de consulta e o papel do usuário solicitante sempre que o complemento for aberto em um iframe.
Esse método retorna os seguintes códigos de erro:
PERMISSION_DENIED para erros de acesso.INVALID_ARGUMENT se a solicitação estiver incorreta.NOT_FOUND, se um dos recursos identificados não existir.
Solicitação HTTP
GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork/{itemId}/addOnContext
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros |
courseId |
string
Obrigatório. Identificador do curso.
|
itemId |
string
Identificador do Announcement, CourseWork ou CourseWorkMaterial em que o anexo está anexado. Esse campo é obrigatório, mas não é marcado como tal enquanto estamos migrando de postId.
|
Parâmetros de consulta
| Parâmetros |
postId
(deprecated) |
string
Opcional. obsoleto: use itemId.
|
addOnToken |
string
Opcional. Token que autoriza a solicitação. O token é transmitido como um parâmetro de consulta quando o usuário é redirecionado do Google Sala de Aula para o URL do complemento. O token de autorização é necessário quando nenhuma das seguintes condições é verdadeira:
- O complemento tem anexos na postagem.
- O projeto do desenvolvedor que emite a solicitação é o mesmo que criou a postagem.
|
attachmentId |
string
Opcional. O identificador do anexo. Esse campo é obrigatório para todas as solicitações, exceto quando o usuário está no iframe de descoberta de anexos.
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de AddOnContext.
Escopos de autorização
Requer um dos seguintes escopos do OAuth:
https://www.googleapis.com/auth/classroom.addons.student
https://www.googleapis.com/auth/classroom.addons.teacher
Para mais informações, consulte o guia de autorização.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 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)."]]
