Os complementos do Google Sala de Aula já estão disponíveis para desenvolvedores. Consulte a documentação sobre complementos para mais informações.

Esta página foi traduzida pela API Cloud Translation.

Faça upgrade dos anexos de link para anexos de complementos do Google Sala de Aula

Uma maneira de os professores adicionarem conteúdo de terceiros ao Google Sala de Aula é colando um link como um Anexo de link na página de criação de atividades. Para aproveitar o que os professores já conhecem, agora é possível configurar o complemento para que eles possam fazer upgrade de um anexo de link para um anexo de complemento.

Visão geral

Se você configurar o complemento com esse recurso, os professores vão receber uma solicitação para fazer upgrade de um link para um anexo de complemento ao colar um anexo de link na página de criação de atividades. Os professores só recebem essa solicitação se já tiverem o complemento instalado.

Depois que o professor concordar em fazer upgrade do link para um anexo de complemento, o iframe Link Upgrade será iniciado com os seguintes parâmetros de consulta:

courseId
itemId
itemType
addOnToken
urlToUpgrade
login_hint (somente se o usuário já tiver autorizado seu app)

Os quatro primeiros parâmetros de consulta espelham os parâmetros de consulta iniciados no iframe de descoberta de anexos. O parâmetro de consulta urlToUpgrade é novo e pode ajudar você a avaliar como o anexo do complemento deve ser criado. Em seguida, use os outros parâmetros de consulta para verificar se o usuário fez login e chame o método CreateAddOnAttachment de courseWork, courseWorkMaterials ou announcements com base no valor de itemType. No iframe, é possível mostrar uma tela de carregamento para indicar ao professor que o anexo do complemento está sendo criado.

Depois que o anexo do complemento é criado, o iframe é fechado, e o professor pode ver o anexo na atividade normalmente.

Detalhes da implementação técnica

Esta seção destaca alguns detalhes técnicos importantes do recurso.

Ler o parâmetro de consulta `urlToUpgrade`

O parâmetro de consulta urlToUpgrade é codificado por URI quando transmitido no iframe de atualização de link. É necessário decodificar o URL para acessar o formato original. Se você estiver usando JavaScript, por exemplo, use a função decodeURIComponent().

Fechar o iframe de upgrade de link

Para garantir uma experiência do usuário ideal com esse recurso, envie um postMessage assim que o anexo do complemento for criado. Isso fecha o iframe. Consulte a página de detalhes da implementação de iframe para mais informações.

Detalhes da configuração

As seguintes configurações são necessárias para integrar esse recurso ao seu complemento:

URL do iframe de upgrade de link: é o URL que abre no iframe quando um professor concorda em fazer o upgrade.
Padrões de URL que o Google Sala de Aula precisa detectar e tentar atualizar: os padrões de URL podem consistir em um host e vários prefixos de caminho.
- Você pode fornecer vários padrões de URL.
- Se você não fornecer prefixos de caminho, qualquer URL que corresponda ao host poderá ser atualizado.
- Só é possível fazer upgrade de URLs com um esquema https.
- Os padrões de URL não podem conter localhost.
- Os prefixos de caminho não podem conter parâmetros de consulta ou fragmentos de URL.
- No momento, os prefixos de caminho podem usar caracteres curinga, mas os hosts não:
  - example.com é um host válido, e /foo e /bar/*/baz são prefixos de caminho válidos.
  - example.*.host.com não é um host válido.
- Um caractere curinga entre componentes de prefixo de caminho corresponde apenas a um componente e não a vários componentes separados por barras. Considere um padrão de URL com o host example.com e o prefixo de caminho /bar/*/baz:
  - https://example.com/bar/123/baz é uma correspondência válida para o padrão de URL.
  - https://example.com/bar/123/baz/456/789 é uma correspondência válida para o padrão de URL.
  - https://example.com/bar/123/456/baz não é uma correspondência válida para o padrão de URL porque o caractere curinga no prefixo do caminho não corresponde a /123/456/.

Processo de desenvolvimento

Envie o URL do iframe de upgrade de link e os padrões de URL para seu complemento de teste ou produção por e-mail para classroom-link-upgrade-external@google.com.

Você pode fornecer configurações para qualquer projeto do Google Cloud que represente um complemento do Google Sala de Aula. Recomendamos que você primeiro forneça configurações para um complemento com visibilidade privada para poder desenvolver e testar em um domínio de demonstração sem afetar os usuários ativos.

Você vai receber uma resposta por e-mail quando as configurações forem ativadas. Os padrões de URL que usam localhost não são compatíveis com esse recurso.

Formate o e-mail para incluir o seguinte:

Google Cloud Project number: GCP_PROJECT_NUMBER

Link Upgrade iframe URL: LINK_UPGRADE_IFRAME_URL

URL Patterns:
-   Host:HOST_1
-   Path prefixes:
  -   PATH_PREFIX_1
  -   PATH_PREFIX_2

-   Host:HOST_2
-   Path prefixes:
  -   PATH_PREFIX_3
  -   PATH_PREFIX_4

// add more hosts and path prefixes as needed

Substitua:

GCP_PROJECT_NUMBER: o número do projeto do Google Cloud associado ao complemento.
LINK_UPGRADE_IFRAME_URL: o URL que deve ser aberto no iframe de upgrade de link.
HOST_1: um host que o Google Sala de Aula precisa detectar. Somente o esquema https é compatível.
PATH_PREFIX_1 e PATH_PREFIX_2: prefixos de caminho associados a HOST_1 que o Google Sala de Aula deve detectar e tentar atualizar.
HOST_2: um host que o Google Sala de Aula precisa detectar. Somente o esquema https é compatível.
PATH_PREFIX_3 e PATH_PREFIX_4: prefixos de caminho associados a HOST_2 que o Google Sala de Aula deve detectar e tentar atualizar.

Experiência do usuário recomendada

Confira algumas sugestões para implementar esse recurso.

Evitar trabalho extra para os professores

Recomendamos usar o iframe para facilitar o login, se necessário, ou mostrar um indicador de carregamento. Para uma melhor experiência do usuário, o professor não deve receber solicitações de informações adicionais depois de concordar em fazer upgrade do link colado para um anexo de complemento. No entanto, se isso não for possível para seu complemento, use o iframe de upgrade de link para coletar as informações adicionais necessárias. O iframe também pode ser usado para informar o professor se não for possível atualizar o link ou se ocorrer um erro.

Incluir mensagens de erro de acesso fáceis de entender

Se os professores colarem e atualizarem um link a que não têm acesso, mostre uma mensagem de erro fácil de entender no iframe para que eles saibam do problema. O iframe também pode ser usado para dar ao professor as permissões adequadas para acessar o conteúdo.