Pour créer un connecteur de communauté, procédez comme suit:
- Créez un projet Apps Script.
- Écrivez le code du connecteur.
- Remplissez le fichier manifeste du projet.
Créer un projet Apps Script
Accédez à Google Apps Script pour créer un projet. Apps Script crée un script par défaut pour vous. N'hésitez pas à supprimer la fonction myFunction
et à renommer le projet. En savoir plus sur Apps Script
Écrire le code du connecteur
Un ensemble spécifique de fonctions doit être défini pour chaque connecteur. L'application d'hébergement (par exemple, Looker Studio) exécute ces fonctions. Votre connecteur doit gérer les requêtes entrantes et répondre comme indiqué dans la documentation de référence de l'API du connecteur de communauté. Si vous rencontrez des problèmes lors du développement de votre code, consultez le guide de débogage pour obtenir de l'aide.
Définir le type d'authentification dans getAuthType()
Cette fonction est appelée pour identifier la méthode d'authentification utilisée pour le service tiers. Pour en savoir plus, consultez la documentation de référence sur getAuthType(). Les méthodes d'authentification actuellement compatibles sont listées dans la documentation de référence sur AuthType
.
Par exemple, le connecteur suivant ne nécessite pas d'authentification:
Si votre source de données nécessite une authentification OAuth 2.0, consultez le guide sur l'authentification OAuth 2.0 et ajoutez les fonctions supplémentaires requises à votre connecteur.
Définir la configuration via getConfig()
La fonction getConfig()
est appelée pour obtenir la configuration du connecteur, y compris les valeurs fournies par l'utilisateur requises par le connecteur. Pour en savoir plus, consultez la documentation de référence sur getConfig()
.
En fonction de la réponse fournie par getConfig()
, Looker Studio affiche l'écran de configuration du connecteur. Les éléments de configuration acceptés sont répertoriés dans la documentation de référence sur ConfigType
.
Si votre source de données nécessite la date comme paramètre, appelez config.setDateRangeRequired(true). Si vous devez poser des questions de configuration conditionnelle ou dynamique, consultez la section Configuration par étapes.
Voici un exemple de connecteur dans lequel l'utilisateur doit saisir un code de nom de package npm. Des informations et un champ de saisie sont définis dans la fonction getConfig()
:
Définir les champs avec getSchema()
Cette fonction est appelée pour obtenir le schéma de la requête donnée. Tous les paramètres de configuration définis par la fonction getConfig()
seront fournis dans l'argument request
. Pour en savoir plus, consultez la documentation de référence sur getSchema()
.
En fonction de la source de données de votre connecteur et de la configuration fournie par l'utilisateur, le schéma peut être fixe ou vous devrez peut-être le fournir de manière dynamique au moment de la requête.
Par exemple, si un connecteur récupère les données d'un rapport en fonction d'un ID de rapport, les données renvoyées pour ce rapport peuvent ne pas être connues au préalable.
Dans ce cas, getSchema()
peut nécessiter une extraction de données, et le schéma devra être calculé.
Extraire et renvoyer des données avec getData()
Cette fonction est appelée pour obtenir les données de la requête donnée. Tous les paramètres de configuration définis par la fonction getConfig()
seront fournis dans l'argument request
. Pour en savoir plus, consultez la documentation de référence sur getData()
.
Les paramètres suivants de la requête getData()
nécessitent une attention supplémentaire:
lastRefresh
lastRefresh
représente un horodatage qui marque l'heure de la requête la plus récente d'actualisation des données. Vous devriez pouvoir analyser la valeur avecnew Date(timestampString)
. Si vous utilisez le service de cache Apps Script ou toute autre méthode de mise en cache, l'horodatagelastRefresh
peut vous aider à déterminer s'il faut envoyer une nouvelle requête d'extraction à la source de données ou diffuser des données à partir du cache.dateRange
SidateRangeRequired
est défini surtrue
dansgetConfig()
, chaque appelgetData()
contiendra la plage de dates sélectionnée dans la requête. Pour en savoir plus, consultez la section Utiliser des plages de dates.
L'exemple suivant extrait des données en fonction de la requête entrante et renvoie les statistiques de package:
Remplir le fichier manifeste du projet
Le fichier manifeste contient des informations sur votre connecteur de communauté, lesquelles sont nécessaires pour le déployer et l'utiliser dans Looker Studio.
Pour modifier le fichier manifeste dans l'environnement de développement Apps Script, cliquez sur le menu View (Affichage), puis sur Show manifest file (Afficher le fichier manifeste). Cette opération entraîne la création d'un fichier manifeste appsscript.json
.
Mettez à jour le fichier manifeste pour inclure les données suivantes:
Pour en savoir plus sur le fichier manifeste Looker Studio, consultez la documentation de référence.
Étapes suivantes
L'étape suivante consiste à déployer votre connecteur de communauté.