Referencia del manifiesto

El manifiesto (appsscript.json) es un archivo JSON en tu conector de Apps Script en un proyecto final. Contiene cierta información sobre tu Community Connector necesario para implementar y usar tu conector en Looker Studio. Más información sobre los manifiestos en Apps Script.

Tu manifiesto debe contener la siguiente información:

nombre de la propiedad Tipo Descripción
Obligatorio (en la propiedad dataStudio)
name string Nombre de tu conector.
Límite de 28 caracteres
company string Es el nombre de la organización o del desarrollador.
companyUrl string (link) Vínculo al sitio web de la organización o el desarrollador
logoUrl string (image link) La URL de un ícono para el conector.
Debe tener una dimensión de 40 x 40 píxeles.
addOnUrl string (link) Vínculo a “Más información” dedicado que debe explicar cuáles son y los datos a los que accede. Debes alojar y mantener este .
Esta página debe contener las Condiciones del Servicio y la Privacidad o un vínculo a ellas. Política.
supportUrl string (link) Vínculo a la página de asistencia para admitir este conector. Usuarios debería poder informar problemas con el conector a través de este vínculo. Tú debe alojar y mantener esta página.
description string La descripción del conector.
Los usuarios verán la descripción completa en tu conector página de configuración. Se podrá hacer clic en los vínculos.
Opcional (en la propiedad dataStudio)
shortDescription string Límite: 114 caracteres. Si tu conector está publicado, esta descripción breve aparecerá en la tarjeta de la galería de tu o del conector. Úsalo para describir brevemente lo que hace tu conector. Usuarios podrán ver esto cuando exploren los conectores del galería.
privacyPolicyUrl string (link) Vínculo a la Política de Privacidad de la organización de conectores o desarrolladores.
termsOfServiceUrl string (link) Vínculo a las Condiciones del Servicio de la organización de conectores o desarrolladores.
authType list(AuthType) Tipo de método de autenticación para el conector. Consulta AuthType a continuación.
feeType list(FeeType) Indica el tipo de tarifa por su conector. Consulta FeeType a continuación.
sources list(Sources) La lista de fuentes de datos a las que se puede conectar este conector. Consulta Fuentes a continuación.
templates Object Lista de plantillas que se pueden usar con este conector. Solo una opción predeterminada o una plantilla compatible y se identifica mediante la configuración Tecla default. El valor debe ser el ID de informe de Looker Informe de Studio que se usará como plantilla. Consulta la guía sobre Proporcionar plantillas de informes.
forceViewersCredentials boolean Indica si se deben forzar o no las credenciales del lector para las fuentes de datos creado desde este conector. Esta propiedad es opcional y se establece de forma predeterminada como false Ver Datos credenciales de origen para obtener más detalles sobre las credenciales de visualizador.
useQueryConfig boolean OBSOLETO: Indica si este conector mostrará o no una configuración de consulta para `getData()`. En su lugar, usa `advancedServices`.
advancedServices.data boolean Indica si este conector devolverá o no una configuración de consulta para `getData()`. Ver avanzado Google Cloud.
advancedServices.schema boolean Indica si este conector devolverá o no una configuración de consulta para `getSchema()`. Ver avanzado Google Cloud.
Opcional (propiedad de nivel raíz)
urlFetchWhitelist list(string) Una lista de los prefijos de URL HTTPS que usa tu conector. Cualquier extremo de URL recuperados debe coincidir con uno de los prefijos de esta lista. Esto puede ayudar a proteger los datos del usuario. Consulta Lista segura URLs para obtener más información.

AuthType

Los valores del tipo de método de autenticación pueden ser uno de los siguientes:

Valor de enum Descripción
NONE Indica que no se requiere autenticación para el o del conector.
OAUTH2 Indica que el conector usa OAuth 2.0.
KEY Indica que el conector usa la clave de API.
USER_PASS Indica que el conector usa un nombre de usuario y contraseña.
USER_TOKEN Indica que el conector usa un nombre de usuario o token.
PATH_USER_PASS Indica que el conector utiliza ruta de acceso/nombre de usuario/contraseña.
PATH_KEY Indica que el conector usa una ruta/clave.

FeeType

Los valores para el tipo de tarifa pueden ser cualquiera de los siguientes:

Valor de enum Descripción
FREE Indica que el conector es completamente 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.

Fuentes

Sources es una lista de enums para las fuentes. Puedes ver la lista existente de en nuestro repositorio de registro de datos. Si la fuente a la que te conectas no existe en el repositorio, envía una solicitud de extracción al registro de datos Repository para agregar la fuente. El nombre de la fuente solo puede contener mayúsculas caracteres y guiones bajos (p.ej., Google Analytics será GOOGLE_ANALYTICS). En el manifiesto del Conector de la comunidad, usa el valor del ID de la fuente de datos. propiedad, p.ej., GOOGLE_ANALYTICS

Ejemplo de manifiesto para un Conector de la comunidad

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