Visão geral

A API Classroom oferece uma interface RESTful para você gerenciar cursos e listas 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 com o Google Sala de Aula.

Quem pode usar a API?

Os administradores de domínios 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 lecionadas no domínio.

Os desenvolvedores 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 listas de estudantes dos professores. Os administradores podem restringir se educadores e estudantes no domínio podem autorizar os apps a acessar os dados do Google Sala de Aula.

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 com ele.

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.

Perspectiva geral sobre APIs

A API Classroom consiste em vários tipos de entidade que correspondem a turmas, professores e estudantes na interface do Google Sala de Aula. Algumas dessas entidades têm outras propriedades específicas para a API, além daquelas que estão no Google Sala de Aula. Os principais tipos de entidades 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

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 curso encapsula especificamente todos os metadados sobre o curso, como nome, descrição, local e hora. As listas de estudantes dos cursos são gerenciadas com os recursos Aluno, Professor e Convite e os métodos de cada um.

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 quem pode criá-lo e visualizá-lo. Há suporte para dois namespaces:

Domínio:o namespace de domínio é útil para criar aliases que 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 do domínio, mas ficam visíveis para todos os usuários em um domínio.
Projeto de desenvolvedor:o namespace do projeto de 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.

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

Estudantes: Um recurso "Student" representa um usuário que está inscrito como aluno em um curso específico. Estudantes têm permissão para ver os detalhes do curso e os professores desse curso.
Professores: Um recurso para professores representa um usuário que ministra um curso específico. Os professores podem ver e mudar os detalhes do curso, ver professores e estudantes e gerenciar outros professores e estudantes.

Os convites e os métodos associados deles fornecem 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 estudantes.

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 fazer referência 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 alunos em um curso. Ele contém detalhes como descrição, data de conclusão e materiais, bem como 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 curso descrevem um dos seguintes tipos de tarefas:

Uma tarefa que os alunos concluem enviando planilhas ou outros anexos.
Uma pergunta de resposta curta ou de múltipla escolha.

O trabalho do estudante em um item do curso é representado por um valor StudentSubmission. Ele consiste em uma resposta e outros metadados, como um estado e uma nota atribuída.

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 de identificadores que podem ser usados com as APIs adequadas, como o Drive ou o YouTube.
A resposta a uma pergunta de resposta curta ou de múltipla escolha.

Para mais informações sobre como gerenciar os envios dos cursos e dos alunos, consulte Gerenciar atividades.

Guias de início rápido

Para configurar o ambiente e começar a usar a API imediatamente, siga um destes guias de início rápido:

Teste o API Explorer do Google Sala de Aula

Para testar métodos de chamada em dados em tempo real, use o Google Classroom API Explorer. Você não precisa escrever nenhum código para começar, mas saiba que as ações que você realiza usando 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 retornada para usar como parâmetro de solicitação para outras chamadas de API. Se você não tiver cursos, crie um usando o método courses.create().

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