gerencia turmas, listas de alunos e convites no Google Sala de Aula;
- Recurso REST: v1.courses
- Recurso REST: v1.courses.aliases
- Recurso REST: v1.courses.avisos
- Recurso REST: v1.courses.courseWork
- Recurso REST: v1.courses.courseWork.studentSubmissions
- Recurso REST: v1.courses.courseWorkMaterials
- Recurso REST: v1.courses.students
- Recurso REST: v1.courses.teachers
- Recurso REST: v1.courses.topics
- Recurso REST: v1.invitations
- Recurso REST: v1.registrations
- Recurso REST: v1.userProfiles
- Recurso REST: v1.userProfiles.guardianInvitations
- Recurso REST: v1.userProfiles.guardians
Serviço: Classroom.googleapis.com
Para chamar esse serviço, recomendamos o uso das bibliotecas de cliente fornecidas pelo Google. Se seu aplicativo precisar usar suas próprias bibliotecas para chamar esse serviço, use as seguintes informações ao fazer as solicitações de 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 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 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 | |
---|---|
create |
POST /v1/courses Cria um curso. |
delete |
DELETE /v1/courses/{id} Exclui um curso. |
get |
GET /v1/courses/{id} Retorna um curso. |
list |
GET /v1/courses Retorna uma lista de cursos que o usuário solicitante tem permissão para ver, restritos àqueles 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. |
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 para um curso. |
Recurso REST: v1.courses.avisos
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. |
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 atribuído e as opções de um aviso. |
patch |
PATCH /v1/courses/{courseId}/announcements/{id} Atualiza um ou mais campos de um aviso. |
Recurso REST: v1.courses.courseWork
Métodos | |
---|---|
create |
POST /v1/courses/{courseId}/courseWork Cria os trabalhos do curso. |
delete |
DELETE /v1/courses/{courseId}/courseWork/{id} Exclui um trabalho de curso. |
get |
GET /v1/courses/{courseId}/courseWork/{id} Retorna os trabalhos do curso. |
list |
GET /v1/courses/{courseId}/courseWork Retorna uma lista de trabalhos do curso que o solicitante pode ver. |
modifyAssignees |
POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees Modifica o modo atribuído e as opções de uma atividade. |
patch |
PATCH /v1/courses/{courseId}/courseWork/{id} Atualiza um ou mais campos de um trabalho do curso. |
Recurso REST: v1.courses.courseWork.studentSubmissions
Métodos | |
---|---|
get |
GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id} Retorna um arquivo enviado pelo aluno. |
list |
GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions Retorna uma lista de arquivos enviados pelos alunos que o requerente pode ver, considerando os escopos do OAuth da solicitação. |
modifyAttachments |
POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments Modifica os anexos do envio do aluno. |
patch |
PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id} Atualiza um ou mais campos do envio de um aluno. |
reclaim |
POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim Reivindique um arquivo enviado pelo aluno em nome dele. |
return |
POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return Retorna um arquivo enviado pelo aluno. |
turnIn |
POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn entrega o trabalho enviado pelo aluno. |
Recurso REST: v1.courses.courseWorkMaterials
Métodos | |
---|---|
create |
POST /v1/courses/{courseId}/courseWorkMaterials Cria um material de trabalho do curso. |
delete |
DELETE /v1/courses/{courseId}/courseWorkMaterials/{id} Exclui um material de trabalho do curso. |
get |
GET /v1/courses/{courseId}/courseWorkMaterials/{id} Retorna um material de trabalho do curso. |
list |
GET /v1/courses/{courseId}/courseWorkMaterials Retorna uma lista de materiais do curso que o solicitante pode ver. |
patch |
PATCH /v1/courses/{courseId}/courseWorkMaterials/{id} Atualiza um ou mais campos do material de um curso. |
Recurso REST: v1.courses.students
Métodos | |
---|---|
create |
POST /v1/courses/{courseId}/students Adiciona um usuário como aluno de um curso. |
delete |
DELETE /v1/courses/{courseId}/students/{userId} Exclui um aluno de um curso. |
get |
GET /v1/courses/{courseId}/students/{userId} Retorna um aluno de um curso. |
list |
GET /v1/courses/{courseId}/students Retorna uma lista de alunos deste curso que o requerente tem permissão para ver. |
Recurso REST: v1.courses.teachers
Métodos | |
---|---|
create |
POST /v1/courses/{courseId}/teachers Cria o 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 o professor de um curso. |
list |
GET /v1/courses/{courseId}/teachers Retorna uma lista de professores que o requerente 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 requerente tem permissão para ver. |
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, remove-o e adiciona o usuário convidado aos professores ou alunos (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 ver, restrita àqueles que correspondem à solicitação da lista. |
Recurso REST: v1.registrations
Métodos | |
---|---|
create |
POST /v1/registrations Cria uma Registration , fazendo com que o Google Sala de Aula comece a enviar notificações do feed fornecido ao destino informado 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 | |
---|---|
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 Um convite é enviado ao responsável, que envia um e-mail solicitando que ele confirme que é o responsável dele. |
get |
GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId} Retorna um convite específico para o responsável. |
list |
GET /v1/userProfiles/{studentId}/guardianInvitations Retorna uma lista de convites para o responsável que o usuário solicitante pode ver, filtrada pelos parâmetros fornecidos. |
patch |
PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId} Modifica um convite para o 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 aos que correspondem à solicitação. |