Method: courses.courseWork.getAddOnContext

Obtiene metadatos para los complementos de Classroom en el contexto de una publicación específica.

Para mantener la integridad de su propio modelo de datos y permisos, un complemento debe llamarlo para validar los parámetros de consulta y el rol del usuario solicitante cada vez que se abra el complemento en un iframe.

Este método muestra los siguientes códigos de error:

  • PERMISSION_DENIED para errores de acceso.
  • Es INVALID_ARGUMENT si la solicitud tiene un formato incorrecto.
  • NOT_FOUND si uno de los recursos identificados no existe.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
courseId

string

Obligatorio. Es el identificador del curso.
itemId

string

Es el identificador del anuncio, CourseWork o CourseWorkMaterial con el que se adjunta el archivo adjunto. Este campo es obligatorio, pero no se marca como tal mientras se realiza la migración desde postId.

Parámetros de consulta

Parámetros
addOnToken

string

Opcional. El token que autoriza la solicitud.

El token se pasa como parámetro de consulta cuando se redirecciona al usuario de Classroom a la URL del complemento.

El token de autorización es obligatorio cuando no se cumple ninguna de las siguientes condiciones:

  • El complemento tiene archivos adjuntos en la publicación.
  • El proyecto de desarrollador que emite la solicitud es el mismo que creó la publicación.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de AddOnContext.

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

Para obtener más información, consulta la guía de autorización.