Los pasos para crear un conector de comunidad son los siguientes:
- Crea un nuevo proyecto de Apps Script.
- Escribe el código del conector.
- Completa el manifiesto del proyecto.
Cree un nuevo proyecto de Apps Script
Visita Google Apps Script para crear un proyecto nuevo. Apps Script creará una secuencia de comandos predeterminada por ti. Puedes quitar la función myFunction
y cambiarle el nombre al proyecto. (Más información sobre Apps Script)
Escribe el código del conector
Cada conector debe tener definido un conjunto específico de funciones. La aplicación de hosting (p.ej., Looker Studio) ejecutará estas funciones. Se espera que tu conector maneje las solicitudes entrantes y responda como se describe en la referencia de la API de Community Connector. Si tienes problemas mientras desarrollas tu código, lee la guía de depuración para obtener ayuda.
Define el tipo de autenticación en getAuthType()
Se llama a esta función para identificar el método de autenticación que se usa para el servicio de terceros. Para obtener más información, consulta la referencia de getAuthType(). Los métodos de autenticación admitidos actualmente se enumeran en la referencia de AuthType
.
Por ejemplo, el siguiente conector no requiere autenticación:
Si tu fuente de datos requiere autenticación OAuth 2.0, consulta la guía de autenticación de OAuth 2.0 y agrega las funciones adicionales requeridas al conector.
Define la configuración mediante getConfig()
Se llama a la función getConfig()
para obtener la configuración del conector, incluidos los valores proporcionados por el usuario que requiere el conector. Para obtener más información, consulta la referencia de getConfig()
.
En función de la respuesta que proporcione getConfig()
, Looker Studio renderizará la
pantalla de configuración del conector. Los elementos de configuración admitidos se enumeran en la referencia de ConfigType
.
Si tu fuente de datos requiere la fecha como parámetro, llama a config.setDateRangeRequired(true). Si necesitas hacer preguntas de configuración condicional o dinámica, consulta la configuración escalonada.
El siguiente es un ejemplo de un conector que requiere que el usuario ingrese un código de nombre de paquete de npm. En la función getConfig()
, se definen una información y un campo de entrada:
Cómo definir los campos con getSchema()
Se llama a esta función a fin de obtener el esquema para la solicitud determinada. Cualquier parámetro de configuración definido por la función getConfig()
se proporcionará en el argumento request
. Para obtener más información, consulta la referencia de getSchema()
.
Según la fuente de datos de tu conector y la configuración que proporcione el usuario, el esquema puede quedar fijo o es posible que debas proporcionarlo de forma dinámica en el momento de la solicitud.
Por ejemplo, si un conector recupera datos de informe en función de un ID de informe, es posible que los datos que se muestran para ese informe y, por lo tanto, el esquema no se conozcan de antemano.
En este caso, getSchema()
puede requerir una recuperación de datos, y se deberá calcular el esquema.
Recupera y muestra datos con getData()
Se llama a esta función para obtener los datos de la solicitud dada. Todos los parámetros de configuración definidos por la función getConfig()
se proporcionarán en el argumento request
. Para obtener más información, consulta la referencia de getData()
.
Los siguientes parámetros de la solicitud getData()
requieren atención adicional:
lastRefresh
lastRefresh
representa una marca de tiempo que indica la hora de la solicitud más reciente para una actualización de datos. Deberías poder analizar el valor connew Date(timestampString)
. Si usas el servicio de caché de Apps Script o cualquier otro método de almacenamiento en caché, la marca de tiempolastRefresh
puede ayudarte a determinar si debes realizar una nueva solicitud de recuperación a la fuente de datos o entregar datos desde la caché.dateRange
SidateRangeRequired
se configura comotrue
engetConfig()
, cada llamadagetData()
contendrá el período seleccionado en la solicitud. Consulta Cómo trabajar con períodos para obtener más detalles.
En el siguiente ejemplo, se recuperan datos según la solicitud entrante y se muestran las estadísticas del paquete:
Completa el manifiesto del proyecto
El archivo de manifiesto contiene información sobre el conector de la comunidad que se requiere para implementar y usar el conector en Looker Studio.
Para editar el archivo de manifiesto en el entorno de desarrollo de Apps Script, haz clic en el menú Ver y, luego, en Mostrar archivo de manifiesto. Se creará un nuevo archivo de manifiesto appsscript.json
.
Actualiza el manifiesto para incluir los siguientes datos:
Para obtener detalles sobre el manifiesto de Looker Studio, consulta la referencia del manifiesto.
Próximos pasos
El siguiente paso será implementar el conector de la comunidad.