Os complementos do Google Sala de Aula já estão disponíveis para desenvolvedores. Consulte a documentação sobre complementos para mais informações.

Esta página foi traduzida pela API Cloud Translation.

Google Classroom API

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

Recurso REST: v1.courses
Recurso REST: v1.courses.aliases
Recurso REST: v1.courses.announcements
Recurso REST: v1.courses.announcements.addOnAttachments
Recurso REST: v1.courses.courseWork
Recurso REST: v1.courses.courseWork.addOnAttachments
Recurso REST: v1.courses.courseWork.addOnAttachments.studentSubmissions
Recurso REST: v1.courses.courseWork.rubrics
Recurso REST: v1.courses.courseWork.studentSubmissions
Recurso REST: v1.courses.courseWorkMaterials
Recurso REST: v1.courses.courseWorkMaterials.addOnAttachments
Recurso REST: v1.courses.posts
Recurso REST: v1.courses.posts.addOnAttachments
Recurso REST: v1.courses.posts.addOnAttachments.studentSubmissions
Recurso REST: v1.courses.students
Recurso da REST: v1.courses.teachers
Recurso da REST: v1.courses.topics
Recurso REST: v1.invitations
Recurso da REST: v1.registers
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 que você use as bibliotecas de cliente fornecidas pelo Google. Caso seu aplicativo precise usar suas próprias bibliotecas 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 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 detecção:

https://classroom.googleapis.com/$discovery/rest?version=v1

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`	`GET /v1/courses/{courseId}:checkAddOnCreationEligibility` Informa se um usuário está qualificado para criar anexos de complementos em um curso específico.
`checkGradingPeriodsSetupEligibility`	`GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility` Prévia para desenvolvedores:disponível como parte do Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos. Este recurso está disponível no `V1_20240401_PREVIEW` e em versões mais recentes. Consulte Acessar APIs de visualização para saber mais. Retorna se um usuário está qualificado para atualizar 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` Prévia para desenvolvedores:disponível como parte do Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos. Este recurso está disponível no `V1_20240401_PREVIEW` e em versões mais recentes. Consulte Acessar APIs de visualização para saber mais. Retorna as configurações do período de avaliação de um curso.
`list`	`GET /v1/courses` Retorna uma lista de cursos que o usuário solicitante tem permissão para acessar, 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.
`updateGradingPeriodSettings`	`PATCH /v1/courses/{courseId}/gradingPeriodSettings` Prévia para desenvolvedores:disponível como parte do Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos. Este recurso está disponível no `V1_20240401_PREVIEW` e em versões mais recentes. Consulte Acessar APIs de visualização para saber mais. 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 uma postagem específica.
`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 do responsável 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.announcements.addOnAttachments

Métodos
`create`	`POST /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments` Cria um anexo de complementos em uma postagem.
`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 complementos.
`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.
`delete`	`DELETE /v1/courses/{courseId}/courseWork/{id}` Exclui um trabalho do curso.
`get`	`GET /v1/courses/{courseId}/courseWork/{id}` Retorna o trabalho do curso.
`getAddOnContext`	`GET /v1/courses/{courseId}/courseWork/{itemId}/addOnContext` Recebe metadados de complementos do Google Sala de Aula no contexto de uma postagem específica.
`list`	`GET /v1/courses/{courseId}/courseWork` Retorna uma lista de trabalhos que o solicitante tem permissão para ver.
`modifyAssignees`	`POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees` Modifica o modo do cessionário e as opções de um curso.
`patch`	`PATCH /v1/courses/{courseId}/courseWork/{id}` Atualiza um ou mais campos do trabalho de um curso.

Recurso REST: v1.courses.courseWork.addOnAttachments

Métodos
`create`	`POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments` Cria um anexo de complementos em uma postagem.
`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 complementos.
`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 com um anexo de complementos.
`patch`	`PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}` Atualiza os dados associados ao envio de um anexo de complementos.

Recurso REST: v1.courses.courseWork.rubrics

Métodos
`create`	`POST /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics` Prévia para desenvolvedores:disponível como parte do Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos. Este recurso está disponível no `V1_20231110_PREVIEW` e em versões mais recentes. Consulte Acessar APIs de visualização para saber mais. Cria uma rubrica.
`delete`	`DELETE /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}` Prévia para desenvolvedores:disponível como parte do Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos. Este recurso está disponível no `V1_20231110_PREVIEW` e em versões mais recentes. Consulte Acessar APIs de visualização para saber mais. Exclui uma rubrica.
`get`	`GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}` Prévia para desenvolvedores:disponível como parte do Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos. Este recurso está disponível no `V1_20231110_PREVIEW` e em versões mais recentes. Consulte Acessar APIs de visualização para saber mais. Retorna uma rubrica.
`list`	`GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics` Prévia para desenvolvedores:disponível como parte do Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos. Este recurso está disponível no `V1_20231110_PREVIEW` e em versões mais recentes. Consulte Acessar APIs de visualização para saber mais. Retorna uma lista de rubricas que o solicitante tem permissão para visualizar.
`patch`	`PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}` Prévia para desenvolvedores:disponível como parte do Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos. Este recurso está disponível no `V1_20231110_PREVIEW` e em versões mais recentes. Consulte Acessar APIs de visualização para saber mais. Atualiza uma rubrica.

Recurso REST: v1.courses.courseWork.studentSubmissions

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

Recurso REST: v1.courses.courseWorkMaterials

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

Recurso REST: v1.courses.courseWorkMaterials.addOnAttachments

Métodos
`create`	`POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments` Cria um anexo de complementos em uma postagem.
`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 complementos.
`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 uma postagem específica.

Recurso REST: v1.courses.posts.addOnAttachments

Métodos
`create`	`POST /v1/courses/{courseId}/posts/{postId}/addOnAttachments` Cria um anexo de complementos em uma postagem.
`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 complementos.
`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 com um anexo de complementos.
`patch`	`PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}` Atualiza os dados associados ao envio de um anexo de complementos.

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 do curso.
`get`	`GET /v1/courses/{courseId}/students/{userId}` Retorna um estudante de um curso.
`list`	`GET /v1/courses/{courseId}/students` Retorna uma lista dos estudantes do curso que o solicitante tem permissão para ver.

Recurso da 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 dos professores do curso que o solicitante tem permissão para acessar.

Recurso da 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 temas 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, restritos à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 informado em `cloudPubSubTopic`.
`delete`	`DELETE /v1/registrations/{registrationId}` Exclui um `Registration`, fazendo com que o Google Sala de Aula pare de enviar notificações sobre 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` Cria um convite para o responsável e envia um e-mail para ele pedindo que confirme que é o responsável do estudante.
`get`	`GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}` Retorna o convite de um responsável específico.
`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 o convite do 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 acessar, restrita aos que correspondem à solicitação.