Google Classroom API

Gerencia turmas, listas de estudantes e convites no Google Sala de Aula.

Serviço: classroom.googleapis.com

Para chamar esse serviço, recomendamos que você use as bibliotecas de cliente fornecidas pelo Google. Caso o aplicativo precise usar bibliotecas próprias para chamar esse serviço, use as informações a seguir quando fizer as solicitações da API.

Documento de descoberta

Um Documento de descoberta é uma especificação legível por máquina para descrever e consumir APIs REST. Ele é usado para criar bibliotecas de cliente, plug-ins de IDE e outras ferramentas que interagem com as APIs do Google. Um serviço pode fornecer vários documentos de descoberta. O serviço fornece o seguinte documento de descoberta:

Endpoint de serviço

Um endpoint de serviço é um URL de base que especifica o endereço de rede de um serviço de API. Um serviço pode ter vários endpoints de serviço. Este serviço tem o endpoint a seguir, e todos os URIs abaixo são relativos a ele:

  • https://classroom.googleapis.com

Recurso REST: v1.courses

Métodos
checkAddOnCreationEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkAddOnCreationEligibility
Informa se um usuário pode criar anexos de complementos em um determinado curso.
checkGradingPeriodsSetupEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility
Informa se um usuário pode atualizar as GradingPeriodSettings em um determinado curso.
create POST /v1/courses
Cria um curso.
delete DELETE /v1/courses/{id}
Exclui um curso.
get GET /v1/courses/{id}
Retorna um curso.
getGradingPeriodSettings GET /v1/courses/{courseId}/gradingPeriodSettings
Retorna as configurações do período de avaliação em um curso.
list GET /v1/courses
Retorna uma lista de cursos que o usuário solicitante tem permissão para ver, restrita aos que correspondem à solicitação.
patch PATCH /v1/courses/{id}
Atualiza um ou mais campos em um curso.
update PUT /v1/courses/{id}
Atualiza um curso.
updateGradingPeriodSettings PATCH /v1/courses/{courseId}/gradingPeriodSettings
Atualiza as configurações do período de avaliação de um curso.

Recurso REST: v1.courses.aliases

Métodos
create POST /v1/courses/{courseId}/aliases
Cria um alias para um curso.
delete DELETE /v1/courses/{courseId}/aliases/{alias}
Exclui um alias de um curso.
list GET /v1/courses/{courseId}/aliases
Retorna uma lista de aliases de um curso.

Recurso REST: v1.courses.announcements

Métodos
create POST /v1/courses/{courseId}/announcements
Cria um aviso.
delete DELETE /v1/courses/{courseId}/announcements/{id}
Exclui um aviso.
get GET /v1/courses/{courseId}/announcements/{id}
Retorna um aviso.
getAddOnContext GET /v1/courses/{courseId}/announcements/{itemId}/addOnContext
Recebe metadados de complementos do Google Sala de Aula no contexto de um post específico.
list GET /v1/courses/{courseId}/announcements
Retorna uma lista de avisos que o solicitante tem permissão para ver.
modifyAssignees POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees
Modifica o modo e as opções de responsável de um aviso.
patch PATCH /v1/courses/{courseId}/announcements/{id}
Atualiza um ou mais campos de um aviso.

Recurso REST: v1.courses.announcements.addOnAttachments

Métodos
create POST /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Cria um anexo de complemento em um post.
delete DELETE /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Exclui um anexo de complemento.
get GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Retorna um anexo de complemento.
list GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Retorna todos os anexos criados por um complemento na postagem.
patch PATCH /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Atualiza um anexo de complemento.

Recurso REST: v1.courses.courseWork

Métodos
create POST /v1/courses/{courseId}/courseWork
Cria atividades do curso.
delete DELETE /v1/courses/{courseId}/courseWork/{id}
Exclui uma atividade do curso.
get GET /v1/courses/{courseId}/courseWork/{id}
Retorna as atividades do curso.
getAddOnContext GET /v1/courses/{courseId}/courseWork/{itemId}/addOnContext
Recebe metadados de complementos do Google Sala de Aula no contexto de um post específico.
list GET /v1/courses/{courseId}/courseWork
Retorna uma lista de atividades que o solicitante tem permissão para ver.
modifyAssignees POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees
Modifica o modo e as opções de responsável de uma atividade.
patch PATCH /v1/courses/{courseId}/courseWork/{id}
Atualiza um ou mais campos de uma atividade.

Recurso REST: v1.courses.courseWork.addOnAttachments

Métodos
create POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Cria um anexo de complemento em um post.
delete DELETE /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Exclui um anexo de complemento.
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Retorna um anexo de complemento.
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Retorna todos os anexos criados por um complemento na postagem.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Atualiza um anexo de complemento.

Recurso REST: v1.courses.courseWork.addOnAttachments.studentSubmissions

Métodos
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Retorna o envio de um estudante para um anexo de complemento.
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions
Retorna uma lista de envios de estudantes que o solicitante tem permissão para ver.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Atualiza os dados associados ao envio de um anexo de complemento.

Recurso REST: v1.courses.courseWork.rubrics

Métodos
create POST /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Cria uma rubrica.
delete DELETE /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Exclui uma rubrica.
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Retorna uma rubrica.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Retorna uma lista de rubricas que o solicitante tem permissão para ver.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Atualiza uma rubrica.

Recurso REST: v1.courses.courseWork.studentSubmissions

Métodos
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Retorna um envio de estudante.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
Retorna uma lista de atividades de estudantes que o solicitante tem permissão para ver, considerando os escopos OAuth da solicitação.
modifyAttachments POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments
Modifica os anexos do envio de um estudante.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Atualiza um ou mais campos de um envio de estudante.
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
Reivindica um envio de estudante em nome do estudante que é o proprietário.
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
Retorna um envio de estudante.
turnIn POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn
Entrega um envio de estudante.

Recurso REST: v1.courses.courseWorkMaterials

Métodos
create POST /v1/courses/{courseId}/courseWorkMaterials
Cria um material de atividade do curso.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{id}
Exclui um material de atividade do curso.
get GET /v1/courses/{courseId}/courseWorkMaterials/{id}
Retorna um material de atividade.
getAddOnContext GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext
Recebe metadados de complementos do Google Sala de Aula no contexto de um post específico.
list GET /v1/courses/{courseId}/courseWorkMaterials
Retorna uma lista de materiais de atividades que o solicitante tem permissão para ver.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
Atualiza um ou mais campos de um material do curso.

Recurso REST: v1.courses.courseWorkMaterials.addOnAttachments

Métodos
create POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Cria um anexo de complemento em um post.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Exclui um anexo de complemento.
get GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Retorna um anexo de complemento.
list GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Retorna todos os anexos criados por um complemento na postagem.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Atualiza um anexo de complemento.

Recurso REST: v1.courses.posts

Métodos
getAddOnContext GET /v1/courses/{courseId}/posts/{postId}/addOnContext
Recebe metadados de complementos do Google Sala de Aula no contexto de um post específico.

Recurso REST: v1.courses.posts.addOnAttachments

Métodos
create POST /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Cria um anexo de complemento em um post.
delete DELETE /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Exclui um anexo de complemento.
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Retorna um anexo de complemento.
list GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Retorna todos os anexos criados por um complemento na postagem.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Atualiza um anexo de complemento.

Recurso REST: v1.courses.posts.addOnAttachments.studentSubmissions

Métodos
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Retorna o envio de um estudante para um anexo de complemento.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Atualiza os dados associados ao envio de um anexo de complemento.

Recurso REST: v1.courses.studentGroups

Métodos
create POST /v1/courses/{courseId}/studentGroups
Cria um grupo de estudantes para um curso.
delete DELETE /v1/courses/{courseId}/studentGroups/{id}
Exclui um grupo de estudantes.
list GET /v1/courses/{courseId}/studentGroups
Retorna uma lista de grupos em um curso.
patch PATCH /v1/courses/{courseId}/studentGroups/{id}
Atualiza um ou mais campos em um grupo de estudantes.

Recurso REST: v1.courses.studentGroups.studentGroupMembers

Métodos
create POST /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
Cria um membro para um grupo de estudantes.
delete DELETE /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers/{userId}
Exclui um participante do grupo de estudantes.
list GET /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
Retorna uma lista de estudantes em um grupo.

Recurso REST: v1.courses.students

Métodos
create POST /v1/courses/{courseId}/students
Adiciona um usuário como estudante de um curso.
delete DELETE /v1/courses/{courseId}/students/{userId}
Exclui um estudante de um curso.
get GET /v1/courses/{courseId}/students/{userId}
Retorna um estudante de um curso.
list GET /v1/courses/{courseId}/students
Retorna uma lista de estudantes do curso que o solicitante tem permissão para ver.

Recurso REST: v1.courses.teachers

Métodos
create POST /v1/courses/{courseId}/teachers
Cria um professor de um curso.
delete DELETE /v1/courses/{courseId}/teachers/{userId}
Remove o professor especificado do curso especificado.
get GET /v1/courses/{courseId}/teachers/{userId}
Retorna um professor de um curso.
list GET /v1/courses/{courseId}/teachers
Retorna uma lista de professores do curso que o solicitante tem permissão para ver.

Recurso REST: v1.courses.topics

Métodos
create POST /v1/courses/{courseId}/topics
Cria um tópico.
delete DELETE /v1/courses/{courseId}/topics/{id}
Exclui um tópico.
get GET /v1/courses/{courseId}/topics/{id}
Retorna um tópico.
list GET /v1/courses/{courseId}/topics
Retorna a lista de tópicos que o solicitante tem permissão para visualizar.
patch PATCH /v1/courses/{courseId}/topics/{id}
Atualiza um ou mais campos de um tópico.

Recurso REST: v1.invitations

Métodos
accept POST /v1/invitations/{id}:accept
Aceita um convite, removendo-o e adicionando o usuário convidado aos professores ou estudantes (conforme apropriado) do curso especificado.
create POST /v1/invitations
Cria um convite.
delete DELETE /v1/invitations/{id}
Exclui um convite.
get GET /v1/invitations/{id}
Retorna um convite.
list GET /v1/invitations
Retorna uma lista de convites que o usuário solicitante tem permissão para visualizar, restrita àqueles que correspondem à solicitação de lista.

Recurso REST: v1.registrations

Métodos
create POST /v1/registrations
Cria um Registration, fazendo com que o Google Sala de Aula comece a enviar notificações do feed fornecido para o destino fornecido em cloudPubSubTopic.
delete DELETE /v1/registrations/{registrationId}
Exclui um Registration, fazendo com que o Google Sala de Aula pare de enviar notificações para esse Registration.

Recurso REST: v1.userProfiles

Métodos
checkUserCapability GET /v1/userProfiles/{userId}:checkUserCapability
Retorna se um usuário pode usar o recurso especificado do Google Sala de Aula.
get GET /v1/userProfiles/{userId}
Retorna um perfil de usuário.

Recurso REST: v1.userProfiles.guardianInvitations

Métodos
create POST /v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
Cria um convite para o responsável e envia um e-mail pedindo que ele confirme que é o responsável pelo estudante.
get GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Retorna um convite específico para responsável.
list GET /v1/userProfiles/{studentId}/guardianInvitations
Retorna uma lista de convites para responsáveis que o usuário solicitante tem permissão para ver, filtrada pelos parâmetros fornecidos.
patch PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Modifica um convite para responsável.

Recurso REST: v1.userProfiles.guardians

Métodos
delete DELETE /v1/userProfiles/{studentId}/guardians/{guardianId}
Exclui um responsável.
get GET /v1/userProfiles/{studentId}/guardians/{guardianId}
Retorna um responsável específico.
list GET /v1/userProfiles/{studentId}/guardians
Retorna uma lista de responsáveis que o usuário solicitante tem permissão para ver, restrita àqueles que correspondem à solicitação.