A API Google Sala de Aula oferece uma interface de programação para desenvolvedores de software, administradores e líderes escolares gerenciarem 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
- Gerar dados para análise
- Tornar conteúdo ou 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. Confira alguns cenários comuns e recomendações de produtos que podem ser mais adequados para você.
Modificar recursos do Google Sala de Aula
| Cenário | Soluções recomendadas |
|---|---|
| Quero gerenciar regularmente um grande volume de cursos, usuários ou outros recursos do Google Sala de Aula. Tenho facilidade para escrever códigos e manter a infraestrutura de software. | Escrever aplicativos que usam a API Classroom. |
| Quero gerenciar ocasionalmente um pequeno volume de recursos do Google Sala de Aula. Tenho experiência em escrever pequenas quantidades de código com pouca sobrecarga. | Use a API Classroom com o Google Apps Script. |
| Quero fazer mudanças ocasionais em recursos individuais do Google Sala de Aula. Tenho facilidade em trabalhar com comandos de terminal. | Use o Google Apps Manager. |
| 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 investigar 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 abram 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 de forma programática. |
| 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 incorpore botões de Compartilhar no 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 novos desenvolvedores façam o seguinte antes de iniciar um projeto:
- Leia nosso guia sobre a estrutura da API Classroom.
- Leia sobre níveis, tipos de usuários, qualificação de usuários e ações de administradores. Esses guias explicam conceitos exclusivos do Google Classroom e da API Classroom.
- Entenda como as solicitações da API Classroom funcionam.
Antes de começar a desenvolver, conclua as etapas de pré-requisito. Escolha os escopos da API Classroom adequados às suas necessidades, configure seu ambiente e comece a fazer solicitações seguindo um dos guias de início rápido:
Experimente o Google APIs Explorer
Para testar a chamada de métodos em dados ativos, use o Google APIs Explorer. Não é necessário escrever código para começar, mas saiba que as ações realizadas usando o APIs Explorer podem modificar dados existentes.
Uma maneira de começar a chamar os métodos é usar o método courses.list(). Esse método não exige parâmetros de solicitação, e você pode recuperar um id da lista de cursos retornada para usar como parâmetro de solicitação em outras chamadas de API. Se você não tiver nenhum curso, crie um usando o método
courses.create().
Você também pode consultar a referência da API Classroom.