Seus usuários usam o Google Sala de Aula com o Google Meet? Confira o guia de início rápido do Apps Script que mostra como verificar a participação dos alunos nos cursos do Google Meet.

Visão geral

A API Classroom oferece uma interface RESTful para você gerenciar cursos e rosários no Google Sala de Aula. Além disso, o botão de compartilhamento do Google Sala de Aula permite que os desenvolvedores e proprietários de conteúdo ativem o compartilhamento de conteúdo para 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 forma programática em nome dos professores, sincronizar os sistemas de informações dos alunos com o Google Sala de Aula e ter visibilidade básica das aulas ensinadas no domínio.

Os desenvolvedores de aplicativos podem usar a API Classroom para integrar os apps ao Google Sala de Aula. Esses apps precisam usar o OAuth 2.0 para solicitar permissão para ver as turmas e as listas de alunos dos professores. Os administradores podem restringir se professores e alunos no domínio deles podem autorizar apps a acessar os dados deles no Google Sala de Aula.

Os proprietários de sites e os 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 com o Google Sala de Aula.

Todas as integrações de botões 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 classes, professores e estudantes na interface do Google Sala de Aula. Algumas dessas entidades têm propriedades adicionais específicas para a API, além das que existem no Google Sala de Aula. Os principais tipos de entidade são:

Para informações detalhadas sobre os recursos e métodos da API, consulte a referência da API Classroom.

Metadados e aliases do curso

Os cursos representam uma classe, como "M. a matemática do 4o período da Smith", além de professores, lista de estudantes e metadados. Cada curso é identificado por um ID exclusivo atribuído pelo servidor. O recurso "Curso" encapsula especificamente todos os metadados sobre o curso, como nome, descrição, localização e hora. As listas de alunos do curso são gerenciadas usando os recursos de estudante, professor e convite e os métodos correspondentes.

Alias são identificadores alternativos para uma classe que podem ser associados a um curso e usados no lugar do ID exclusivo. Cada alias existe em um namespace que restringe quem pode criá-lo e visualizá-lo. Dois namespaces são compatíveis:

  • Domínio:o namespace do domínio é útil para criar aliases a que todos os usuários precisam, mas que não são específicos de um programa. Por exemplo, listagens alternativas de 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 do domínio, mas são visíveis para 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 para mapear o identificador para os 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 ver aliases no namespace do projeto de desenvolvedor desse aplicativo.

Para saber mais sobre como gerenciar metadados e aliases de cursos, consulte Gerenciar cursos.

Listas 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 a função do usuário no curso. As designações de aluno e professor não são globais: um usuário pode ser atribuído como professor em um curso e estudante em outro. A designação "estudante" ou "professor" representa um conjunto de permissões para um usuário específico em um determinado curso.

Estudantes
Um recurso de estudante representa um usuário que está inscrito como estudante em um curso específico. Os estudantes podem ver os detalhes do curso e os professores do curso.
Professores
Um recurso para professores representa um usuário que ministra um curso específico. Os professores têm permissão para ver e alterar os detalhes do curso, visualizar professores e estudantes e gerenciar professores e estudantes adicionais.

Os convites e os métodos associados deles oferecem uma maneira conveniente de adicionar alunos e professores aos cursos. Criar convites permite que os usuários escolham se querem participar ou não de um curso, em vez de adicioná-los diretamente pelos recursos de professores e alunos.

UserProfiles representam um mapeamento para o perfil de domínio de um usuário, conforme identificado pelo ID exclusivo ou pelo endereço de e-mail do usuário retornado pela API Directory. O usuário atual também pode se referir ao ID dele usando o atalho "me".

Para mais informações sobre como gerenciar listas de estudantes, consulte Gerenciar professores e alunos.

Atividades do curso e envios de alunos

Um item courseWork representa uma única tarefa atribuída a um grupo de estudantes de um curso. Ele contém detalhes, como a descrição, a data de conclusão, os materiais e metadados, como o horário de criação. Os materiais incluem um título, uma miniatura e um URL, além de um identificador que pode ser usado com as APIs apropriadas (por exemplo, Drive, YouTube).

Os itens do CourseWork descrevem um dos seguintes tipos de tarefas:

  • Uma atividade que os estudantes concluem enviando planilhas ou outros anexos.
  • Uma pergunta de resposta curta ou de múltipla escolha.

Os trabalhos dos estudantes em um item do CourseWork são representados por uma StudentSubmission. Ele consiste em uma resposta e outros metadados, como um estado e um grau atribuído.

O conteúdo de uma StudentSubmission depende do tipo do item correspondente do CourseWork:

  • As planilhas e os anexos enviados para uma atividade, incluindo título, miniatura e URL, bem como identificadores que podem ser usados com as APIs apropriadas, como o Drive e o YouTube.
  • É a resposta a uma pergunta de resposta curta ou de múltipla escolha.

Para mais informações sobre o gerenciamento das atividades e dos envios de estudantes, consulte Gerenciar atividades.

Guias de início rápido

Para configurar seu ambiente e começar a usar a API imediatamente, use um dos guias de início rápido:

Fazer experimentos com o APIs Explorer do Google Sala de Aula

Para testar métodos de chamada com dados em tempo real, use a API Explorer do Google Sala de Aula. Não é preciso escrever nenhum código para começar, mas as ações realizadas com o API Explorer podem modificar os dados existentes.

Uma maneira de começar a chamar os métodos é fazer uma chamada para o método courses.list(). Esse método não requer parâmetros de solicitação e é possível recuperar um id da lista de cursos retornados para usar como parâmetro de solicitação de outras chamadas de API. Se você não tem cursos, é possível criar um usando o método courses.create().

Você também pode explorar a Referência da API.