Requisitos do conector de parceiro

Primeiro, é recomendável ler a visão geral para entender as vantagens e o nível de comprometimento exigido para publicar um conector. Se você quiser publicar um conector de parceiro, será necessário atender aos seguintes requisitos antes de solicitar a revisão.

Apps Script

  1. Conceda acesso para visualização do seu projeto do Apps Script a ambos os endereços a seguir:
  2. Crie uma implantação chamada Production e atualize a implantação Production para incluir a versão do código que você quer publicar.
  3. Se você tiver atualizado seu código depois de implantar Production, verifique se a versão correta dele foi selecionada na implantação antes de enviar o conector.

Manifesto

Você precisa incluir os seguintes itens no manifesto do seu conector. Para mais informações sobre cada propriedade, consulte a referência dos manifestos.

  1. Na description, inclua todas as informações e instruções necessárias para que os usuários tenham um conhecimento básico sobre o conector e como usá-lo. Os conectores com descrições vagas e incompletas são rejeitados durante a revisão.
  2. É recomendável manter addOnUrl como uma página hospedada dedicada sobre seu conector, preferencialmente hospedada no seu próprio domínio.
    • Essa página precisa conter ou direcionar à Política de Privacidade e aos Termos de Uso hospedados no mesmo domínio de addOnUrl.
    • Esta página deve conter todos os detalhes que o usuário precisa saber para usar seu conector.
    • Caso os usuários precisem se inscrever em uma conta para usar seu conector, o link de inscrição precisará ser disponibilizado nessa página,
    • que não pode ser hospedada em https://sites.google.com/.
    • Veja exemplos de páginas de parceiros existentes: Funnel, Supermetrics e CallRail.
  3. É recomendável manter supportUrl como uma página hospedada onde os usuários possam receber suporte para seu conector. Ele não pode ser um link de e-mail ou mailto.
  4. Você precisa preencher a propriedade sources com todas as fontes conectadas ao seu conector. Consulte a referência Fontes no manifesto para mais detalhes.
    • Para ver a lista de fontes, consulte nosso repositório de registro de dados. Se você estiver tentando se conectar a uma fonte que não existe no repositório, envie uma solicitação de envio ao repositório de registro de dados para incluí-la. Caso as fontes do seu manifesto não existam no repositório, seu conector será reprovado no processo de revisão.
    • Estes são metadados adicionais do conector que serão indexados para o recurso de pesquisa da galeria. Seu conector será exibido nos resultados da pesquisa quando os usuários pesquisarem uma fonte de dados específica na galeria.
    • A galeria oferece uma interface Conectores por fontes de dados para que os usuários descubram conectores por fontes.
  5. É recomendável limitar os endpoints chamados pelo UrlFetchApp do seu conector somente ao número necessário para que o recurso funcione. Adicione a propriedade urlFetchWhitelist ao nível raiz do seu manifesto. Veja a referência de urlFetchWhitelist para mais informações.
    • Essa propriedade precisa conter todos os URLs a que o conector se conecta usando a chamada de UrlFetchApp.
    • Se o conector não executar uma chamada deUrlFetchApp, defina o valor da propriedade como [] de lista vazia.
    • Se ele não se conectar a um domínio fixo ou o prefixo do endpoint variar, omita a propriedade urlFetchWhitelist no manifesto.
  6. O manifesto precisa conter valores para shortDescription, authType, feeType, privacyPolicyUrl e termsOfServiceUrl.
  7. É necessário que o conector name demonstre claramente a própria função. Isso esclarece o objetivo dele e ajuda o usuário a identificar a opção ideal.

Modelo e relatório

  1. Caso seu conector tenha um esquema fixo, crie um modelo de relatório para ele e adicione-o ao manifesto. Ative a opção "Compartilhamento por link" para o relatório.
  2. Crie pelo menos um relatório de demonstração usando seu conector e envie-o para a galeria do Data Studio. Pode ser uma réplica do seu relatório de modelo ou um relatório separado que descreve um número ainda maior de funcionalidades do seu conector.
    • Ao adicionar relatórios de demonstração, você qualifica seu conector para oportunidades promocionais (destaque, menções em newsletters e postagens de blogs, estudos de caso etc.).

Conector

  1. Se o usuário precisar de uma conta para usar o conector, inclua instruções para a criação dela na description ou no link addOnUrl.
  2. Seu conector não pode estar incompleto ou em fase Beta. É necessário publicar um conector completo e funcional. Você sempre pode atualizar seu conector, mas a implantação na produção liberada para os usuários precisa ser testada e o recurso precisa estar completo.
  3. Crie mensagens de erro claras e acionáveis para exibição aos usuários no caso de um erro interno do conector. Isso inclui os casos em que um usuário insere uma entrada inválida/em branco na configuração.
  4. Os links shortDescription, description, addOnUrl e supportUrl e a página do OAuth do seu conector (se aplicável) não podem ter erros ortográficos e gramaticais.
  5. Use o método de autenticação apropriado em getAuthType(). Não solicite credenciais com getConfig().
  6. Conclua o processo de verificação do cliente OAuth. Isso é obrigatório para todos os conectores, independentemente do método de autenticação em getAuthType(). Uma equipe dedicada cuida desse procedimento. Para mais informações, consulte as perguntas frequentes sobre a verificação da API OAuth. Se você não concluir esse processo, seu conector não será publicado.
    • Durante o processo de verificação do OAuth, adicione os escopos do OAuth necessários do seu conector ao configurar a tela de consentimento. Se você não incluir todos eles, o processo mencionado poderá ser aprovado, mas seu conector ainda mostrará a tela Aplicativo não verificado. Isso fará com que o processo de verificação do conector de parceiro falhe.
      Autorize e teste seu conector usando uma nova conta após concluir o processo de verificação do OAuth para que a tela Aplicativo não verificado não seja exibida aos usuários.
  7. Verifique se você está em conformidade com os Termos de Serviço das galerias do Data Studio (remetente).

Quando você cumprir todos os requisitos, clique no botão a seguir para solicitar uma revisão do conector:

Publicar um conector de parceiro