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 por meio do OAuth 2.0 (SSO do Google), autorizar 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

Importante :seu aplicativo de complemento de produção precisa ter a visibilidade pública definida no SDK do Google Workspace Marketplace. Um projeto particular pode ser útil para desenvolver e testar seu complemento, mas apenas um projeto público é necessário.

Há dois tipos de projetos a serem criados: um projeto particular, usado para desenvolvimento, e um projeto público, que pode ser acessado por usuários finais. Os rótulos "público" e "particular" se referem à visibilidade do seu aplicativo no Google Workspace Marketplace. Um aplicativo do Marketplace particular 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. É preciso que haja dois aplicativos separados, já que um projeto não pode ser público e particular. Os aplicativos públicos precisam ser analisados e aprovados antes de serem disponibilizados no Marketplace.

Importante :não é possível converter um projeto particular em público.

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

Criar um projeto público do Google Cloud

Este projeto representa o aplicativo de complemento que pode ser acessado por administradores, professores e estudantes. Um projeto público precisa ser revisado e aprovado pela equipe do Google Workspace Marketplace antes de ser lançado ou instalado.

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

   Criar um projeto do Google Cloud

   Importante: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.
   Aviso:use a versão de rascunho do projeto para testes. No momento, o recurso "Rascunho" só está disponível no Programa de prévia para desenvolvedores do Google Workspace. Depois de criar seu projeto do Cloud, preencha o formulário de inscrição para ativar os recursos do Programa de prévia para desenvolvedores do Google Workspace. Para saber mais, consulte Atualizar a página "Detalhes do app" com rascunhos.

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 app Visibilidade do app do SDK do Marketplace como Público e marque a caixa Não listado.

   Importante: não é possível compartilhar ou converter um projeto particular usado durante o desenvolvimento e o teste internos.
   Importante:não é possível encontrar apps não listados no Google Workspace Marketplace ao navegar ou pesquisar. 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 a página "Detalhes do app". O app precisa permanecer não listado até que você se sinta à vontade para liberá-lo para o público em geral. É possível definir se um complemento será listado na página "Configuração do app" do SDK do Marketplace.

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

6. Seu app será analisado 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, desmarque a caixa Não listado para que professores e administradores possam encontrá-lo no Marketplace.

Criar um projeto particular do Google Cloud

Esse projeto particular representa o aplicativo de complemento usado para desenvolvimento. Ele não pode ser acessado por 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 ter acesso a um domínio do Google Workspace for Education com a licença Teaching & Learning ou Plus para criar um projeto particular. Caso você ainda não tenha acesso a um domínio desse tipo, siga estas etapas para configurar um domínio de demonstração do Google Workspace for Education, fazer upgrade 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 de 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 desse domínio.

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

   • Visite a página Configurações da conta > Configurações de acesso com base na idade e selecione a opção 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 permite que seu projeto do Cloud acesse a API de complementos do Google Sala de Aula.

   Você vai receber um e-mail quando o upgrade e os processos da lista de permissões forem concluídos. Atribua licenças Plus às suas contas de professor de teste no Admin Console. Em Diretório > Usuários, crie ou selecione suas contas de professor de teste. 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 Visibilidade do app da Configuração do app 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".

OAuth 2.0

O acesso à API Classroom requer o consentimento de acesso aos dados do usuário. Eles são obtidos solicitando acesso do Google aos escopos do OAuth para o usuário conectado e recebendo um token que pode ser usado para depois fazer chamadas de API 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 eles instalarem o complemento.

Importante :se o complemento solicitar escopos adicionais, inclua-os na tela de consentimento do OAuth, na guia "Configuração de app 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 para ver uma lista detalhada de todos os escopos disponíveis e os respectivos usos. Consulte a página Configurar o OAuth na documentação do espaço de trabalho para ver informações gerais sobre a 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 app acesse informações pessoais, como retrato, nome e sobrenome e outras informações pessoais que o usuário disponibilizou publicamente.

Depois que um usuário autoriza um desses escopos no complemento, eles são identificados 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, login_hint não será enviado.

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 é um parâmetro do OpenID Connect padrão que você pode transmitir ao Google ao usar o Login do Google ou solicitar um token OAuth. Seu objetivo é tornar a experiência de autorização mais tranquila para o usuário final.

Escopos dos complementos do Google Sala de Aula

Os escopos a seguir são específicos dos 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 acesso para iniciar operações de validação e leitura de anexos.

Mesmo com um token de acesso OAuth válido indicando 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 professor ou estudante do 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 de lançamento do iframe
    • Operações de leitura, atualização e exclusão de anexos
    • Dar notas às atualizações da postagem
  • Quando o iframe de descoberta de anexos for 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:
    • Crie um anexo na postagem (addOnToken é obrigatório)
    • Validação de inicialização (addOnToken é validada se fornecido e é obrigatória quando o complemento não tem 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 alerta a equipe de análise do Google Workspace Marketplace para fazer um vídeo de demonstração em seu nome. A equipe de análise envia 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.

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

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

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 mais tarde.

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 listagem da loja de SDK do Marketplace do seu projeto público do Google Cloud especifica o nome e as descrições do aplicativo para os usuários finais. Você pode fornecer essas informações em vários idiomas na página 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 seções Descrição curta e Descrição detalhada não podem conter exatamente o mesmo texto.

  + Verifique se você selecionou um valor no campo Pricing. Esse campo inclui opções para Sem custo financeiro, Pago com um teste sem custo financeiro, Pago com recursos sem custo financeiro e Pago. Não é necessário especificar o valor do 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 de complemento do Google Sala de Aula.

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

Importante: verifique os detalhes do app de cada idioma em que você oferece seu 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ê forneceu um link para os Termos de Serviço do seu aplicativo.

• Verifique se você está atendendo às diretrizes da promoção de marca da API do Google, que abrangem nomes e descrições permitidos.

• Se você se referir a qualquer produto do Google nas informações do produto, 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 "Google DocsTM", e não "Google Docs".

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

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

Configurações de instalação

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

Instalação do administrador

As instalações de 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 realizar 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. Os usuários não serão solicitados a consentir com 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 podem restringir quais usuários podem acessar 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 elas sejam distribuídas e usadas de maneira adequada pela instituição correspondente.
• Menor carga 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 ver e instalar seu complemento no Google Workspace Marketplace. Permitir a instalação individual pode levar mais professores a adotar ou defender seu produto.
• Teste do administrador. Um administrador pode instalar um complemento individualmente 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 individuais. Se um complemento não estiver na lista de permissões, os usuários ainda poderão ver a listagem dele 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 para um administrador do domínio. Consulte Gerenciar apps do Google Workspace Marketplace na sua 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

É necessário fornecer um URL iframe de lançamento no campo URI de configuração de anexos. Esse URL é usado como o valor src de iframe para o iframe de descoberta de anexo. O iframe de descoberta de anexos é usado pelos professores para encontrar conteúdo ou atividades para anexar à atividade.

Também é preciso especificar todos os prefixos de URI permitidos para anexos do seu complemento. Esse recurso aumenta a segurança ao impedir anexos de fontes não autorizadas.

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

Contas de teste

Crie contas de teste no domínio de demonstração para verificar o comportamento correto do complemento particular. Duas contas de estudantes são necessárias para testar a alternância entre alunos no iframe "Revisão dos trabalhos dos alunos".

Contas de teste sugeridas:

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

Siga este procedimento para criar uma nova 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 os papéis adequados.

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 membros e proprietários do grupo.

Figura 2. Localização do link Criar grupo no Admin Console.