Referencia del archivo de manifiesto

El archivo de manifiesto (appsscript.json) es un archivo JSON que se incluye en el proyecto de tu conector de Apps Script. Contiene información sobre el conector comunitario, necesaria para poder implementar y usar el conector en Data Studio. Obtén más información sobre los manifiestos de Apps Script.

El manifiesto debe contener la siguiente información:

Nombre de la propiedad Tipo Descripción
Obligatorio (en la propiedad datastudio)
name string Nombre del conector
(28 caracteres como máximo)
company string Nombre de la organización o del desarrollador.
companyUrl string (link) Enlace al sitio web de la organización o del desarrollador.
logoUrl string (image link) URL del icono del conector.
Las dimensiones obligatorias son 40x40 píxeles.
addOnUrl string (link) Enlace a una página de tipo "Más información" donde se explique el objetivo del conector y los datos a los que permite acceder. Debes alojar y mantener esta página.
Además, la página debe incluir las condiciones de servicio y la política de privacidad del conector o enlazar a esta información.
supportUrl string (link) Enlace a la página de asistencia de este conector para que los usuarios informen de posibles problemas. Debes alojar y mantener esta página.
description string Descripción del conector.
La descripción completa aparecerá en la página de configuración del conector. Se podrá hacer clic en los enlaces.
Opcional (en la propiedad datastudio)
shortDescription string Límite: 114 caracteres. Si se publica tu conector, esta breve descripción se mostrará en la tarjeta de la galería del conector. Úsala para describir brevemente lo que hace tu conector. Los usuarios podrán leerla cuando consulten los conectores de la galería.
privacyPolicyUrl string (link) Enlace a la política de privacidad del conector o de la organización que lo programó.
termsOfServiceUrl string (link) Enlace a los Términos del Servicio del conector o de la organización que lo programó.
authType list(AuthType) Tipo de método de autenticación del conector. Consulta AuthType más abajo.
feeType list(FeeType) Indica el tipo de tarifa del conector. Consulta FeeType más abajo.
sources list(Sources) Lista con las fuentes de datos a las que se puede conectar el conector. Consulta Sources más abajo.
templates Object Lista de plantillas que se pueden usar con el conector. Solo se admite una plantilla predeterminada, que se identifica mediante la clave default. El valor debería ser el ID del informe de Data Studio que se usará como plantilla. Consulta la guía sobre proporcionar plantillas de informes.
forceViewersCredentials boolean Indica si las credenciales del usuario se deben forzar o no en las fuentes de datos creadas desde este conector. Esta propiedad es opcional y su valor predeterminado es false. Consulta Credenciales de la fuente de datos para obtener más detalles sobre las credenciales del usuario.
useQueryConfig boolean Indica si este conector devolverá o no una configuración de consulta de "getData()". Consulta el artículo sobre Advanced Services.
Opcional (propiedad de nivel raíz)
urlFetchWhitelist list(string) Una lista con los prefijos de HTTPS URL que utiliza tu conector. Todos los puntos de conexión de URL obtenidos deben coincidir con uno de los prefijos de esta lista. De esta forma, se pueden proteger los datos de los usuarios. Consulta más información en la sección sobre la inclusión de URLs en la lista blanca.

AuthType

El valor del tipo de método de autenticación puede ser uno de los que se indican a continuación:

Valor de enumeración Descripción
NONE Indica que no es obligatorio autenticar el conector.
OAUTH2 Indica que el conector usa OAuth 2.0 como método de autenticación.
KEY Indica que el conector usa la clave de API como método de autenticación.
USER_PASS Indica que el conector usa un nombre de usuario y una contraseña como método de autenticación.
USER_TOKEN Indica que el conector usa un nombre de usuario y un token como método de autenticación.

FeeType

El tipo de tarifa puede tener cualquiera de los siguientes valores:

Valor de enumeración Descripción
FREE Indica que el conector es totalmente gratuito.
FREE_TRIAL Indica que el conector tiene una opción de prueba gratuita.
PAID Indica que el usuario deberá pagar para usar el conector.

Sources

Sources es una lista con fuentes. Puedes ver la lista de fuentes en nuestro repositorio de registro de datos. Si la fuente a la que te conectas no está en el repositorio, envía una solicitud de obtención al repositorio de registro de datos para añadir la fuente. El nombre de la fuente solo puede contener caracteres en mayúsculas y guiones bajos (por ejemplo, Google Analytics sería GOOGLE_ANALYTICS). En el archivo de manifiesto del conector comunitario, usa el valor de la propiedad de identificación de la fuente de datos (por ejemplo, GOOGLE_ANALYTICS).

Ejemplo de manifiesto de un conector de la comunidad

Este es un ejemplo de manifiesto 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/"
      ]
    }