Prepare seu aplicativo do SharePoint Framework para ser publicado no Marketplace

  • Artigo

Antes de um aplicativo do SharePoint Framework ser publicado no Marketplace, ele deve passar por um processo de aprovação. Esse processo é executado gratuitamente pela Microsoft e visa garantir que seu aplicativo funcione corretamente e que sua página descreva claramente seus objetivos e recursos. Para ajudá-lo a publicar seu aplicativo no Marketplace, a seguir é apresentada a lista de testes executados como parte do processo de aprovação.

Pré-requisitos

Use o SharePoint Framework v1.11 ou versão mais recente

Para criar soluções que você quer publicar no Marketplace, você precisa usar o SharePoint Framework v 1.11 ou versão superior. A partir da versão 1.11, o manifesto da solução do SharePoint Framework possui informações adicionais sobre sua organização e solução, necessárias para publicar seu aplicativo no Marketplace.

Dica

Se seu aplicativo for criado usando uma versão mais antiga da Estrutura do SharePoint, você poderá atualizá-lo facilmente para a Estrutura do SharePoint v1.11 ou uma versão mais recente usando a CLI do Microsoft 365. Para obter mais informações, visite https://pnp.github.io/cli-microsoft365/cmd/spfx/project/project-upgrade/.

Aplicativo de teste em sites raiz e não raiz

Ao testar seu aplicativo, verifique se ele está funcionando conforme o previsto quando instalado no conjunto de sites raiz de um locatário e em sites não raiz. Isso o ajudará a verificar se não há dependências em URLs específicas do site.

Teste o aplicativo nos navegadores necessários

Ao testar seu aplicativo em relação às verificações descritas na seção a seguir, verifique se ele funciona como o esperado, pelo menos no Windows 10 nas versões mais recentes do cliente Microsoft Edge, Google Chrome, Firefox e Microsoft Teams Desktop (se o seu aplicativo expuser Web Parts no Teams )

Verificações necessárias

As seguintes verificações devem ser passadas. Se uma ou mais verificações dessa categoria falharem, seu aplicativo será rejeitado e você será instruído a corrigir os problemas relatados.

Garantir a Conformidade de Contrato da Estrutura do SharePoint

A sua Web Part ou personalizador deve manipular apenas o elemento DOM fornecido por meio da propriedade domElement. Esse elemento e o objeto de contexto fornecido são as únicas maneiras aprovadas de adicionar funcionalidade em sites através do seu aplicativo. Manipular diretamente a página DOM resultará na rejeição da sua solução.

Em circunstâncias normais, a solução deve funcionar conforme o esperado

Em circunstâncias normais, todos os componentes (Web Parts e extensões) na sua solução devem funcionar da maneira desejada. De preferência, antes de enviar seu aplicativo para ser aprovado, verifique se ele está funcionando conforme o esperado em vários locatários e está usando diferentes contas de usuário para garantir que não dependa de nenhuma configuração específica. Se sua solução requer configurações específicas, mencione-a explicitamente na descrição da solução.

A Web Part deve funcionar em todos os hosts que estão expostos

Ao criar Web Parts usando o SharePoint Framework, você pode escolher onde elas devem ser expostas. Antes de enviar seu aplicativo para ser revisado, verifique se sua Web Part funciona conforme o esperado em todos esses hosts.

O pacote de solução deve conter metadados válidos para o desenvolvedor

O manifesto da solução (gerenciado no package-solution.json arquivo) deve ter uma nova seção nomeada developer com as seguintes propriedades:

Atributo Descrição Obrigatório
name Nome da organização que criou o aplicativo Sim
websiteUrl URL de um site com informações adicionais sobre o aplicativo Sim
mpnId ID do Microsoft Partner Network (mais detalhes em MS Partner Network) Não (mas é altamente recomendável fornecê-lo)
privacyUrl URL da política de privacidade Sim
termOfUseUrl URL dos termos de uso Sim

A inclusão dessas informações adicionais permite que você comunique claramente as informações do seu aplicativo aos seus usuários e, no futuro, deverá permitir o acesso a dados de uso adicionais.

As informações do desenvolvedor são exibidas ao instalar Web Parts no Microsoft Teams. As informações sobre o aplicativo e o desenvolvedor que são exibidas no Marketplace são gerenciadas separadamente no Marketplace.

O texto de descrição dos metadados das Web Parts deve descrever brevemente sua funcionalidade e proposta de valor

Verifique se a descrição da sua Web Part nos metadados é significativa para que os usuários entendam qual é o objetivo da Web Part e o que eles podem esperar dela.

A descrição da solução deve descrever claramente os diferentes componentes incluídos no pacote

Ao enviar seu pacote para o Marketplace, descreva claramente quais componentes diferentes (Web Parts, personalizadores de aplicativos, etc.) estão incluídos no pacote para gerenciar as expectativas do usuário e ajudá-lo a entender o impacto do uso do aplicativo.

Não use nomes de recursos no Teams e no SharePoint no nome da sua solução

No nome da sua solução, não use recursos de correspondência de palavras no Microsoft Teams ou no SharePoint, como Bate-papo, Contatos, Calendário, Chamadas, Arquivos, Reunião, Atividades, Teams, Aplicativos, Ajuda, SharePoint, Listas, Página, etc., pois esses nomes podem ser confundidos com a funcionalidade padrão no Teams e no SharePoint.

Não use nomes de outros produtos da Microsoft no nome da sua solução

Sua solução será rejeitada se o nome contiver o nome de outro produto da Microsoft, como Outlook, Word, Calendário, Tarefas, Teams, Excel, PowerPoint, Visio, etc.

Sua solução não deve usar palavras-chave específicas do recurso Microsoft Teams ou SharePoint, como - Iniciar reunião, Fazer ligação, Carregar arquivo, Iniciar bate-papo, etc. Essas palavras-chave são usadas nos produtos da Microsoft e usá-las no seu aplicativo pode confundir os usuários. Se o seu aplicativo oferecer uma funcionalidade semelhante, inclua o nome do seu nome na ação, por exemplo: Inicie uma reunião no Zoom, Carregue arquivos no Dropbox, Inicie o bate-papo no Freshdesk, etc.

Nomear sua solução

Se a sua solução tiver o nome de uma palavra comum, como Pedidos, será necessário incluir o nome da empresa e diferenciá-lo claramente de outras soluções no Marketplace, por exemplo, Pedidos da Contoso. Onde Contoso se refere ao nome da empresa que envia a solução.

Certifique-se de que o arquivo de configuração do package-solution.json tenha uma entrada name compreensível e atualizada com base no formato acima, conforme mostrado no exemplo abaixo.

Não inclua publicidade adicional na descrição e nas capturas de tela do seu aplicativo

Verifique se a descrição, as capturas de tela, o texto e as imagens promocionais do seu aplicativo descrevem apenas o aplicativo e não contenham publicidade adicional.

Todas as propriedades expostas no painel de propriedades devem ser funcionais

As propriedades expostas no painel de propriedades da sua Web Part devem ser significativas. A alteração das suas configurações deve alterar claramente o comportamento da sua Web Part.

Verifique se o arquivo do pacote pode ser carregado no Catálogo de aplicativos sem erros

Verifique se o pacote da solução pode ser carregado no Catálogo de aplicativos no seu locatário sem erros.

Verifique se o aplicativo pode ser implantado sem erros

Verifique se o seu aplicativo pode ser instalado em um site específico, mas também pode ser implantado globalmente em todos os sites, sem erros.

Forneça justificativas para qualquer solicitação de API

Se seu aplicativo exigir acesso adicional à API (por exemplo, para se comunicar com o Microsoft Graph), solicite-o no manifesto da solução. Além disso, prepare a justificativa para o acesso API solicitado, pois poderemos solicitá-la ao revisar seu aplicativo.

O suporte aos usuários finais para injeção de scripts não é permitido

Sua solução não pode permitir que os usuários finais incorporem scripts arbitrários às páginas do SharePoint. Isto significa que não é permitido publicar no Repositório do SharePoint soluções que possibilitem cenários clássicos de editor de scripts ou editor de conteúdo no SharePoint.

Este modelo não é permitido através do Repositório do SharePoint, pois abre preocupações de segurança por parte dos habituais usuários finais que incorporam scripts no portal. Você somente pode fornecer este tipo de solução para clientes fora da loja hospedada pela Microsoft.

Todas as URLs exibidas na Web Part devem estar funcionando

Se sua Web Part mostrar URLs, elas deverão apontar para os recursos existentes e não levar a páginas inexistentes ou de erro.

O aplicativo não para de responder

Ao usar seu aplicativo, ele não deve parar de responder aos usuários. Se ele precisar realizar uma operação que possa demorar um pouco para ser concluída, ele comunicará isso ao usuário.

A solução foi concluída

Sua solução contém todas as funcionalidades anunciadas na descrição e nas capturas de tela?

A interface do usuário do aplicativo foi concluída

A primeira impressão que os usuários terão do seu aplicativo será observando a interface do usuário. Se não parecer elegante, se alguns elementos estiverem desalinhados, usar muitas fontes diferentes ou algum texto do espaço reservado não tiver sido substituído por seu valor final, isso pode dar a impressão de que seu aplicativo não foi concluído e que eles não deveriam usá-lo.

Dica

Para garantir uma integração perfeita com o SharePoint e o Teams, recomendamos que você use o Office UI Fabric, que é o idioma de design do Microsoft 365. Para obter mais informações, consulte a seção de design desta documentação.

O aplicativo não deve avisar os usuários sem interação explícita

Seu aplicativo não deve avisar os usuários sem interação explícita da parte deles.

Verifique se os navegadores não bloqueiam os pop-ups

Se seu aplicativo usa pop-ups, verifique se os navegadores com configurações padrão não os bloqueiam, interrompendo o fluxo do usuário.

Experiência correta no primeiro lançamento

Se possível, seu aplicativo deve funcionar quando iniciado pela primeira vez. Se for necessário configurar primeiro, comunique claramente as próximas etapas ao usuário. Se a configuração for complexa ou exigir informações adicionais, forneça instruções claras para ajudar os usuários a configurar seu aplicativo.

Teste de sincronização com o Teams

Se seu aplicativo contiver Web Parts expostas como guias do Teams ou aplicativos pessoais, verifique se eles podem ser implantados nas equipes usando a opção Sincronizar com o Teams no Catálogo de Aplicativos sem erros. Depois de sincronizar a configuração com o Teams, verifique se todas as Web Parts estão expostas no Catálogo de aplicativos do Teams, como o previsto, podem ser instaladas e funcionar como o esperado.

Verifique se links como Termos de serviço, Política de privacidade, Sobre, etc,. são válidos e apontam para as páginas corretas.

Adquira uma conta ou uma licença

Se sua solução exigir que os usuários adquiram uma conta ou uma licença, está claro como eles podem fazer isso e como podem usar as informações obtidas com seu aplicativo?

Nenhum conteúdo de demonstração se o teste gratuito estiver incluído na oferta

Se sua oferta inclui um teste gratuito do seu aplicativo, então ele não deve incluir nenhum conteúdo de demonstração.

Não inclua códigos mal-intencionados

Soluções que contenham código malicioso, link para sites maliciosos ou outros recursos ilegais terão sua publicação rejeitada no Marketplace.

Não inclua recursos vulneráveis

Verifique se o seu código não contém nenhuma vulnerabilidade. Se você estiver usando dependências de terceiros

Garanta que seu aplicativo não use recursos de forma excessiva

Ao testar seu aplicativo, verifique se ele não leva a um aumento notável ou sustentado do uso da CPU, se não consome muita memória e se não leva o navegador a ficar sem resposta. Em geral, seu aplicativo deve funcionar bem em um computador desktop comum com acesso à Internet. Além disso, seu aplicativo não deve demorar mais de 10 segundos para carregar.

As soluções direcionadas do Microsoft Teams precisarão ter escopo de locatário

As soluções da Estrutura do SharePoint destinadas a serem usadas também no Microsoft Teams precisarão ser direcionadas ao escopo de locatário. Essa configuração é controlada com o skipFeatureDeployment atributo no package-solution.json arquivo de configuração e a configuração deve ser true para qualquer solução que tenha componentes direcionados também ao Microsoft Teams.

Recomenda-se que as verificações a seguir sejam aprovadas. Embora uma verificação com erro nessa categoria não impeça a publicação do seu aplicativo no Marketplace, isso pode ter um impacto negativo na experiência do usuário final.

O ícone da Web Part deve ter 64x64px com plano de fundo transparente

Recomendamos que você use uma imagem de 64x64px com fundo transparente para o ícone da sua Web Part. Isso permitirá que ele seja exibido corretamente nos diferentes modos de interface do usuário no SharePoint.

Os logotipos do Microsoft Teams devem haver tamanhos de imagem corretos

Caso sua solução contenha componentes direcionados para o Microsoft Teams, espera-se que eles usem os tamanhos de imagem oficiais com base nas diretrizes do Microsoft Teams. A imagem da estrutura de tópicos deve ser 32x32px e ter uma imagem colorida de 192x192px.

A imagem de página inteira deve ser dimensionada corretamente

Se a solução contiver componentes que devem ser expostos como páginas de aplicativos de uma única parte, cada um desses componentes deve ter fullPageAppIconImageUrl atributo com uma imagem específica projetada para ser usada quando uma nova página é criada no Microsoft Office SharePoint Online. Essa imagem deve ser dimensionada em 193x158px.

A Web Part deve ter um título configurável no painel de propriedades

Recomendamos que todas as Web Parts tenham um título que descreva claramente as informações que ela apresenta. Os autores da página devem poder ajustar esse título através do painel de propriedades, para que, se a Web Part for configurável, o título possa descrever corretamente seu conteúdo.

Dica

Você pode adicionar facilmente um título configurável à sua Web Part usando o controle de Reações reutilizáveis WebPartTitle PnP.

Lidar adequadamente com temas diferentes

Seu aplicativo deve lidar adequadamente com temas de cores claras e escuras. Alternar entre os diferentes temas não deve afetar negativamente a usabilidade do seu aplicativo. Embora o suporte a temas não o impeça de publicar seu aplicativo no Marketplace, é recomendável apoiá-los para oferecer a melhor experiência ao usuário.

Dica

Para obter mais informações sobre o uso de temas no seu aplicativo, consulte o artigo Usar cores do tema no artigo de personalizações do SharePoint Framework.