Method: courses.courseWork.getAddOnContext

Recebe metadados para complementos do Google Sala de Aula no contexto de uma postagem específica.

Para manter a integridade do próprio modelo de dados e permissões, um complemento precisará chamá-lo 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. Este campo é obrigatório, mas não está marcado como tal enquanto migramos de postId.

Parâmetros de consulta

Parâmetros
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 opçõ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.