Referência do manifesto

O manifesto (appsscript.json) é um arquivo JSON no seu projeto do conector do Apps Script. Ele contém informações sobre seu conector da comunidade, que são necessárias para implantar e usar o conector no Data Studio. Leia mais sobre os manifestos do Apps Script.

Seu manifesto precisa conter as seguintes informações:

Nome da propriedade Tipo Descrição
Obrigatório (dependentes da propriedade datastudio)
name string Nome do seu conector.
Limitado a 28 caracteres.
company string Nome da organização ou do desenvolvedor.
companyUrl string (link) Link para o site da organização ou do desenvolvedor.
logoUrl string (image link) URL para um ícone do seu conector.
As dimensões necessárias são 40 px x 40 px.
addOnUrl string (link) Link para uma página dedicada "Saiba mais" que explica o que seu conector faz e os dados que ele acessa. Você deve hospedar e manter esta página.
A página precisa conter ou estar vinculada aos seus Termos de Serviço e à Política de Privacidade.
supportUrl string (link) Link para a página de suporte desse conector. Por meio deste link, os usuários conseguirão informar problemas com seu conector. Você deve hospedar e manter esta página.
description string Descrição do seu conector.
Os usuários verão a descrição completa na página de configurações do conector. Os links serão clicáveis.
Opcional (dependentes da propriedade datastudio)
shortDescription string Limite: 114 caracteres. Se seu conector for publicado, esta breve descrição ficará visível no cartão de galeria dele. Use-a para explicar resumidamente as funções do conector. Os usuários poderão ver essa descrição quando navegarem pelos conectores da galeria.
privacyPolicyUrl string (link) Link para a Política de Privacidade da organização do conector / desenvolvedor.
termsOfServiceUrl string (link) Link para os Termos de Serviço da organização do conector / desenvolvedor.
authType list(AuthType) Tipo de método de autenticação do conector. Veja a seção AuthType abaixo.
feeType list(FeeType) Indica o tipo de tarifa do conector. Veja a seção FeeType abaixo.
sources list(Sources) Lista das fontes de dados a que o conector pode se conectar. Veja a seção Fontes abaixo.
templates Object Lista dos modelos que podem ser usados com esse conector. Somente um modelo padrão é aceito, identificado pela configuração de uma chave default. O valor precisa ser o código do relatório do Data Studio que será usado como modelo. Consulte o guia no artigo Fornecimento de modelos de relatório.
forceViewersCredentials boolean Define se as credenciais do visualizador podem ou não ser forçadas para as fontes de dados criadas com esse conector. Essa propriedade é opcional, e o padrão é false. Consulte o artigo Credenciais da fonte de dados para mais detalhes sobre as credenciais do visualizador.
useQueryConfig boolean Indica se esse conector retornará uma configuração de consulta para "getData()". Veja o artigo Serviços avançados.
Opcional (propriedade no nível raiz)
urlFetchWhitelist list(string) Lista de prefixos de URL HTTPS usados pelo conector. Os endpoints de todos os URL buscados precisam corresponder a um dos prefixos dessa lista. Isso ajuda a proteger os dados do usuário. Consulte o artigo Como autorizar URLs para mais detalhes.

AuthType

Os valores para o tipo de método de autenticação podem ser um dos seguintes:

Valor de enum Descrição
NONE Indica que a autenticação não é necessária para o conector.
OAUTH2 Indica que o conector usa o OAuth 2.0 para autenticação.
KEY Indica que o conector usa a chave de API para autenticação.
USER_PASS Indica que o conector utiliza o nome de usuário/senha para autenticação.
USER_TOKEN Indica que o conector utiliza o nome de usuário/token para autenticação.

FeeType

Os valores do tipo de tarifa podem ser os seguintes:

Valor de enum Descrição
FREE Indica que o uso do conector é totalmente gratuito.
FREE_TRIAL Indica que o conector tem uma opção de teste gratuita.
PAID Indica que o usuário precisa pagar pelo uso do conector.

Fontes

Nas fontes, há uma relação de enums. 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. O nome da fonte pode conter apenas letras maiúsculas e sublinhados (por exemplo, o Google Analytics será GOOGLE_ANALYTICS). No manifesto do conector da comunidade, use o valor da propriedade "id" da fonte de dados, como GOOGLE_ANALYTICS.

Exemplo de manifesto para um conector da comunidade

Veja a seguir o exemplo de um manifesto completo:

data-studio/appsscript.json
{
      "dataStudio": {
        "name": "Nucleus by Hooli",
        "company": "Hooli Inc.",
        "companyUrl": "https://hooli.xyz",
        "logoUrl": "https://hooli.xyz/middle-out-optimized/nucleus/logo.png",
        "addonUrl": "https://hooli.xyz/data-studio-connector",
        "supportUrl": "https://hooli.xyz/data-studio-connector/support",
        "description": "Nucleus by Hooli connector lets you connect to your data in Data Studio using Nucleus middle out optimization. You will need an account on hooli.xyz to use this connector. Create your account at https://hooli.xyz/signup",
        "shortDescription": "Connect to your data using Nucleus middle out optimization",
        "privacyPolicyUrl": "https://hooli.xyz/privacy",
        "termsOfServiceUrl": "https://hooli.xyz/tos",
        "authType": ["NONE"],
        "feeType": ["PAID"],
        "sources": ["HOOLI_CHAT_LOG", "ENDFRAME_SERVER_STREAM", "RETINABYTE_USER_ANALYTICS"],
        "templates": {
          "default": "872223s89f5fdkjnd983kjf"
        }
      },
      "urlFetchWhitelist": [
        "https://api.hooli.xyz/",
        "https://hooli.xyz/"
      ]
    }