A API Google Classroom oferece uma interface de programação para que desenvolvedores de software, administradores e gestores de escolas gerenciem os recursos do Google Sala de Aula. Você pode criar um software que cria, recupera e modifica cursos do Google Sala de Aula e o conteúdo deles.
Veja alguns casos de uso comuns:
- Gerenciar cursos, listas de alunos e responsáveis
- Adicionar atividades, avisos e materiais do curso
- Atribuir notas e modificar as configurações de avaliação
- Geração de dados para análise
- Tornar o conteúdo ou as ferramentas de um provedor externo detectáveis e acessíveis no Google Sala de Aula
A API Classroom é a solução certa para mim?
O Google oferece vários produtos para ajudar você a interagir com o Google Sala de Aula. Veja a seguir alguns cenários comuns e recomendações de produtos que podem atender melhor às suas necessidades.
Modificar recursos do Google Sala de Aula
| Cenário | Soluções recomendadas |
|---|---|
| Quero gerenciar um grande volume de cursos, usuários ou outros recursos do Google Sala de Aula. Tenho familiaridade em escrever códigos e manter infraestruturas de software. | Crie aplicativos que usam a API Classroom. |
| Quero gerenciar ocasionalmente um pequeno volume de recursos do Google Sala de Aula. Estou confortável para escrever pequenas quantidades de código com pouca sobrecarga. | Use a API Classroom com o Google Apps Script. |
| Quero fazer alterações em recursos individuais do Google Sala de Aula. Tenho experiência em trabalhar com comandos de terminal. | Use o Gerenciador de apps do Google. |
| Quero um grande volume de relatórios com detalhes sobre eventos no Google Sala de Aula. | Use o serviço de transferência de dados do BigQuery. |
| Quero realizar uma investigação sobre a atividade dos meus usuários. | Gere relatórios no Admin Console ou use a API Reports. |
Integrar com o Google Sala de Aula
| Cenário | Soluções recomendadas |
|---|---|
| Quero que professores e estudantes vejam e acessem meu conteúdo no Google Sala de Aula. | Crie um complemento do Google Sala de Aula. |
| Quero que os professores cliquem em um botão no meu site ou app que incorpore meu conteúdo no Google Sala de Aula. | Crie um complemento do Google Sala de Aula e crie anexos por programação. |
| Quero que os professores cliquem em um botão no meu site ou app para vincular ao meu conteúdo no Google Sala de Aula. | Crie atividades usando a API Classroom ou insira botões Compartilhar com o Google Sala de Aula. |
| Quero que os professores do Google Sala de Aula sincronizem ou importem informações do meu sistema de informações dos estudantes. | Implemente o OneRoster para SIE ou crie e acesse recursos usando a API Classroom. |
Primeiros passos
Recomendamos que os novos desenvolvedores façam o seguinte antes de iniciar um novo projeto:
- Leia nosso guia sobre a estrutura da API Classroom.
- Leia sobre notas, tipos de usuários, qualificação de usuários e ações de administradores. Estes guias explicam conceitos exclusivos do Google Sala de Aula e da API Classroom.
- Entenda como as solicitações da API Classroom funcionam.
Para começar a desenvolver, verifique se você concluiu as etapas de pré-requisito. Escolha os escopos da API da Sala de Aula adequados para suas necessidades. Em seguida, configure seu ambiente e comece a fazer solicitações seguindo um dos guias de início rápido:
Testar o Google APIs Explorer
Para testar o método de chamada em dados ativos, use o Google APIs Explorer. Não é necessário escrever nenhum código para começar, mas as ações realizadas usando o APIs Explorer podem modificar os dados atuais.
Uma maneira de começar a chamar os métodos é chamar o método
courses.list(). Esse método não exige nenhum parâmetro de solicitação, e você pode extrair
um id da lista de cursos retornada para usar como o 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 conferir a referência da API Classroom.