Requisitos de complementos

Versão 1.0, 30 de abril 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 para inclusão no Google Workspace Marketplace e um complemento que tenha o selo "Compatível com o Sala de Aula".

As palavras-chave "PRECISA", "NÃO PODE", "OBRIGATÓRIO", "DEVE", "NÃO DEVE", "DEVE", "NÃO DEVE", "RECOMENDADO", "PODE" e "OPCIONAL" neste documento devem ser interpretadas conforme descrito na RFC 2119 (link em inglês).

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 ao usuário quando ele não tem uma licença. A mensagem PRECISA indicar claramente por que o complemento não pode ser usado e sugerir uma ação para o usuário resolver a situação. REQUIRED
  1.3 A listagem do Google Workspace Marketplace do complemento PRECISA especificar detalhes sobre os requisitos de licenciamento que podem ser necessários para usar o complemento. Se o complemento tiver um nível pago, 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. REQUIRED
2.0 Login do usuário final
  2.1 Professores PRECISAM fazer login no complemento usando o SSO do Google.
Se os usuários estudantes precisarem fazer login no complemento, eles PRECISAM fazer login usando o SSO do Google.
REQUIRED
  2.2 O complemento PRECISA usar o SSO do Google para fazer o login do usuário automaticamente 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 mostrar um botão de login e transmitir o login_hint para a biblioteca de autenticação para filtrar contas inválidas.
REQUIRED
  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 botão "Fazer login com o Google" para acionar o processo de login explicitamente.
Observação: isso é necessário para atender às diretrizes da promoção de marca do Google e também ajuda a evitar bloqueadores de pop-up.
REQUIRED
  2,8 O complemento DEVE mostrar quem é o usuário conectado. RECOMENDADOS
3.0 Geral
  3.1 O complemento PRECISA aderir às diretrizes gerais de aprovação do Google Workspace Marketplace. REQUIRED
  3.2 Se uma tarefa for iniciada em uma nova guia ou janela em qualquer uma das jornadas do iframe, ela PRECISA fornecer uma mensagem fácil de usar para retornar ao Google Sala de Aula. REQUIRED
  3,3 O usuário PRECISA concluir a jornada usando apenas um fluxo de trabalho de complemento. Não é permitido alternar para o fluxo do curso ou usar o botão de compartilhamento do Google Sala de Aula. REQUIRED
  3.4 Escolha de localização: o idioma DEVE ter como base a preferência local definida pelo navegador, quando disponível. RECOMENDADOS
  3.5 Se um complemento definir o maxPoints, ele também PRECISA definir pointsEarned quando um estudante conclui um envio usando as credenciais de professor armazenadas (recomendado) OU quando o professor abre o envio no iframe "Avaliação dos trabalhos dos estudantes". REQUIRED
  3.9 Os complementos DEVEM estar em conformidade com as diretrizes AA de nível AA 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 dele. RECOMENDADOS
  3.10 Todos os erros encontrados por um usuário PRECISAM ser legíveis. REQUIRED
  3.11 Se studentViewUri, teacherViewUri ou studentWorkViewUri for iniciado por uma atividade ou um curso copiado, o complemento NÃO PODERÁ mostrar uma página de erro no iframe. REQUIRED
  3.12 Se o studentViewUri, o teacherViewUri ou a studentWorkViewUri forem iniciados em 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 de 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 uma studentWorkReviewUri para ser tratado como um tipo de atividade, não como um anexo de tipo de conteúdo. REQUIRED
  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:
  • Crie conteúdo para anexar
  • Procure, selecione e anexe de uma biblioteca de conteúdo
  • Instruções para anexar conteúdo do seu site ou de outros produtos
REQUIRED
  4.3 o professor DEVE ser capaz de encontrar e acessar todo o conteúdo e as atividades disponíveis para ele. RECOMENDADOS
  4.4 O professor PRECISA ter acesso ao conteúdo ou à atividade antes de se comprometer a anexar o conteúdo à tarefa. REQUIRED
  4.5 Se o professor precisar criar o conteúdo ou a atividade antes de anexá-los, esse trabalho DEVE ser concluído no iframe. RECOMENDADOS
5.0 Visualização do estudante
  5.1 Quando o studentViewUri for iniciado, o complemento NÃO DEVE retirar o usuário do iframe para concluir uma tarefa.
Se o complemento remover o usuário do iframe, PRECISA 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, PRECISA haver uma visualização sobre a tarefa no iframe. REQUIRED
  5.3 Se uma atividade exigir que um estudante realize uma ação para marcar o trabalho como concluído, o botão NÃO PODE estar marcado como "Entregar" para evitar confusão com o botão "Entregar" do Google Sala de Aula. REQUIRED
6,0 Visualização do professor
  6,1 o professor DEVE poder ver o que o estudante vai ver quando fizer a tarefa. RECOMENDADOS
7,0 Avaliação dos trabalhos dos estudantes
  7,1 Se o studentWorkReviewUri for iniciado, o complemento PRECISA renderizar no iframe o trabalho do estudante para revisão do professor. É possível que materiais complementares sejam vinculados fora do iframe. REQUIRED
  7,2 O complemento NÃO PODE ativar a navegação entre estudantes na visualização studentWorkReviewUri. A navegação entre os estudantes PRECISA ocorrer apenas na interface do Google Sala de Aula. REQUIRED
8,0 Suporte para dispositivos móveis do Google Sala de Aula
  8.1 Quando o app Google Sala de Aula para dispositivos móveis inicia um teacherViewUri, studentViewUri ou studentWorkReviewUri, o URL PRECISA abrir o app nativo para dispositivos móveis do parceiro ou o app da Web para dispositivos móveis do parceiro e, em ambos os casos, incluir 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 é incompatível e, preferencialmente, quais dispositivos são compatíveis. REQUIRED
  8.2 Os trabalhos dos estudantes DEVEM ser concluídos em um dispositivo móvel. RECOMENDADOS
9,0 Outros recursos
  9.1 Se os professores conseguirem colar links no seu conteúdo como anexos de link, você DEVE fazer upgrade dos links para anexos de complementos. RECOMENDADOS
  9.2 Se você usa uma integração do CourseWork para criar atividades fora do Google Sala de Aula, DEVE criar anexos de complementos por padrão para todos os links compatíveis. RECOMENDADOS

Registro de alterações

Versão 1.0 Atualizado em 30 de abril de 2024
1.1 1.1 e 1.2 foram combinados em um único requisito.
2.1 Combinamos as versões 2.1 e 2.5 em um único requisito.
2.2 Foram combinados as versões 2.2, 2.3 e 2.4 em um único requisito.
3.5 Combinamos 3,5, 3,6 e 3,7 em um único requisito.
3.10 Inclusão de requisito para 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 Ampliamos a descrição das experiências aceitáveis de descoberta de anexos.
4.3 Renumerada, antiga 4.2. Também mudou de REQUIRED para RECOMMENDED.
4.4 Renumerada, antiga 4.3.
4.5 Renumerada, antiga 4.4.
5.2 Renumerada, antiga 5.3.
5.3 Renumerada, antiga 5.2.
9.1 Adicionamos uma recomendação para fazer upgrade dos links colados em anexos.
9.2 Inclusão de um requisito para criar anexos de complementos por padrão ao criar tarefas do CourseWork 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 de dica de login.
2.4 Foi incorporado um cenário em que a implementação de hd é necessária.
3.2 "Fornecer caminho" foi reformulado.
5,5, 5,6, 6,3, 6,4, 7,5 e 7,6 Adicionamos orientações obrigatórias e recomendadas do curso para studentViewUri, teacherViewUri e studentWorkReviewUri.
Versão 0.2 Atualizado em 29 de outubro de 2021
1.3 Ajustamos o texto para deixar o conteúdo mais claro.
3.1 Adicionamos a mensagem: "O complemento PRECISA aderir às diretrizes gerais de aprovação do GWM encontradas no site".
3.9 As WCAG mudaram de REQUIRED para RECOMMENDED.
5.1 Alterado REQUIRED para RECOMMENDED.
5.3 Adição de "Se os complementos forem exibidos fora do iframe, é NECESSÁRIO ter uma visualização sobre a tarefa no iframe".
5.4 "Se o complemento sair do iframe, DEVE haver uma solicitação para os alunos retornarem ao Google Sala de Aula".
8.1 "Se o dispositivo não for compatível, uma mensagem PRECISA ser exibida ao usuário para informar que o dispositivo não é compatível e, preferencialmente, quais dispositivos são 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.