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

Os professores usam para adicionar conteúdo de terceiros ao Google Sala de Aula colar um link como Anexo de link na página de criação da atividade. Para criar sobre o que os professores já conhecem, agora você pode configurar seu complemento para os professores podem fazer upgrade de um link de link para um anexo de complemento.

Visão geral

Se você configurar seu complemento com esse recurso, os professores vão precisar fazer o seguinte: atualizar um link para um anexo de complemento quando colar um anexo de link no página de criação de atividade. Os professores só são solicitados a fazer isso se já com o complemento instalado.

Quando o professor concordar em fazer upgrade do link para um anexo de complemento, o link O upgrade do iframe é iniciado com os seguintes parâmetros de consulta:

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

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

Após a criação do anexo do complemento, o iframe é fechado e o o professor poderá acessar o anexo na atividade normalmente.

Detalhes técnicos da implementação

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 na rede Link. Fazer upgrade do iframe. É necessário decodificar o URL para obtê-lo na forma original. Se você está usando JavaScript, por exemplo, é possível usar decodeURIComponent() para isso.

Fechar o iframe de upgrade de link

Para garantir a melhor experiência do usuário para esse recurso, envie um postMessage uma vez. o anexo de complemento foi 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 configurações a seguir são necessárias para integrar este recurso ao seu Complemento:

URL do iframe de upgrade de link: é o URL que abre na iframe quando um professor concorda em fazer o upgrade.
Padrões de URL que o Google Sala de Aula deve detectar e tentar upgrade: os padrões de URL podem consistir em um host e vários caminhos prefixos de rede.
- Você pode fornecer vários padrões de URL.
- Se você não fornecer prefixos de caminho, os URLs que corresponderem ao host podem receber upgrades.
- 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.
- Os prefixos de caminho aceitam caracteres curinga no momento, mas os hosts não podem:
  - 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 componente e não corresponde 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 URL. padrão
  - https://example.com/bar/123/baz/456/789 é uma correspondência válida para o padrão do URL.
  - https://example.com/bar/123/456/baz não é uma correspondência válida para o O padrão do URL porque o caractere curinga no prefixo do caminho não corresponde /123/456/.

Processo de desenvolvimento

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

É possível fornecer configurações para qualquer projeto do Google Cloud que represente um como complemento do Google Sala de Aula. Recomendamos que você primeiro forneça configurações de um complemento com visibilidade privada para que você possa 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 concluídas ativado. Os padrões de URL que usam localhost não são compatíveis com esta .

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 ao qual o complemento está associado.
LINK_UPGRADE_IFRAME_URL: o URL que será aberto no Iframe de upgrade do link.
HOST_1: um host que o Google Sala de Aula precisa detectar. Somente o O esquema https é compatível.
PATH_PREFIX_1 e PATH_PREFIX_2: caminho prefixos associados a HOST_1 que o Google Sala de Aula deve detectar e tentar para fazer o upgrade.
HOST_2: um host que o Google Sala de Aula precisa detectar. Somente o O esquema https é compatível.
PATH_PREFIX_3 e PATH_PREFIX_4: caminho prefixos associados a HOST_2 que o Google Sala de Aula deve detectar e tentar para fazer o upgrade.

Experiência do usuário recomendada

Considere as sugestões a seguir ao implementar esse recurso.

Evite o trabalho extra dos professores

Recomendamos que você use o iframe para facilitar o login, se ou exibir um indicador de carregamento. Para a melhor experiência do usuário, o professor não deve receber solicitações de informações adicionais concordou em atualizar o link colado para um anexo de complemento. No entanto, se isso for não é possível para seu complemento, use o iframe "Upgrade de link" para coletar as informações adicionais de que você precisa. O iframe também pode ser usado para informar professor se não for possível atualizar o link ou se tiver ocorrido um erro.

Incluir mensagens de erro de acesso fácil de usar

Se os professores colarem e atualizarem um link ao qual eles não têm acesso, exiba uma uma mensagem de erro fácil de usar no iframe para que os professores estejam cientes do problema. O iframe também pode ser usado para fornecer ao professor as informações permissões para acessar o conteúdo.