Configuração de projetos do Google Cloud

Esta página inclui as informações que você precisa saber sobre como criar e configurar projetos do Google Cloud para complementos do Google Sala de Aula. Os projetos do Google Cloud são usados para implementar o Logon único do Google pelo OAuth 2.0 (SSO do Google), autorizar as solicitações feitas pelo complemento e gerenciar a listagem de um complemento na loja do Google Workspace Marketplace.

Para mais informações gerais sobre como publicar um complemento no Marketplace, consulte Publicar um app.

Criação de projetos do Google Cloud

Há dois tipos de projetos para criar: um projeto privado, usado para desenvolvimento, e um projeto público, acessível a usuários finais. Os rótulos "público" e "particular" se referem à visibilidade do aplicativo no Google Workspace Marketplace. Um aplicativo do Marketplace privado só pode ser instalado por usuários no domínio em que foi criado, enquanto um aplicativo público do Marketplace está disponível para qualquer domínio do Google Workspace. Eles precisam ser dois aplicativos separados, já que um projeto não pode ser público e privado. Os aplicativos públicos precisam ser revisados e aprovados antes de serem disponibilizados no Marketplace.

Importante :não é possível converter um projeto particular em público. Crie um projeto particular para desenvolver o complemento e um público para representar a versão pronta para produção.

Para informações gerais sobre criação de projetos do Google Cloud, acesse Criar um projeto do Google Cloud.

Criar um projeto privado do Google Cloud

Este projeto privado representa o aplicativo de complemento usado para desenvolvimento. Ele não é acessível a usuários fora do domínio em que foi criado, mas não precisa ser aprovado antes da instalação. Por isso, o Google recomenda usar esse projeto para desenvolver e testar o complemento em um ambiente controlado.

Você precisa de acesso a um domínio do Google Workspace for Education com a licença Teaching & Learning ou Plus para criar um projeto particular. Se você ainda não tiver acesso a esse domínio, siga estas etapas para configurar um domínio de demonstração do Google Workspace for Education, fazer upgrade dele para uma licença Plus e permitir que ele acesse a API de complementos do Google Sala de Aula:

1. Conclua as etapas para criar um domínio de teste do desenvolvedor.

2. Depois de fazer login como administrador no domínio de demonstração, crie um novo projeto do Google Cloud.

   Criar um projeto do Google Cloud

   Aviso :verifique se o projeto pertence ao domínio de demonstração e se você fez login no console do Google Cloud usando uma conta de administrador do domínio de demonstração.

   Se você não conseguir acessar o console do Google Cloud ou criar projetos do Cloud, verifique o seguinte no Admin Console:

   • Acesse a página Configurações da conta > Configurações de acesso com base na idade e selecione a opção para Todos os usuários neste grupo ou unidade organizacional são maiores de 18 anos.
   • Em Apps > Serviços adicionais do Google:
     • O Google Cloud Platform está ATIVADO para todos.
     • As configurações de criação de projeto são Permitir que os usuários criem projetos.
     • As configurações de acesso do Cloud Shell são Permitir acesso ao Cloud Shell.

3. Preencha e envie o formulário de solicitação de upgrade do domínio de demonstração. O envio deste formulário solicita que o Google faça upgrade do seu domínio de demonstração para o Google Workspace for Education Plus com 10 licenças e permita seu projeto do Cloud na API de complementos do Google Sala de Aula.

   Observação :envie o formulário de domínios de demonstração do Google for Education da página Tenha um domínio de teste do desenvolvedor e o formulário de solicitação de upgrade do domínio de demonstração discutido aqui.

   Você vai receber um e-mail quando os processos de upgrade e lista de permissões forem concluídos. Atribua licenças do Plus às contas de professor de teste no Admin Console. Em Diretório > Usuários, crie ou selecione suas contas de professor de prova. Nas Licenças de cada professor, confirme se o Google Workspace for Education Plus está Atribuído.

4. Ative a API Classroom no seu projeto do Cloud.

   Ativar a API Classroom

5. Ative o SDK do Google Workspace Marketplace no seu projeto do Cloud.

   Ativar o SDK do Google Workspace Marketplace

6. Defina a Configuração do aplicativo Visibilidade do aplicativo do SDK do Marketplace como particular.

7. Preencha os campos obrigatórios na página Detalhes do app do SDK do Marketplace e clique em PUBLICAR. Depois que a página "Detalhes do app" for publicada, os usuários no domínio poderão encontrar e instalar o app no Google Workspace Marketplace ou acessando o URL do app mostrado na página "Detalhes do app".

Criar um projeto público do Google Cloud

Esse projeto representa o aplicativo de complemento que pode ser acessado por administradores, professores e alunos.

1. Crie um projeto do Google Cloud no seu domínio de produção.

   Criar um projeto do Google Cloud

   Aviso: verifique se o projeto pertence ao seu domínio de produção e se você fez login no console do Google Cloud como usuário desse domínio.

2. Ative a API Classroom no seu projeto do Cloud.

   Ativar a API Classroom

3. Ative o SDK do Google Workspace Marketplace no seu projeto do Cloud.

   Ativar o SDK do Google Workspace Marketplace

4. Defina a Configuração do aplicativo Visibilidade do aplicativo do SDK do Marketplace como Público e marque a caixa Não listado.

   Importante: não é possível compartilhar nem converter um projeto particular usado durante desenvolvimento e testes internos.
   Importante: os apps não listados não podem ser encontrados no Google Workspace Marketplace por navegação ou pesquisa. Na configuração do SDK do Marketplace, você encontra um URL direto que pode ser usado para instalar o complemento. Somente o Google e o desenvolvedor podem encontrar essa página. Seu app deve permanecer não listado até que você se sinta à vontade para lançá-lo para o público em geral. É possível alternar se um complemento está listado ou não na página "Configuração do aplicativo" do SDK do Marketplace.

5. Compartilhe o ID ou número do projeto do Cloud com seu parceiro do Google para adicionar o projeto à lista de permissões de complementos. Isso concede ao projeto acesso aos novos recursos de complementos da API Classroom.

6. Preencha os campos obrigatórios na página Detalhes do app do SDK do Marketplace e clique em PUBLICAR.

7. Seu app será revisado pela equipe do Google Workspace Marketplace. Eles se comunicarão com você usando o endereço de e-mail do desenvolvedor especificado no SDK do Marketplace. Depois que o app for aprovado, limpe a caixa Não listado para que professores e administradores possam encontrá-lo no Marketplace.

OAuth 2.0

O acesso à API Classroom exige o consentimento de acesso aos dados do usuário. Para receber esses dados, solicite acesso do Google aos escopos OAuth do usuário conectado e receba um token que pode ser usado para fazer chamadas de API posteriormente para o Google Sala de Aula. Os escopos precisam ser configurados na página "Detalhes do app" do Google Workspace Marketplace para que o administrador do domínio possa dar consentimento em nome dos usuários do domínio se instalarem o complemento.

Importante :se o complemento solicitar escopos adicionais, inclua-os na tela de consentimento do OAuth, na guia "Configuração do aplicativo do SDK do Marketplace" e no código do aplicativo do complemento. Escopos não correspondentes nesses locais podem causar problemas para os usuários durante a instalação do complemento.

Consulte a página Escopos do OAuth para APIs do Google e confira uma lista detalhada de todos os escopos disponíveis e os usos deles. Consulte a página Configurar OAuth na documentação do Workspace para informações gerais de configuração do OAuth.

Permissões do usuário

Seu app da Web precisa solicitar pelo menos um dos seguintes escopos:

• https://www.googleapis.com/auth/userinfo.email, que permite que um aplicativo veja o endereço de e-mail do usuário.
• https://www.googleapis.com/auth/userinfo.profile, que permite que um aplicativo acesse informações pessoais, como retrato, nome, sobrenome e outras informações pessoais disponibilizadas publicamente pelo usuário.

Depois que o usuário autorizar um desses escopos no complemento, ele será identificado pelo parâmetro de consulta login_hint. Esse parâmetro é transmitido para qualquer um dos URLs do seu app da Web quando um iframe é aberto. Se um usuário não tiver autorizado um desses escopos, o parâmetro hd ("domínio hospedado") será transmitido aos URLs do seu aplicativo da Web.

Aviso: seu app precisa solicitar pelo menos um dos escopos userinfo.email ou userinfo.profile para receber login_hint nas próximas visitas do mesmo usuário.

login_hint e hd são parâmetros padrão do OpenID Connect que podem ser transmitidos ao Google ao usar o Login do Google ou solicitar um token OAuth. Elas visam facilitar a experiência de autorização para o usuário final.

Escopos dos complementos do Google Sala de Aula

Os escopos a seguir são específicos para os complementos do Google Sala de Aula:

• https://www.googleapis.com/auth/classroom.addons.teacher, que permite o acesso a todos os métodos da API.
• https://www.googleapis.com/auth/classroom.addons.student, que permite o acesso para iniciar operações de validação e leitura de anexos.

Mesmo com um token de acesso OAuth válido que indique as credenciais do usuário, as chamadas de API são controladas por requisitos adicionais:

• Todos os métodos exigem que o usuário seja um professor ou estudante no curso especificado pelo courseId na solicitação.
• A criação, a atualização, a exclusão e a transferência de notas de anexos exigem que o usuário seja um professor.
• As chamadas para uma postagem específica do Google Sala de Aula são controladas pelas verificações a seguir.
  • Quando um complemento já tem pelo menos um anexo em uma postagem, ele pode fazer solicitações para:
    • Validação da inicialização do iframe
    • Operações de leitura, atualização e exclusão de anexos
    • Avaliar as atualizações da postagem
  • Quando o iframe de descoberta de anexos é aberto pela primeira vez, talvez o complemento ainda não tenha um anexo na postagem. É fornecido um parâmetro de consulta addOnToken que pode ser usado para fazer solicitações para o seguinte:
    • Criar um anexo na postagem (é necessário addOnToken)
    • Validação de inicialização. O addOnToken será validado se fornecido e será necessário quando o complemento não tiver um anexo na postagem.

Verificação do OAuth

Observação: não é possível criar um vídeo de demonstração para enviar como parte do processo de verificação do OAuth. Publique o complemento sem verificar o OAuth. Isso vai alertar a equipe de revisão do Google Workspace Marketplace para fazer um vídeo de demonstração por você. Em seguida, a equipe de revisão fornece o vídeo para que você o inclua no envio da verificação do OAuth.

Um complemento do Google Sala de Aula usa APIs do Google para acessar os dados dos usuários do Google.

• Verificar a identidade da sua marca.
• Verifique os escopos confidenciais do OAuth.

Consulte as Perguntas frequentes sobre a verificação da API OAuth para mais informações sobre o processo.

Ficha no Google Workspace Marketplace

Aviso: depois de salvar a opção de visibilidade durante o processo de publicação, não será possível mudar a seleção.

É importante observar algumas coisas ao criar uma página "Detalhes do app" do Marketplace para complementos do Google Sala de Aula durante o programa de acesso antecipado.

Para informações gerais de configuração do SDK do Google Workspace Marketplace, acesse Ativar e configurar o SDK do Google Workspace Marketplace e Criar uma página "Detalhes do app" do Google Workspace Marketplace.

Considerações sobre a listagem

A página "Detalhes do app" do SDK do Marketplace do seu projeto público do Google Cloud especifica o nome e as descrições do seu aplicativo para os usuários finais. É possível fornecer esses detalhes em vários idiomas em Detalhes do app.

Siga estas diretrizes nas suas fichas:

• Em Detalhes do app:

  • Evite pontuação no nome do aplicativo. Por exemplo, use Meu complemento da minha empresa em vez de "Minha empresa: meu complemento" ou "Meu complemento, da minha empresa".

  • As opções Descrição breve e Descrição detalhada não podem conter exatamente o mesmo texto.

  • Verifique se você selecionou um valor para o campo Preços. Esse campo inclui as opções de preço Sem custo financeiro, Pago com uma avaliação sem custo financeiro, Pago com recursos sem custo financeiro e Pago. Não é preciso especificar o custo na listagem do Marketplace.

  • Verifique se você selecionou um valor para o campo Categoria. Recursos acadêmicos ou Ferramentas para professores e administradores podem ser boas opções para um complemento do Google Sala de Aula.

  • Consulte os itens listados na descrição de detalhes do app do Marketplace para mais informações.

Importante: verifique os detalhes do app para cada idioma em que você oferece o complemento.

• Em Recursos gráficos:

  • Os recursos gráficos fornecidos não são confusos e atendem aos tamanhos especificados nos padrões do Google Workspace Marketplace

  • As capturas de tela fornecidas são representações precisas da experiência do complemento.

• Em Links de suporte:

  • Verifique se você informou um link para os Termos de Serviço do aplicativo.

• Verifique se você está atendendo às Diretrizes de branding da API do Google, que abrangem nomes e descrições permitidos.

• Se você se referir a qualquer produto do Google na sua ficha, use o nome dele no formato fornecido na lista de marcas registradas. Inclua o símbolo de marca registrada (TM, na sigla em inglês), se especificado. Use Documentos Google, não Documentos Google.

Integrar com os serviços de faturamento e licenciamento do Google

Se você quiser permitir que os aplicativos do Google Workspace Marketplace se integrem aos serviços de licenciamento e faturamento do Google, acesse a API Marketplace.

Configurações de instalação

Os complementos podem permitir a instalação individual e do administrador. Esta página destaca algumas diferenças entre os dois tipos de instalação. O objetivo não é promover nenhum dos dois. Escolha se quer permitir a instalação individual na página de configuração do app do SDK do Google Workspace Marketplace.

Instalação pelo administrador

As instalações do administrador permitem que um administrador adicione um complemento a todas as contas em um domínio ou a grupos de acesso ou unidades organizacionais específicos. Somente um administrador de domínio pode executar uma instalação de administrador. O administrador pode consentir com todos os escopos de acesso em nome de todos os usuários no domínio. O consentimento dos usuários não será solicitado a nenhum escopo de acesso se o administrador optar por fazer isso.

Veja a seguir algumas considerações sobre a instalação do administrador.

• Controles mais rígidos. Os administradores restringem os usuários que têm acesso a um complemento.
• Compatibilidade com licenciamento. Se o aplicativo exigir uma licença, canalizar as instalações por meio de um administrador pode ajudar a garantir que as licenças sejam distribuídas e usadas adequadamente com a instituição correspondente.
• Menor sobrecarga para os usuários finais. A instalação de um administrador reduz a carga de configuração para professores e estudantes. Isso pode resultar em uma experiência do usuário mais integrada, com menos cliques e menos oportunidades de confusão.

Consulte Instalar apps do Marketplace no seu domínio para mais informações sobre como realizar instalações de administrador e Como funciona a estrutura organizacional para saber mais sobre unidades organizacionais e grupos de acesso.

Instalação individual

As instalações individuais adicionam um complemento à conta do usuário. O usuário precisa consentir com os escopos de acesso do complemento durante a instalação.

Veja a seguir algumas considerações sobre a instalação individual.

• Facilitar a adoção. Mais usuários podem acessar e instalar seu complemento do Google Workspace Marketplace. Permitir a instalação individual pode fazer com que mais professores adotem ou defendam seu produto.
• Teste do administrador. Um administrador pode instalar individualmente um complemento para testá-lo ou avaliá-lo antes de aprová-lo ou instalá-lo para um grupo mais amplo.

Além de instalar complementos em nome dos usuários, os administradores também podem manter uma lista de permissões para permitir que os usuários instalem complementos que permitem a instalação individual. Mesmo que um complemento não esteja na lista de permissões, os usuários ainda poderão ver a página do complemento no Google Workspace Marketplace, mas não poderão instalá-lo. Em vez disso, eles verão uma mensagem explicando que a instalação do complemento não foi permitida por um administrador do domínio. Consulte Gerenciar apps do Google Workspace Marketplace na lista de permissões para saber mais sobre esse comportamento.

Consulte a documentação das configurações de instalação do Google Workspace Marketplace para mais informações.

Integração de apps

Forneça um URL de iframe de inicialização no campo URI de configuração de anexos. Esse URL é usado como o valor de iframe src para o iframe de descoberta de anexos. O iframe de descoberta de anexos é usado pelos professores para encontrar conteúdo ou atividades para anexar às atividades.

Também é necessário especificar todos os prefixos de URI dos anexos permitidos no complemento. Esse recurso aumenta a segurança impedindo anexos de fontes não autorizadas.

Consulte a página de guia de iframes para mais detalhes sobre esses campos.

Contas de teste

Crie contas de teste no seu domínio de demonstração para verificar o comportamento correto do seu complemento particular. São necessárias duas contas de estudante para testar a alternância entre alunos no iframe de avaliação dos trabalhos.

Contas de teste sugeridas:

• Professora Tammy, tammy.teacher@<seu domínio de demonstração>
• Samuel, sam.student@<seu domínio de demonstração>
• Sally Student, sally.student@<seu domínio de demonstração>

Siga este procedimento para criar uma conta de teste:

1. Faça login no Admin Console.
2. Acesse Usuários.
3. Clique em Adicionar novo usuário (veja a Figura 1).
4. Insira as informações do usuário e atribua as funções adequadas.

Figura 1. Localização do link Adicionar novo usuário no Admin Console.

Siga este procedimento para criar um novo grupo de teste:

1. Faça login no Admin Console.
2. Acesse Grupos.
3. Clique em Criar grupo (veja a Figura 2).
4. Insira os participantes e proprietários do grupo.

Figura 2. Local do link Criar grupo no Admin Console.