El manifiesto (appsscript.json) es un archivo JSON en tu proyecto del conector de Apps Script. Contiene cierta información sobre el conector de la comunidad que se requiere para implementar y usar el conector en Looker Studio. Obtén 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
|
El nombre del conector. Límite de 28 caracteres |
company
|
string
|
Es el nombre de la organización o el 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. Las dimensiones requeridas son 40 por 40 píxeles. |
addOnUrl
|
string (link)
|
Vínculo a una página dedicada de “Más información” que debería explicar para qué sirve tu conector y los datos a los que accede. Debes alojar y mantener esta página. Esta página debe contener tus Condiciones del Servicio y Política de Privacidad, o un vínculo a ellas. |
supportUrl
|
string (link)
|
Vínculo a la página de asistencia para admitir este conector. Los usuarios deberían poder informar los problemas con el conector en este vínculo. Debes alojar y mantener esta página. |
description
|
string
|
La descripción del conector. Los usuarios verán la descripción completa en la página de configuración del conector. 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 será visible en la tarjeta de la galería de tu conector. Utilízalo para describir brevemente lo que hace el conector. Los usuarios podrán ver esto cuando naveguen por los conectores de la galería. |
privacyPolicyUrl
|
string (link)
|
Vínculo a la Política de Privacidad de la organización del conector o los desarrolladores. |
termsOfServiceUrl
|
string (link)
|
Vínculo a las Condiciones del Servicio de la organización de conectores o desarrolladores. |
authType
|
list(AuthType)
|
El tipo de método de autenticación para el conector. Consulta AuthType a continuación. |
feeType
|
list(FeeType)
|
Indica el tipo de tarifa de su conector. Consulta FeeType más abajo. |
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 se admite una plantilla predeterminada, que se identifica mediante la configuración de una clave default. El valor debe ser el ID del informe de Looker Studio que se usará como plantilla. Consulta la guía sobre cómo proporcionar plantillas de informes.
|
forceViewersCredentials
|
boolean
|
Define si las credenciales del visualizador se deben forzar o no para las fuentes de datos creadas a partir de este conector. Esta propiedad es opcional y el valor predeterminado es false. Consulta Credenciales de la fuente de datos para obtener más detalles sobre las credenciales de lector.
|
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
|
Si este conector mostrará o no una configuración de consulta para `getData()`. Consulta los servicios avanzados. |
advancedServices.schema
|
boolean
|
Si este conector mostrará o no una configuración de consulta para `getSchema()`. Consulta los servicios avanzados. |
| 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 recuperado debe coincidir con uno de los prefijos de esta lista. Esto puede ayudar a proteger los datos del usuario. Consulta Cómo agregar una URL de lista segura para obtener más detalles. |
AuthType
Los valores para el tipo de método de autenticación pueden ser uno de los siguientes:
| Valor enum | Descripción |
|---|---|
NONE
|
Indica que no se requiere autenticación para el 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 el nombre de usuario o el token. |
PATH_USER_PASS |
Indica que el conector usa una ruta de acceso/nombre de usuario/contraseña. |
PATH_KEY |
Indica que el conector usa una ruta o clave. |
FeeType
Los valores del tipo de tarifa pueden ser cualquiera de los siguientes:
| Valor 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 enumeraciones para las fuentes. Puedes ver la lista existente de fuentes 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 repositorio de Data Registry para agregar la fuente. El nombre de la fuente solo puede contener caracteres en mayúsculas y guiones bajos (p.ej., Google Analytics será GOOGLE_ANALYTICS). En tu manifiesto de Community Connector, usa el valor de la propiedad del ID de la fuente de datos, p.ej., GOOGLE_ANALYTICS.
Ejemplo de manifiesto para un conector de comunidad
El siguiente es un ejemplo de un manifiesto completo: