So erstellen Sie einen Community-Connector:
- Erstellen Sie ein neues Apps Script-Projekt.
- Schreiben Sie den Connector-Code.
- Vervollständigen Sie das Projektmanifest.
Neues Apps Script-Projekt erstellen
Rufen Sie Google Apps Script auf, um ein neues Projekt zu erstellen. Apps Script erstellt ein
Standardskript für Sie. Sie können die Funktion myFunction
entfernen und das Projekt umbenennen. Weitere Informationen zu Apps Script
Connector-Code schreiben
Für jeden Connector müssen bestimmte Funktionen definiert sein. Die Hosting-Anwendung (z.B. Looker Studio) führt diese Funktionen aus. Es wird erwartet, dass Ihr Connector eingehende Anfragen verarbeitet und wie in der Referenz zur Community Connector API beschrieben reagiert. Wenn bei der Codeentwicklung Probleme auftreten, finden Sie im Leitfaden zur Fehlerbehebung weitere Informationen.
Authentifizierungstyp in getAuthType() definieren
Diese Funktion wird aufgerufen, um die Authentifizierungsmethode zu identifizieren, die für den Drittanbieterdienst verwendet wird. Weitere Informationen finden Sie in der Referenz zu getAuthType(). Derzeit unterstützte Authentifizierungsmethoden sind in der Referenz zu AuthType
aufgeführt.
Für den folgenden Connector ist beispielsweise keine Authentifizierung erforderlich:
Wenn für Ihre Datenquelle eine OAuth 2.0-Authentifizierung erforderlich ist, lesen Sie die Authentifizierungsanleitung für OAuth 2.0 und fügen Sie Ihrem Connector die zusätzlichen erforderlichen Funktionen hinzu.
Konfiguration über getConfig()
definieren
Die Funktion getConfig()
wird aufgerufen, um die Konfiguration für den Connector abzurufen, einschließlich der vom Nutzer bereitgestellten Werte, die für den Connector erforderlich sind. Weitere Informationen finden Sie in der Referenz zu getConfig()
.
Looker Studio rendert den Konfigurationsbildschirm des Connectors anhand der Antwort von getConfig()
. Die unterstützten Konfigurationselemente sind in der ConfigType
-Referenz aufgeführt.
Wenn für Ihre Datenquelle ein Datum als Parameter erforderlich ist, rufen Sie config.setDateRangeRequired(true) auf. Wenn Sie Fragen zur bedingten oder dynamischen Konfiguration stellen müssen, lesen Sie die Informationen unter Schrittweise Konfiguration.
Das folgende Beispiel zeigt einen Connector, bei dem der Nutzer einen npm-Paketnamenscode eingeben muss. In der Funktion getConfig()
sind ein Info- und ein Eingabefeld definiert:
Felder mit getSchema() definieren
Diese Funktion wird aufgerufen, um das Schema für die angegebene Anfrage abzurufen. Alle durch die Funktion getConfig()
definierten Konfigurationsparameter werden im Argument request
angegeben. Weitere Informationen finden Sie in der Referenz zu getSchema()
.
Abhängig von der Datenquelle des Connectors und der vom Nutzer bereitgestellten Konfiguration kann das Schema fest sein oder Sie müssen es bei der Anfrage dynamisch bereitstellen.
Wenn ein Connector beispielsweise Berichtsdaten basierend auf einer Berichts-ID abruft, sind die für diesen Bericht zurückgegebenen Daten und damit das Schema möglicherweise nicht vorher bekannt.
In diesem Fall kann für getSchema()
ein Datenabruf erforderlich sein und das Schema muss berechnet werden.
Daten mit getData() abrufen und zurückgeben
Diese Funktion wird aufgerufen, um Daten für die angegebene Anfrage abzurufen. Alle durch die Funktion getConfig()
definierten Konfigurationsparameter werden im Argument request
bereitgestellt. Weitere Informationen finden Sie in der Referenz zu getData()
.
Die folgenden Parameter aus der getData()
-Anfrage müssen zusätzlich geprüft werden:
lastRefresh
lastRefresh
steht für einen Zeitstempel, der den Zeitpunkt der letzten Anfrage für eine Aktualisierung der Daten kennzeichnet. Sie sollten den Wert mitnew Date(timestampString)
parsen können. Wenn Sie den Apps Script-Cache-Dienst oder eine andere Caching-Methode verwenden, können Sie anhand des ZeitstempelslastRefresh
feststellen, ob Sie eine neue Abrufanfrage an die Datenquelle stellen oder Daten aus dem Cache bereitstellen möchten.dateRange
WenndateRangeRequired
ingetConfig()
auftrue
gesetzt ist, enthält jedergetData()
-Aufruf den ausgewählten Zeitraum in der Anfrage. Weitere Informationen finden Sie unter Mit Zeiträumen arbeiten.
Im folgenden Beispiel werden Daten basierend auf der eingehenden Anfrage abgerufen und die Paketstatistiken zurückgegeben:
Projektmanifest fertigstellen
Die Manifestdatei enthält Informationen zu Ihrem Community-Connector, die erforderlich sind, um den Connector in Looker Studio bereitzustellen und zu verwenden.
Zum Bearbeiten der Manifestdatei in der Apps Script-Entwicklungsumgebung klicken Sie auf das Menü Ansicht und dann auf Manifestdatei anzeigen. Dadurch wird eine neue appsscript.json
-Manifestdatei erstellt.
Aktualisieren Sie das Manifest, um die folgenden Daten einzuschließen:
Weitere Informationen zum Looker Studio-Manifest finden Sie in der Referenz zum Manifest.
Nächste Schritte
Im nächsten Schritt stellen Sie den Community-Connector bereit.