El manifiesto (appsscript.json) es un archivo JSON en tu proyecto del conector de Apps Script. Contiene cierta información sobre tu conector de comunidad que se requiere para implementarlo y usarlo en Looker Studio. Obtén más información sobre los manifiestos en 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. Límite de 28 caracteres |
company
|
string
|
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)
|
Es la URL de un ícono para tu conector. Las dimensiones requeridas son 40 px por 40 px. |
addOnUrl
|
string (link)
|
Vínculo a una página dedicada de "Más información" que explique qué hace tu conector y a qué datos accede. Debes alojar y mantener esta página. Esta página debe contener un vínculo a tus Condiciones del Servicio y Política de Privacidad. |
supportUrl
|
string (link)
|
Vínculo a la página de asistencia para este conector Los usuarios deben poder informar problemas con tu conector en este vínculo. Debes alojar y mantener esta página. |
description
|
string
|
Es 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 se publica tu conector, esta descripción breve se mostrará en la tarjeta de la galería del conector. Úsala para describir brevemente lo que hace tu conector. Los usuarios podrán ver esta información cuando naveguen por los conectores en la galería. |
privacyPolicyUrl
|
string (link)
|
Vínculo a la Política de Privacidad del conector o la organización del desarrollador |
termsOfServiceUrl
|
string (link)
|
Vínculo a las Condiciones del Servicio del conector o la organización del desarrollador. |
authType
|
list(AuthType)
|
Es el tipo de método de autenticación de tu conector. Consulta AuthType a continuación. |
feeType
|
list(FeeType)
|
Indica el tipo de comisión de tu conector. Consulta FeeType a continuación. |
sources
|
list(Sources)
|
Es la lista de fuentes de datos a las que se puede conectar este conector. Consulta Fuentes a continuación. |
templates
|
Object
|
Es la lista de plantillas que se pueden usar con este conector. Solo se admite una plantilla predeterminada, que se identifica configurando 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
|
Indica si se deben forzar las credenciales del usuario 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 del usuario.
|
useQueryConfig
|
boolean
|
OBSOLETO: Indica si este conector devolverá o no una configuración de consulta para `getData()`. En su lugar, usa `advancedServices`. |
advancedServices.data
|
boolean
|
Indica si este conector devolverá una configuración de consulta para `getData()`. Consulta los servicios avanzados. |
advancedServices.schema
|
boolean
|
Indica si este conector devolverá una configuración de consulta para `getSchema()`. Consulta los servicios avanzados. |
| Opcional (propiedad de nivel raíz) | ||
urlFetchWhitelist
|
list(string)
|
Es una lista de 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 incluir URLs en la lista de entidades permitidas para obtener más detalles. |
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 conector. |
OAUTH2 |
Indica que el conector usa OAuth 2.0. |
KEY |
Indica que el conector usa una clave de API. |
USER_PASS |
Indica que el conector usa un nombre de usuario y una contraseña. |
USER_TOKEN |
Indica que el conector usa nombre de usuario o token. |
PATH_USER_PASS |
Indica que el conector usa la ruta de acceso, el nombre de usuario y la contraseña. |
PATH_KEY |
Indica que el conector usa la ruta de acceso o la clave. |
FeeType
Los valores del tipo de comisión 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 enumeraciones para las fuentes. Puedes ver la lista existente de fuentes en nuestro repositorio del 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 del Registro de datos para agregarla. El nombre de la fuente solo puede contener caracteres en mayúsculas y guiones bajos (p.ej., Google Analytics será GOOGLE_ANALYTICS). En el manifiesto de tu conector de comunidad, usa el valor de la propiedad del ID de la fuente de datos, p.ej., GOOGLE_ANALYTICS.
Ejemplo de manifiesto para un conector comunitario
A continuación, se muestra un ejemplo de un manifiesto completado: