Versão 1.1, 5 de dezembro de 2024.
Os critérios desta página se aplicam a todos os complementos do Google Sala de Aula. Seu complemento precisa atender a todos os requisitos aplicáveis para ser aprovado e listado no Google Workspace Marketplace e ser um complemento "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 serão interpretadas conforme descrito na RFC 2119.
Requisitos
| ID | Tipo | ||
|---|---|---|---|
| 1.0 | Licença do usuário final (se aplicável) | ||
| 1.1 | Uma mensagem amigável 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 uma forma de ação para que o usuário resolva a situação. | RECOMENDADOS | |
| 1.3 | A página "Detalhes do app" 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 listagem 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 professor 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 automaticamente em um usuário em visitas subsequentes sem mostrar uma solicitação de login. Quando a dica de login não corresponder ao usuário que fez login, 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 fez login no complemento (conforme determinado pela dica de login), o complemento PRECISA apresentar um botão "Fazer login com o Google" para que o usuário realize uma ação explícita para acionar o processo de login. Observação: isso é necessário para atender às diretrizes de branding do Google e também ajuda a evitar bloqueadores de pop-up. |
OBRIGATÓRIO | |
| 2.8 | O complemento DEVE mostrar quem é o usuário conectado. | 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 uma das jornadas de iframe, ela DEVE fornecer uma mensagem fácil de usar para retornar ao Google Sala de Aula. | RECOMENDADOS | |
| 3.3 | O usuário PRECISA concluir a jornada usando um fluxo de trabalho de complemento e não mudar para um fluxo de curso ou usar o botão de compartilhamento do Google Sala de Aula. | OBRIGATÓRIO | |
| 3.4 | Escolha de localização: o idioma DEVE ser baseado na preferência local definida pelo navegador, quando disponível. | RECOMENDADOS | |
| 3.5 | Se um complemento define maxPoints, ele também precisa definir pointsEarned quando um estudante conclui um envio usando as credenciais armazenadas do professor (recomendado) OU quando o professor abre o envio na visualização de trabalho do estudante. |
OBRIGATÓRIO | |
| 3,9 | Os complementos precisam estar em conformidade com as diretrizes de acessibilidade do nível AA das WCAG 2.1. 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. | RECOMENDADOS | |
| 3.10 | Todos os erros que um usuário encontra precisam ser legíveis por humanos. | RECOMENDADOS | |
| 3.11 | Se a studentViewUri, teacherViewUri ou studentWorkViewUri for iniciada em uma atividade ou curso copiado, o complemento NÃO PODERÁ 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 PRECISA incluir um studentWorkReviewUri para ser 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:
|
OBRIGATÓRIO | |
| 4.3 | O professor PRECISA encontrar e acessar todo o conteúdo/atividades disponíveis. | RECOMENDADOS | |
| 4.4 | O professor DEVE poder visualizar o conteúdo/atividade antes de fazer o compromisso de anexá-lo à atividade. | RECOMENDADOS | |
| 4,5 | Se o professor precisar criar conteúdo/atividade antes de fazer o upload, o trabalho PRECISA ser concluído no iframe. | RECOMENDADOS | |
| 5.0 | Visualização do estudante | ||
| 5.1 | Quando o studentViewUri é iniciado, o complemento NÃO PODE tirar o usuário do iframe para concluir uma tarefa.Se o complemento tirar o usuário do iframe, é PRECISO que haja uma mensagem ou outra indicação para que os estudantes voltem ao Google Sala de Aula. |
RECOMENDADOS | |
| 5.2 | Se uma atividade de complemento for exibida fora 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 a opção Entregar 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 DEVE poder ver o que o estudante vai encontrar 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 dentro do 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 os estudantes PRECISA acontecer 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, fazer um link direto para a visualização correta. Se o dispositivo não for compatível, uma mensagem PRECISA ser exibida para o usuário informando que ele não é compatível e, de preferência, quais dispositivos são compatíveis. |
OBRIGATÓRIO | |
| 8.2 | O trabalho dos estudantes DEVE 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ê usa uma integração do CourseWork para criar atividades fora do Google Sala de Aula, crie anexos de complementos por padrão para todos os links compatíveis com o 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 desenvolvedores de complementos enviem de forma confiável as atividades dos estudantes usando a API. |
| Versão 1.0 | Atualizado em 30 de abril de 2024 |
| 1.1 | Combinação de 1.1 e 1.2 em um único requisito. |
| 2.1 | Combinação de 2.1 e 2.5 em um único requisito. |
| 2.2 | Os requisitos 2.2, 2.3 e 2.4 foram combinados em um único requisito. |
| 3.5 | As versões 3.5, 3.6 e 3.7 foram combinadas em um único requisito. |
| 3.10 | Foi adicionado o requisito de que o complemento nunca entre em um estado não inteligível ou irreversível. |
| 3.11, 3.12 | As versões 5.5, 5.6, 6.3, 6.4, 7.5 e 7.6 foram combinadas em dois novos requisitos. |
| 4.2 | Ampliamos a descrição das experiências aceitáveis da Descoberta de anexos. |
| 4.3 | Renumerada, anteriormente 4.2. Também mudou de OBRIGATÓRIO para RECOMENDADO. |
| 4.4 | Renumerada, anteriormente 4.3. |
| 4,5 | Renumerada, anteriormente 4.4. |
| 5.2 | Renumerada, anteriormente 5.3. |
| 5.3 | Renumerada, anteriormente 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 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 na orientação de dicas de login. |
| 2.4 | Incorporamos um cenário em que a implementação de hd é
necessária. |
| 3.2 | A frase "fornecer caminho" foi reformulada. |
| 5,5; 5,6; 6,3; 6,4; 7,5; 7,6 | Adicionamos orientação recomendada e obrigatória para a cópia do curso para
studentViewUri, teacherViewUri e
studentWorkReviewUri. |
| Versão 0.2 | Atualizado em 29 de outubro de 2021 |
| 1.3 | O texto foi ajustado para deixar a intenção mais clara. |
| 3.1 | Foi adicionado o seguinte texto: "O complemento precisa seguir as diretrizes gerais de aprovação do GWM encontradas no site dele." |
| 3,9 | O WCAG mudou OBRIGATÓRIO para RECOMENDADO. |
| 5.1 | Obrigatório foi alterado para RECOMENDADO. |
| 5.3 | Adição de "Se os complementos saírem do iframe, eles PRECISAM ter uma prévia sobre a tarefa no iframe." |
| 5.4 | Foi adicionado "Se o complemento sair do iframe, os estudantes vão receber uma solicitação para retornar ao Google Sala de Aula". |
| 8.1 | Foi adicionado: "Se o dispositivo não tiver suporte, uma mensagem PRECISA ser exibida para o usuário informando que ele não tem suporte e, idealmente, quais dispositivos têm suporte." |
| 8.2 | O trabalho dos alunos em dispositivos móveis mudou de OBRIGATÓRIO para RECOMENDADO. |
| Versão 0.1 | Atualizado em 22 de setembro de 2021 |
| Versão inicial. |