Manifestreferenz

Das Manifest (appsscript.json) ist eine JSON-Datei in Ihrem Apps Script-Connector-Projekt. Sie enthält bestimmte Informationen zu Ihrem Community-Connector, die erforderlich sind, um den Connector in Looker Studio bereitzustellen und zu verwenden. Weitere Informationen zu Manifesten in Apps Script

Das Manifest sollte die folgenden Informationen enthalten:

Property-Name Typ Beschreibung
Erforderlich (unter der Property dataStudio)
name string Name des Connectors.
Beschränkt auf 28 Zeichen
company string Name der Organisation oder des Entwicklers.
companyUrl string (link) Link zur Website der Organisation oder des Entwicklers.
logoUrl string (image link) Die URL zu einem Symbol für den Connector.
Die erforderlichen Abmessungen sind 40 x 40 Pixel.
addOnUrl string (link) Erstellen Sie einen Link zu einer Seite mit weiteren Informationen, auf der die Funktionen des Connectors und die Daten, auf die er zugreift, erläutert werden. Sie sollten diese Seite hosten und verwalten.
Diese Seite muss Ihre Nutzungsbedingungen und Ihre Datenschutzerklärung enthalten oder damit verknüpft sein.
supportUrl string (link) Link zur Supportseite für diesen Connector. Nutzer sollten über diesen Link Probleme mit dem Connector melden können. Sie sollten diese Seite hosten und verwalten.
description string Die Beschreibung Ihres Connectors.
Nutzer sehen die vollständige Beschreibung auf der Seite zur Connector-Konfiguration. Links sind anklickbar.
Optional (unter dem Attribut dataStudio)
shortDescription string Limit: 114 Zeichen Wenn der Connector veröffentlicht ist, wird diese kurze Beschreibung auf der Galeriekarte für den Connector angezeigt. Beschreiben Sie kurz die Funktion Ihres Connectors. Nutzer können dies sehen, wenn sie in der Galerie die Connectors durchsuchen.
privacyPolicyUrl string (link) Link zur Datenschutzerklärung für den Connector bzw. die Entwicklerorganisation.
termsOfServiceUrl string (link) Link zu den Nutzungsbedingungen für den Connector bzw. die Entwicklerorganisation.
authType list(AuthType) Authentifizierungsmethodentyp für den Connector. Siehe AuthType unten.
feeType list(FeeType) Gibt den Gebührentyp für den Connector an. Siehe FeeType unten.
sources list(Sources) Die Liste der Datenquellen, zu denen dieser Connector eine Verbindung herstellen kann. Siehe Quellen unten.
templates Object Liste der Vorlagen, die mit diesem Connector verwendet werden können. Es wird nur eine Standardvorlage unterstützt, die durch Festlegen eines default-Schlüssels identifiziert wird. Der Wert sollte die Berichts-ID für den Looker Studio-Bericht sein, der als Vorlage verwendet wird. Weitere Informationen finden Sie im Leitfaden zum Bereitstellen von Berichtsvorlagen.
forceViewersCredentials boolean Gibt an, ob die Anmeldedaten des Betrachters für Datenquellen erzwungen werden sollen, die über diesen Connector erstellt wurden. Dieses Attribut ist optional und standardmäßig auf false gesetzt. Weitere Informationen zu Anmeldedaten des Betrachters finden Sie unter Anmeldedaten für Datenquelle.
useQueryConfig boolean EINGESTELLT: Gibt an, ob dieser Connector eine Abfragekonfiguration für „getData()“ zurückgibt. Verwenden Sie stattdessen „advancedServices“.
advancedServices.data boolean Gibt an, ob dieser Connector eine Abfragekonfiguration für „getData()“ zurückgibt. Siehe Erweiterte Dienste.
advancedServices.schema boolean Gibt an, ob dieser Connector eine Abfragekonfiguration für `getSchema()` zurückgibt. Siehe Erweiterte Dienste.
Optional (Property auf Stammebene)
urlFetchWhitelist list(string) Eine Liste von HTTPS-URL-Präfixen, die vom Connector verwendet werden. Jeder abgerufene URL-Endpunkt muss mit einem der Präfixe in dieser Liste übereinstimmen. Dies kann zum Schutz von Nutzerdaten beitragen. Weitere Informationen finden Sie unter URLs auf die Zulassungsliste setzen.

AuthType

Folgende Werte stehen für den Authentifizierungsmethodentyp zur Verfügung:

Enum Value Beschreibung
NONE Gibt an, dass für den Connector keine Authentifizierung erforderlich ist.
OAUTH2 Gibt an, dass der Connector OAuth 2.0 verwendet.
KEY Gibt an, dass der Connector den API-Schlüssel verwendet.
USER_PASS Gibt an, dass der Connector Nutzername/Passwort verwendet.
USER_TOKEN Gibt an, dass der Connector den Nutzernamen/das Token verwendet.
PATH_USER_PASS Gibt an, dass der Connector den Pfad/den Nutzernamen/das Passwort verwendet.
PATH_KEY Gibt an, dass der Connector den Pfad/Schlüssel verwendet.

FeeType

Folgende Werte sind für den Gebührentyp verfügbar:

Enum Value Beschreibung
FREE Gibt an, dass der Connector vollständig kostenlos verwendet werden kann.
FREE_TRIAL Gibt an, dass für den Connector eine kostenlose Testversion angeboten wird.
PAID Gibt an, dass der Nutzer für die Verwendung des Connectors zahlen muss.

Quellen

Quellen ist eine Liste von Enums für Quellen. Sie können die vorhandene Liste der Quellen in unserem Data Registry-Repository ansehen. Wenn die Quelle, zu der Sie eine Verbindung herstellen, nicht im Repository vorhanden ist, senden Sie eine Pull-Anfrage an das Data Registry-Repository, um die Quelle hinzuzufügen. Der Name der Quelle darf nur Großbuchstaben und Unterstriche enthalten (z.B. lautet Google Analytics GOOGLE_ANALYTICS). Verwenden Sie in Ihrem Community-Connector-Manifest den Wert der Property für die Datenquellen-ID, z.B. GOOGLE_ANALYTICS.

Beispielmanifest für einen Community-Connector

Hier ein Beispiel für ein fertiges Manifest:

data-studio/appsscript.json
{
  "dataStudio": {
    "name": "Nucleus by Hooli",
    "company": "Hooli Inc.",
    "companyUrl": "https://hooli.xyz",
    "logoUrl": "https://hooli.xyz/middle-out-optimized/nucleus/logo.png",
    "addonUrl": "https://hooli.xyz/data-studio-connector",
    "supportUrl": "https://hooli.xyz/data-studio-connector/support",
    "description": "Nucleus by Hooli connector lets you connect to your data in Data Studio using Nucleus middle out optimization. You will need an account on hooli.xyz to use this connector. Create your account at https://hooli.xyz/signup",
    "shortDescription": "Connect to your data using Nucleus middle out optimization",
    "privacyPolicyUrl": "https://hooli.xyz/privacy",
    "termsOfServiceUrl": "https://hooli.xyz/tos",
    "authType": ["NONE"],
    "feeType": ["PAID"],
    "sources": ["HOOLI_CHAT_LOG", "ENDFRAME_SERVER_STREAM", "RETINABYTE_USER_ANALYTICS"],
    "templates": {
      "default": "872223s89f5fdkjnd983kjf"
    }
  },
  "urlFetchWhitelist": [
    "https://api.hooli.xyz/",
    "https://hooli.xyz/"
  ]
}