Method: courses.posts.getAddOnContext

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

Para manter a integridade dos próprios dados e modelo de permissões, um complemento precisa 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 for inválida.
  • NOT_FOUND se um dos recursos identificados não existir.

Solicitação HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/posts/{postId}/addOnContext

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
courseId

string

Obrigatório. Identificador do curso.
postId
(deprecated)

string

Opcional. Obsoleto. Use itemId

Parâmetros de consulta

Parâmetros
itemId

string

Identificador do aviso, do cursoWork ou do cursoWorkMaterial em que o anexo está anexado. Este campo é obrigatório, mas não fica marcado como tal durante a migração do postId.
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 de desenvolvedor que emitiu a solicitação é o mesmo que criou a postagem.

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 de 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.