Requisitos de complementos

Versão 1.1, 5 de dezembro de 2024.

Os critérios nesta página se aplicam a todos os complementos do Google Sala de Aula. Seu complemento precisa atender a todos os itens obrigatórios aplicáveis para ser aprovado e listado no Google Workspace Marketplace e como um complemento que "Funciona com o Google Sala de Aula".

As palavras-chave "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY" e "OPTIONAL" neste documento devem ser interpretadas conforme descrito na RFC 2119.

Requisitos

ID Tipo
1.0 Licença de usuário final (se aplicável)
  1.1 Uma mensagem fácil de entender DEVE ser mostrada ao usuário quando ele não tiver uma licença. A mensagem PRECISA indicar claramente o motivo pelo qual o complemento não pode ser usado e sugerir um curso de ação para o usuário corrigir a situação. RECOMENDADOS
  1.3 A página do Google Workspace Marketplace para o complemento DEVE especificar detalhes sobre os requisitos de licença e assinatura que podem ser necessários para usar o complemento. Se o complemento tiver um nível pago, a página do Marketplace DEVE fornecer um link para uma página da Web com mais informações sobre preços ou como entrar em contato com um vendedor. RECOMENDADOS
2.0 Login do usuário final
  2.1 Os usuários professores PRECISAM fazer login no complemento usando o SSO do Google.
Se os usuários estudantes precisarem fazer login no complemento, eles PRECISAM usar o SSO do Google.		 OBRIGATÓRIO
  2.2 O complemento PRECISA usar o SSO do Google para fazer login automático de um usuário em visitas subsequentes sem mostrar uma solicitação de login.
Quando a dica de login não produz uma correspondência com o usuário conectado no momento, o complemento PRECISA mostrar um botão de login e transmitir o login_hint à biblioteca de autenticação para filtrar contas inválidas.		 OBRIGATÓRIO
  2.7 Quando o usuário do Google Sala de Aula não estiver conectado ao complemento (determinado pela dica de login), o complemento DEVE apresentar um botão "Fazer login com o Google" para que uma ação explícita do usuário acione o processo de login.
Observação: isso é necessário para atender às diretrizes de marca do Google e também ajuda a evitar bloqueadores de pop-ups.		 OBRIGATÓRIO
  2.8 O complemento DEVE mostrar quem é o usuário conectado no momento. RECOMENDADOS
3.0 Geral
  3.1 O complemento PRECISA obedecer às diretrizes gerais de aprovação do Google Workspace Marketplace. OBRIGATÓRIO
  3.2 Se uma tarefa for iniciada em uma nova guia ou janela em qualquer um dos fluxos de iframe, ela DEVE fornecer uma mensagem fácil de usar para voltar ao Google Sala de Aula. RECOMENDADOS
  3.3 O usuário SÓ PODE concluir a jornada usando um fluxo de trabalho de complemento e não pode mudar para um fluxo de trabalho de atividades ou usar o botão de compartilhamento do Google Sala de Aula. OBRIGATÓRIO
  3.4 Opção de localização: o idioma DEVE ser baseado na preferência local definida pelo navegador, quando disponível. RECOMENDADOS
  3.5 Se um complemento definir maxPoints, ele também precisará definir pointsEarned quando um estudante concluir um envio usando as credenciais armazenadas do professor (recomendado) OU quando o professor abrir o envio no iframe de revisão de trabalhos dos estudantes. OBRIGATÓRIO
  3,9 Os complementos DEVEM obedecer às diretrizes de acessibilidade do nível AA das WCAG 2.1. Os desenvolvedores de complementos vão informar por conta própria que esse requisito foi atendido no momento do envio e que o complemento vai continuar em conformidade com as mudanças futuras. RECOMENDADOS
  3.10 Todos os erros encontrados por um usuário PRECISAM ser legíveis. RECOMENDADOS
  3.11 Se o studentViewUri, teacherViewUri ou studentWorkViewUri for iniciado de uma atividade ou curso copiado, o complemento NÃO PODE mostrar uma página de erro no iframe. OBRIGATÓRIO
4,0 Descoberta de anexos
  4.1 Se um anexo exigir um envio do estudante, ele DEVE incluir um studentWorkReviewUri para ser tratado como um tipo de atividade e não como um tipo de conteúdo. OBRIGATÓRIO
  4.2 O iframe de descoberta de anexos PRECISA fornecer uma interface do usuário que ofereça pelo menos uma das seguintes opções:
  • Criar novo conteúdo para anexar
  • Procurar, selecionar e anexar de uma biblioteca de conteúdo
  • Instruções para anexar conteúdo do seu site ou de outros produtos
 OBRIGATÓRIO
  4.3 O professor PRECISA conseguir encontrar e acessar todo o conteúdo/atividades disponíveis para ele. RECOMENDADOS
  4.4 O professor PRECISA conseguir visualizar o conteúdo/atividade antes de se comprometer a anexá-lo à atividade. RECOMENDADOS
  4,5 Se o professor precisar criar conteúdo/atividade antes de anexar, esse trabalho DEVE ser concluído no iframe. RECOMENDADOS
5.0 Visualização do estudante
  5.1 Quando o studentViewUri é iniciado, o complemento NÃO DEVE tirar o usuário do iframe para concluir uma tarefa.
Se o complemento tirar o usuário do iframe, uma mensagem ou outra indicação para os estudantes voltarem ao Google Sala de Aula DEVE ser exibida.		 RECOMENDADOS
  5.2 Se uma atividade do complemento sair do iframe, DEVE haver uma prévia sobre a tarefa no iframe. RECOMENDADOS
  5.3 Se houver um botão ou link na atividade com o rótulo Entregar, ele PRECISA causar uma solicitação de API para enviar o trabalho do estudante para revisão do professor. OBRIGATÓRIO
6.0 Visualização do professor
  6.1 O professor PRECISA conseguir ver o que o estudante vai ver ao fazer a atividade. RECOMENDADOS
7.0 Revisão do trabalho do estudante
  7.1 Se o studentWorkReviewUri for iniciado, o complemento PRECISA renderizar o trabalho do estudante para revisão do professor no iframe. O material complementar pode ter links fora do iframe. OBRIGATÓRIO
  7.2 O complemento NÃO PODE permitir a navegação entre estudantes na visualização studentWorkReviewUri. A navegação entre estudantes SÓ pode acontecer na interface do Google Sala de Aula. OBRIGATÓRIO
8.0 Suporte para dispositivos móveis do Google Sala de Aula
  8.1 Quando o app móvel do Google Sala de Aula inicia um teacherViewUri, studentViewUri ou studentWorkReviewUri, o URL PRECISA abrir o app nativo móvel ou o web app móvel do parceiro e, em ambos os casos, fazer um link direto para a visualização correta. Se o dispositivo não for compatível, uma mensagem PRECISA ser mostrada ao usuário informando que ele não é compatível e, idealmente, quais dispositivos são compatíveis. OBRIGATÓRIO
  8.2 O trabalho dos estudantes PRECISA poder ser concluído em um dispositivo móvel. RECOMENDADOS
9.0 Outros recursos
  9.1 Se os professores puderem colar links para seu conteúdo como anexos de link, faça upgrade dos links para anexos de complementos. RECOMENDADOS
  9.2 Se você usar uma integração do CourseWork para criar atividades fora da Sala de Aula, crie anexos de complemento por padrão para todos os links compatíveis com seu complemento. RECOMENDADOS

Registro de alterações

Versão 1.1 Atualizado em 5 de dezembro de 2024
1.1, 1.3, 3.2, 3.10, 4.4, 5.2 Mudou de "OBRIGATÓRIO" para "RECOMENDADO".
3.12 Removido.
5.3 Reformulada. Uma mudança recente permite que os desenvolvedores de complementos entreguem as atividades dos estudantes usando a API.
Versão 1.0 Atualizado em 30 de abril de 2024
1.1 Combinamos 1.1 e 1.2 em um único requisito.
2.1 Combinamos 2.1 e 2.5 em um único requisito.
2.2 Combinamos 2.2, 2.3 e 2.4 em um único requisito.
3.5 Combinamos as versões 3.5, 3.6 e 3.7 em um único requisito.
3.10 Adicionada a exigência de que o complemento nunca entre em um estado ininteligível ou irrecuperável.
3.11, 3.12 Combinamos as versões 5.5, 5.6, 6.3, 6.4, 7.5 e 7.6 em dois novos requisitos.
4.2 Expandimos a descrição das experiências aceitáveis de descoberta de anexos.
4.3 Renumerado, antes 4.2. Também mudou de "OBRIGATÓRIO" para "RECOMENDADO".
4.4 Renumerado, antes 4.3.
4,5 Renumerado, antes 4.4.
5.2 Renumerado, antes 5.3.
5.3 Renumerado, antes 5.2.
9.1 Adicionamos uma recomendação para fazer upgrade de links colados para anexos.
9.2 Adicionamos uma recomendação para criar anexos de complementos por padrão ao criar atividades do Google Sala de Aula de forma programática.
2.6, 3.7, 3.8, 6.2, 7.3, 7.4 Removido.
Versão 0.3 Atualizado em 22 de novembro de 2022
2.3 Correção da orientação sobre a dica de login.
2.4 Incorporamos um cenário em que a implementação de hd é obrigatória.
3.2 Reformulação de "fornecer caminho".
5.5, 5.6, 6.3, 6.4, 7.5, 7.6 Adicionamos orientações obrigatórias e recomendadas para a cópia do curso em studentViewUri, teacherViewUri e studentWorkReviewUri.
Versão 0.2 Atualizado em 29 de outubro de 2021
1.3 Ajustamos o texto para deixar a intenção mais clara.
3.1 Adicionamos: "O complemento PRECISA obedecer às diretrizes gerais de aprovação do GWM encontradas no site."
3,9 A WCAG mudou REQUIRED para RECOMMENDED.
5.1 Mudança de "OBRIGATÓRIO" para "RECOMENDADO".
5.3 Adicionamos: "Se os complementos aparecerem fora do iframe, DEVE haver uma prévia sobre a tarefa no iframe".
5.4 Adicionamos: "Se o complemento sair do iframe, os estudantes PRECISAM receber uma solicitação para voltar ao Google Sala de Aula".
8.1 Adicionamos: "Se o dispositivo não for compatível, uma mensagem PRECISA ser mostrada ao usuário para informar que ele não é compatível e, idealmente, quais dispositivos são compatíveis".
8.2 O trabalho dos estudantes em dispositivos móveis mudou de "REQUIRED" para "RECOMMENDED".
Versão 0.1 Atualizado em 22 de setembro de 2021
  Versão inicial.