A API Classroom fornece uma interface RESTful para você gerenciar cursos e listas de alunos no Google Sala de Aula. Além disso, o botão de compartilhamento do Google Sala de Aula permite que desenvolvedores e proprietários de conteúdo ativem o compartilhamento do conteúdo com o Google Sala de Aula.
Quem pode usar a API?
Os administradores de domínio do Google Workspace for Education podem usar a API para provisionar cursos de maneira programática em nome dos professores, sincronizar sistemas de informações de alunos com o Google Sala de Aula e ter visibilidade básica das turmas ministradas no domínio.
Os desenvolvedores de aplicativos podem usar a API Classroom para integrar aplicativos ao Google Sala de Aula. Esses apps precisam usar o OAuth 2.0 para solicitar permissão para visualizar turmas e listas de alunos dos professores. Os administradores podem restringir se professores e estudantes no domínio podem autorizar os apps a acessar os dados deles no Google Sala de Aula.
Os proprietários de sites e desenvolvedores de conteúdo podem usar o botão de compartilhamento do Google Sala de Aula para permitir que estudantes e professores compartilhem conteúdo novamente.
Todas as integrações do botão de compartilhamento da API e do Google Sala de Aula precisam seguir as diretrizes da promoção de marca do Google Sala de Aula.
Visão geral da API
A API Classroom consiste em vários tipos de entidade que correspondem a turmas, professores e alunos na interface do Google Sala de Aula. Algumas dessas entidades têm outras propriedades específicas da API, além das que estão no Google Sala de Aula. Os principais tipos de entidades são:
- Cursos
- Aliases
- Convites
- Alunos
- Professores
- Perfis de usuário
- Atividades do curso
- Temas
- Envios dos estudantes
Para informações detalhadas sobre os recursos e métodos da API, consulte a referência da API Classroom.
Metadados e aliases do curso
Cursos representam uma classe, como "M. matemática do quarto período do Smith" e os professores atribuídos, a lista de alunos e os metadados. Cada curso é identificado por um ID exclusivo atribuído pelo servidor. O recurso Course encapsula especificamente todos os metadados sobre ele, como nome, descrição, local e horário. As listas de alunos dos cursos são gerenciadas usando os recursos Estudante, Professor e Convite, além dos métodos relacionados.
Aliases são identificadores alternativos de uma classe que podem ser associados a um curso e usados no lugar do ID exclusivo. Cada alias existe em um namespace que restringe a criação e a visualização dele. Dois namespaces são aceitos:
- Domínio: o namespace de domínio é útil para criar aliases aos quais todos os usuários precisam acessar, mas que não são específicos de nenhum programa. Por exemplo, listagens alternativas para um curso, como MATH 127 e COMSCI 127, precisam ser criadas no namespace do domínio. Os aliases no namespace do domínio só podem ser criados por administradores de domínio, mas são visíveis a todos os usuários em um domínio.
- Projeto do desenvolvedor:o namespace do projeto do desenvolvedor é útil para gerenciar aliases específicos de um aplicativo. Por exemplo, um aplicativo que usa identificadores alternativos para cursos pode criar aliases e mapear o identificador para cursos do Google Sala de Aula. Os aliases criados nesse namespace estão vinculados a um Console de APIs do Google específico. Qualquer usuário de um aplicativo pode criar e visualizar aliases no namespace do projeto de desenvolvedor do aplicativo.
Para saber mais sobre como gerenciar metadados e aliases de cursos, consulte Gerenciar cursos.
Lista de alunos e usuários do curso
Estudantes e Professores são mapeamentos específicos entre um perfil de usuário e um curso, representando o papel desse usuário no curso. As designações de estudante e professor não são globais: um usuário pode ser atribuído como professor de um curso e como estudante em outro. A designação "estudante" ou "professor" representa um conjunto de permissões de determinado usuário em um curso específico.
- Estudantes
Um recurso Student representa um usuário que está inscrito como estudante no
de um curso específico. Os alunos podem ver os detalhes do curso e os professores do curso.
- Professores
Um recurso "Teacher" representa um usuário que ministra um curso específico.
Os professores podem acessar e alterar detalhes do curso, ver professores e estudantes e gerenciar outros professores e estudantes.
Convites e os métodos associados a eles são uma maneira conveniente de adicionar alunos e professores aos cursos. A criação de convites permite que os usuários escolham se querem participar de um curso, em vez de serem adicionados diretamente pelos recursos para professores e alunos.
UserProfiles representa um mapeamento para o perfil de domínio de um usuário, conforme identificado
pelo ID ou endereço de e-mail exclusivo do usuário retornado pela
API Directory. O usuário atual também pode se referir ao próprio
ID usando a abreviação "me".
Para mais informações sobre como gerenciar listas de alunos, consulte Gerenciar professores e alunos.
Atividades e envios dos estudantes
Um item CourseWork representa uma única tarefa atribuída a um grupo de estudantes em um curso. Ele contém detalhes, como descrição, data de conclusão, materiais, além de metadados, como hora de criação. Os materiais incluem um título, miniatura e um URL, além de um identificador que pode ser usado com as APIs adequadas (por exemplo, Drive, YouTube).
Os itens do CourseWork descrevem um dos seguintes tipos de tarefas:
- Uma tarefa que os alunos concluem enviando planilhas ou outros anexos.
- Uma pergunta de resposta curta ou pergunta de múltipla escolha.
Os trabalhos dos alunos para um item do CourseWork são representados por StudentSubmission. Ela consiste em uma resposta e outros metadados, como um estado e um grau atribuído.
O conteúdo de um StudentSubmission depende do tipo do item CourseWork correspondente:
- As planilhas e os anexos enviados para uma atividade, incluindo o título, a miniatura e o URL, além dos identificadores que podem ser usados com as APIs adequadas, como o Drive ou o YouTube.
- A resposta a uma pergunta de resposta curta ou a uma pergunta de múltipla escolha.
Para mais informações sobre como gerenciar atividades e envios dos alunos, consulte Gerenciar atividades.
Complementos do Google Sala de Aula
Um complemento é uma interface e um back-end exibidos por parceiros normalmente em um iframe. Os complementos aparecem como anexos em uma postagem, que pode ser
Announcements, CourseWork ou CourseWorkMaterials.
Os anexos de complementos podem ser uma atividade ou conteúdo.
- Os anexos de atividades exigem que um estudante conclua e entregue um envio individual. Os exemplos incluem testes, desenhos ou jogos. Um envio de atividade pode, opcionalmente, ser avaliado.
- Os anexos de conteúdo não exigem o envio de um estudante. O aluno não precisa entregar o anexo, e ele não será avaliado. Por exemplo, fotos, artigos e vídeos.
Consulte os guias de desenvolvimento de complementos para mais informações.
Guias de início rápido
Para configurar o ambiente e começar a usar a API imediatamente, use uma das guias de início rápido:
Faça experimentos com a ferramenta APIs Explorer do Google
Para testar métodos de chamada em dados ativos, tente usar o APIs Explorer do Google. Não é necessário escrever nenhum código para começar, mas saiba que as ações realizadas usando o APIs Explorer podem modificar os dados existentes.
Uma maneira de começar a chamar os métodos é chamar o método
courses.list(). Esse método não requer parâmetros de solicitação, e é possível recuperar um id da lista retornada de cursos para usar como parâmetro de solicitação em outras chamadas de API. Se você não tiver cursos, poderá criar um usando o método courses.create().
Conheça também a referência da API.