Ecco i passaggi per creare un connettore della community:
- Creare un nuovo progetto Apps Script.
- Scrivi il codice del connettore.
- Completa il manifest del progetto.
Crea un nuovo progetto Apps Script
Visita Google Apps Script per creare un nuovo progetto. Apps Script creerà uno script predefinito per te. Puoi rimuovere la funzione myFunction
e rinominare il progetto. Scopri di più su Apps Script.
Scrivi il codice del connettore
Per ogni connettore deve essere definito un insieme specifico di funzioni. L'applicazione di hosting (ad es. Looker Studio) eseguirà queste funzioni. Il connettore dovrebbe gestire le richieste in entrata e rispondere come descritto nel riferimento per l'API Community Connector. Se riscontri problemi durante lo sviluppo del codice, leggi la guida al debug per ricevere assistenza.
Definisci il tipo di autenticazione in getAuthType()
Questa funzione viene chiamata per identificare il metodo di autenticazione utilizzato per il servizio di terze parti. Consulta il riferimento getAuthType() per i dettagli. I metodi di autenticazione attualmente supportati sono elencati nella documentazione di riferimento AuthType
.
Ad esempio, il seguente connettore non richiede l'autenticazione:
Se l'origine dati richiede l'autenticazione OAuth 2.0, consulta la guida all'autenticazione OAuth 2.0 e aggiungi le funzioni aggiuntive necessarie al connettore.
Definisci la configurazione tramite getConfig()
La funzione getConfig()
viene richiamata per ottenere la configurazione del connettore, inclusi i valori forniti dall'utente richiesti dal connettore. Per informazioni dettagliate, consulta il riferimento getConfig()
.
In base alla risposta fornita da getConfig()
, Looker Studio mostrerà la schermata di configurazione del connettore. Gli elementi di configurazione supportati sono elencati
nel riferimento ConfigType
.
Se l'origine dati richiede la data come parametro, chiama config.setDateRangeRequired(true). Se devi porre domande sulla configurazione condizionale o dinamica, consulta la sezione relativa alla configurazione con passaggi.
Di seguito è riportato un esempio di connettore che richiede all'utente di inserire un codice del nome del pacchetto npm. Un campo informazioni e un campo di immissione sono definiti nella funzione getConfig()
:
Definisci i campi con getSchema()
Questa funzione viene chiamata per ottenere lo schema per la richiesta specificata. Eventuali
parametri di configurazione definiti dalla funzione getConfig()
verranno forniti
nell'argomento request
. Per informazioni dettagliate, vedi il riferimento getSchema()
.
A seconda dell'origine dati del connettore e della configurazione fornita dall'utente, lo schema potrebbe essere corretto o potrebbe essere necessario fornirlo dinamicamente al momento della richiesta.
Ad esempio, se un connettore recupera i dati del report in base a un ID report, i dati restituiti per il report e, di conseguenza, lo schema potrebbero non essere noti in anticipo.
In questo caso, getSchema()
potrebbe richiedere un recupero dei dati e dovrà essere calcolato lo schema.
Recupera e restituisce dati con getData()
Questa funzione viene chiamata per ottenere i dati per la richiesta specificata. Eventuali parametri di configurazione definiti dalla funzione getConfig()
verranno forniti nell'argomento request
. Per informazioni dettagliate, vedi il riferimento getData()
.
I seguenti parametri della richiesta getData()
richiedono ulteriore attenzione:
lastRefresh
lastRefresh
rappresenta un timestamp che contrassegna l'ora della richiesta di aggiornamento dei dati più recente. Dovresti poter analizzare il valore connew Date(timestampString)
. Se utilizzi il servizio di cache di Apps Script o qualsiasi altro metodo di memorizzazione nella cache, il timestamplastRefresh
può aiutarti a determinare se effettuare una nuova richiesta di recupero all'origine dati o fornire i dati dalla cache.dateRange
SedateRangeRequired
è impostato sutrue
ingetConfig()
, ogni chiamatagetData()
conterrà l'intervallo di date selezionato nella richiesta. Per ulteriori dettagli, consulta Utilizzo degli intervalli di date.
L'esempio seguente recupera i dati in base alla richiesta in entrata e restituisce le statistiche del pacchetto:
Completa il manifest del progetto
Il file manifest contiene informazioni sul connettore della community, necessarie per implementare e utilizzare il connettore in Looker Studio.
Per modificare il file manifest nell'ambiente di sviluppo di Apps Script, fai clic sul menu Visualizza, quindi su Mostra file manifest. Verrà creato un nuovo file manifest appsscript.json
.
Aggiorna il file manifest in modo da includere i seguenti dati:
Per maggiori dettagli sul file manifest di Looker Studio, consulta l'articolo di riferimento sul file manifest.
Passaggi successivi
Il prossimo passaggio sarà implementare il connettore della community.