Manifestreferenz

Das Manifest (appsscript.json) ist eine JSON-Datei in Ihrem Apps Script-Connectorprojekt. Sie enthält bestimmte Informationen zu Ihrem Community-Connector, die für die Bereitstellung und Verwendung Ihres Connectors in Looker Studio erforderlich sind. Weitere Informationen zu Manifesten in Apps Script

Ihr Manifest sollte die folgenden Informationen enthalten:

Property-Name Typ Beschreibung
Erforderlich (unter dem Attribut dataStudio)
name string Name des Connectors.
Auf 28 Zeichen begrenzt
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 Ihren Connector.
Die erforderlichen Abmessungen sind 40 × 40 Pixel.
addOnUrl string (link) Link zu einer speziellen Seite mit weiteren Informationen, auf der erklärt wird, was Ihr Connector macht und auf welche Daten er zugreift. Sie sollten diese Seite hosten und pflegen.
Diese Seite muss Ihre Nutzungsbedingungen und Ihre Datenschutzerklärung enthalten oder darauf verlinken.
supportUrl string (link) Link zur Supportseite für diesen Connector. Nutzer sollten über diesen Link Probleme mit Ihrem Connector melden können. Sie sollten diese Seite hosten und pflegen.
description string Die Beschreibung für den Connector.
Nutzer sehen die vollständige Beschreibung auf der Konfigurationsseite Ihres Connectors. Links sind anklickbar.
Optional (unter der Eigenschaft dataStudio)
shortDescription string Höchstens 114 Zeichen Wenn Ihr Connector veröffentlicht wird, ist diese Kurzbeschreibung auf der Galeriekarte für Ihren Connector zu sehen. Beschreiben Sie hier kurz, was Ihr Connector macht. Nutzer können diese Informationen sehen, wenn sie in der Galerie nach Connectors suchen.
privacyPolicyUrl string (link) Link zur Datenschutzerklärung für den Connector / die Entwicklerorganisation.
termsOfServiceUrl string (link) Link zu den Nutzungsbedingungen für den Connector / die Entwicklerorganisation.
authType list(AuthType) Authentifizierungsmethodentyp für Ihren Connector. Siehe AuthType unten.
feeType list(FeeType) Gibt den Gebührentyp für Ihren Connector an. Siehe FeeType unten.
sources list(Sources) Die Liste der Datenquellen, mit 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, die über diesen Connector erstellt wurden, erzwungen werden sollen. Dieses Attribut ist optional und hat standardmäßig den Wert false. Weitere Informationen zu den Anmeldedaten des Betrachters finden Sie unter Anmeldedaten für Datenquellen.
useQueryConfig boolean VERALTET: 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. Weitere Informationen
advancedServices.schema boolean Gibt an, ob dieser Connector eine Abfragekonfiguration für `getSchema()` zurückgibt. Weitere Informationen finden Sie unter Erweiterte Dienste.
Optional (Property auf Stammebene)
urlFetchWhitelist list(string) Eine Liste der HTTPS-URL-Präfixe, die von Ihrem Connector verwendet werden. Jeder abgerufene URL-Endpunkt muss mit einem der Präfixe in dieser Liste übereinstimmen. Das kann zum Schutz von Nutzerdaten beitragen. Weitere Informationen finden Sie unter URLs auf die Zulassungsliste setzen.

AuthType

Die Werte für den Authentifizierungsmethodentyp können einer der folgenden sein:

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

FeeType

Die Werte für den Gebührentyp können die folgenden sein:

Enum-Wert Beschreibung
FREE Gibt an, dass der Connector völlig kostenlos verwendet werden kann.
FREE_TRIAL Gibt an, dass für den Connector eine kostenlose Testversion verfügbar ist.
PAID Gibt an, ob der Nutzer für die Verwendung des Connectors bezahlen muss.

Quellen

„Sources“ ist eine Liste von Enums für Quellen. Die vorhandene Liste der Quellen finden Sie in unserem Data Registry-Repository. Wenn die Quelle, mit der Sie eine Verbindung herstellen möchten, nicht im Repository vorhanden ist, senden Sie eine Pull-Anfrage an das Data Registry-Repository, um die Quelle hinzuzufügen. Der Quellname darf nur Großbuchstaben und Unterstriche enthalten (z.B. GOOGLE_ANALYTICS für Google Analytics). Verwenden Sie im Manifest Ihres Community Connectors den value der data source id-Property, z.B. GOOGLE_ANALYTICS.

Beispielmanifest für einen Community Connector

Im Folgenden finden Sie ein Beispiel für ein ausgefülltes 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/"
  ]
}