Requisitos de complementos

Versão 1.0, 30 de abril de 2024.

Os critérios nesta página são válidos para todos os complementos do Google Sala de Aula. Seu o complemento precisa atender a todos os itens obrigatórios aplicáveis para que seja aprovado para listagem o Google Workspace Marketplace e um complemento que "Compatível com Google Sala de Aula".

As palavras-chave "PRECISA", "NÃO PODE", "OBRIGATÓRIO", "DEVERÁ", "NÃO DEVE", "DEVERIA", "NÃO DEVE", "RECOMENDADO", "PODE" e "OPCIONAL" neste documento sejam interpretado 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 usar PRECISA ser mostrada quando o usuário não tem uma licença. A mensagem PRECISA indicar de maneira clara por que o complemento não pode ser usado e sugerir uma ação para o usuário resolver a situação. OBRIGATÓRIO
  1.3 A listagem do complemento no Google Workspace Marketplace PRECISA especificar detalhes sobre os requisitos de licenciamento que podem ser necessários para usar o complemento. Se o complemento tiver uma camada paga, a listagem do Marketplace PRECISA fornecer um link para uma página da Web com mais informações sobre preços ou como entrar em contato com um vendedor. OBRIGATÓRIO
2.0 Login do usuário final
  2.1 Os professores PRECISAM fazer login no complemento usando o SSO do Google.
Se os 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 nas próximas visitas sem mostrar uma solicitação de login.
Quando a dica de login não corresponde ao usuário conectado, o complemento PRECISA solicitar ao usuário 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 ainda não tiver feito login no complemento (conforme determinado pela dica de login), o complemento PRECISA apresentar um "Fazer login com o Google". com uma ação explícita do usuário que acione o processo de login.
Observação: isso é necessário para atender às diretrizes de branding do Google e 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 seguir as diretrizes gerais de aprovação do Google Workspace Marketplace. OBRIGATÓRIO
  3.2 Se uma tarefa for iniciada em uma nova guia ou janela de qualquer jornada do iframe, ela PRECISA mostrar uma mensagem fácil de usar para retornar ao Google Sala de Aula. OBRIGATÓRIO
  3.3 O usuário PRECISA concluir a jornada somente usando um fluxo de trabalho de complemento, e não mudar para o fluxo do "courseWork" nem usar o botão "Compartilhar" 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 PRECISA definir pointsEarned quando um estudante fizer um envio usando credenciais de professor armazenadas (recomendado) OU quando o professor abrir o envio no iframe "Revisão dos trabalhos dos alunos". OBRIGATÓRIO
  3,9 Os complementos DEVEM estar em conformidade com as diretrizes AA da WCAG 2.1 sobre acessibilidade. Os desenvolvedores de complementos vão informar que esse requisito foi atendido no momento do envio e que o complemento continua em conformidade com as mudanças futuras no complemento. RECOMENDADOS
  3.10 Os erros encontrados por um usuário PRECISAM ser legíveis. OBRIGATÓRIO
  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
  3.12 Se a studentViewUri, a teacherViewUri ou a studentWorkViewUri for iniciada de uma atividade ou curso copiado, o complemento DEVE mostrar um novo anexo para o estudante concluir e NÃO DEVE mostrar as respostas dos estudantes em atividades ou cursos anteriores no iframe. RECOMENDADOS
4.0 Descoberta de anexos
  4.1 Se um anexo exigir o envio de um estudante, ele PRECISA incluir um studentWorkReviewUri para que seja tratado como um tipo de atividade, e não como um anexo de 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 conteúdo 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 DEVE ser capaz de encontrar e acessar todos os conteúdos/atividades disponíveis para ele. RECOMENDADOS
  4.4 O professor PRECISA ter acesso a uma prévia do conteúdo/atividade antes de se comprometer a anexá-lo à tarefa. OBRIGATÓRIO
  4,5 Se o professor precisar que o professor crie conteúdo/atividade antes de anexar, esse trabalho DEVE ser concluído no iframe. RECOMENDADOS
5.0 Visualização dos estudantes
  5.1 Quando o studentViewUri é iniciado, o complemento NÃO DEVE remover o usuário do iframe para concluir uma tarefa.
Se o complemento remover o usuário do iframe, é PRECISO haver uma mensagem ou outra indicação para que os estudantes retornem ao Google Sala de Aula.
RECOMENDADOS
  5.2 Se uma atividade de complemento sair do iframe, será NECESSÁRIO que haja uma visualização sobre a tarefa no iframe. OBRIGATÓRIO
  5.3 Se uma atividade exigir que um aluno realize uma ação para marcar o trabalho como concluído, o botão NÃO PODE ser rotulado como "Entregar" para evitar confusão com o botão "Entregar" do Google Sala de Aula. OBRIGATÓRIO
6,0 Visualização do professor
  6.1 O professor DEVE ser capaz de ver o que o aluno verá quando fizer a tarefa. RECOMENDADOS
7,0 Revisão dos trabalhos dos estudantes
  7.1 Se o studentWorkReviewUri for iniciado, o complemento PRECISA renderizar o trabalho do estudante para avaliação do professor no iframe. Material complementar pode estar vinculado fora do iframe. OBRIGATÓRIO
  7.2 O complemento NÃO PODE ativar a navegação entre estudantes na visualização studentWorkReviewUri. A navegação entre estudantes PRECISA ocorrer apenas na interface do Google Sala de Aula. OBRIGATÓRIO
8,0 Suporte do Google Sala de Aula para dispositivos móveis
  8.1 Quando o app para dispositivos móveis do Google Sala de Aula inicia uma teacherViewUri, studentViewUri ou studentWorkReviewUri, o URL PRECISA abrir o app nativo para dispositivos móveis ou o app da Web para dispositivos móveis do parceiro e, em ambos os casos, criar um link direto para a visualização correta. Se o dispositivo não for compatível, uma mensagem PRECISA ser exibida para informar ao usuário que o dispositivo não é compatível e, de preferência, quais dispositivos são compatíveis. OBRIGATÓRIO
  8.2 Os trabalhos dos alunos DEVEM ser concluídos em um dispositivo móvel. RECOMENDADOS
9,0 Outros recursos
  9.1 Se os professores puderem colar links no seu conteúdo como "Anexos de link", você DEVE fazer upgrade desses links para anexos de complementos. RECOMENDADOS
  9.2 Se você usar uma integração do CourseWork para criar atividades fora do Google Sala de Aula, DEVE criar anexos de complementos por padrão em todos os links compatíveis com eles. RECOMENDADOS

Registro de alterações

Versão 1.0 Atualizado em 30 de abril de 2024
1.1 As versões 1.1 e 1.2 foram combinadas em um único requisito.
2.1 As versões 2.1 e 2.5 foram combinadas em um único requisito.
2.2 As versões 2.2, 2.3 e 2.4 foram combinadas em um único requisito.
3.5 As versões 3.5, 3.6 e 3.7 foram combinadas em um único requisito.
3.10 Adição do requisito de que o complemento nunca entre em um sistema um estado irrecuperável.
3,11, 3,12 5.5, 5.6, 6.3, 6.4, 7.5 e 7.6 foram combinados em duas novas e cumprimento de requisitos regulatórios.
4.2 A descrição de experiências aceitáveis de descoberta de anexos foi ampliada.
4.3 Renumerada, a versão 4.2. Também alterado de REQUIRED para RECOMENDADO.
4.4 Renumerada, a versão 4.3.
4,5 Renumerada, a versão 4.4.
5.2 Renumerada, a versão 5.3.
5.3 Renumerada, a versão 5.2.
9.1 Adicionamos uma recomendação para fazer upgrade dos links colados em anexos.
9.2 Adicionou uma recomendação para criar anexos de complementos por padrão ao criar tarefas do curso de maneira 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 de dica de login.
2.4 Incorporação de um cenário em que a implementação de hd é obrigatórios.
3.2 "Fornecer caminho" reformulado.
5,5, 5,6, 6,3, 6,4, 7,5, 7,6 Adição do texto obrigatório e das orientações recomendadas para o studentViewUri, teacherViewUri e studentWorkReviewUri
Versão 0.2 Atualizado em 29 de outubro de 2021
1.3 Ajustamos o texto para que ele tenha uma intenção mais clara.
3.1 Adição de "O complemento PRECISA aderir às diretrizes gerais de aprovação do GWM encontrado no site".
3,9 WCAG alterado REQUIRED para RECOMENDED.
5.1 Alteração de REQUIRED para RECOMMENDED.
5.3 Adicionado "Se os complementos saírem do iframe, é NECESSÁRIO ter uma visualização sobre a tarefa no iframe".
5.4 Adicionado "Se o complemento sair do iframe, deve haver um aviso para os alunos retornarem ao Google Sala de Aula".
8.1 Adicionado "Se o dispositivo não tiver suporte, uma mensagem DEVE ser exibida ao usuário para informar que é um dispositivo sem suporte e, idealmente, qual dispositivos compatíveis."
8.2 O trabalho do estudante em dispositivos móveis foi alterado de REQUIRED para RECOMMENDED.
Versão 0.1 Atualizado em 22 de setembro de 2021
  Versão inicial.