Manifestreferenz

Das Manifest (appsscript.json) ist eine JSON-Datei in Ihrem Apps Script-Connector Projekt arbeiten. Sie enthält bestimmte Informationen zu Ihrem Community-Connector die zum Bereitstellen und Verwenden des Connectors in Looker Studio erforderlich ist. Mehr erfahren 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) Link zu „Weitere Informationen“ auf der Sie erklären, und die Daten, auf die er zugreift. Diese sollten Sie hosten und verwalten. Seite.
Diese Seite muss Ihre Nutzungsbedingungen und Datenschutzbestimmungen enthalten oder damit verlinkt sein. Richtlinie.
supportUrl string (link) Link zur Supportseite für diesen Connector. Nutzer*innen sollten Sie unter diesem Link Probleme mit Ihrem Connector melden können. Ich diese Seite hosten und verwalten soll.
description string Die Beschreibung für Ihren Connector.
Nutzer sehen die vollständige Beschreibung im Connector. Konfigurationsseite aufrufen. Links sind anklickbar.
Optional (unter der Property dataStudio)
shortDescription string Limit: 114 Zeichen Wenn Ihr Connector bereits veröffentlicht ist, ist diese kurze Beschreibung in der Galeriekarte Ihres Connector. Beschreiben Sie damit kurz, wozu der Connector dient. Nutzer*innen sehen Sie diese Informationen, wenn Sie die Connectors im Galerie.
privacyPolicyUrl string (link) Link zur Datenschutzerklärung des Connectors / der Entwicklerorganisation.
termsOfServiceUrl string (link) Link zu den Nutzungsbedingungen des Connectors / der Entwicklerorganisation.
authType list(AuthType) Typ der Authentifizierungsmethode 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. Nur eine Standardeinstellung unterstützt. Dies wird durch Festlegen eines default-Schlüssel. Der Wert sollte die Berichts-ID für die Looker- Studio-Bericht, der als Vorlage verwendet wird. Weitere Informationen finden Sie im Leitfaden zur Bereitstellung Berichtsvorlagen
forceViewersCredentials boolean Ob die Anmeldedaten des Betrachters für Datenquellen erzwungen werden sollen die mit diesem Connector erstellt wurden. Diese Eigenschaft ist optional und standardmäßig auf false Siehe Daten Anmeldedaten der Quelle für weitere Details zu den Anmeldedaten des Betrachters.
useQueryConfig boolean VERWORFEN: Gibt an, ob dieser Connector eine Abfragekonfiguration für `getData()`. Verwenden Sie stattdessen „advancedServices“.
advancedServices.data boolean Gibt an, ob dieser Connector eine Abfragekonfiguration für `getData()`. Siehe Erweitert Dienste.
advancedServices.schema boolean Gibt an, ob dieser Connector eine Abfragekonfiguration für `getSchema()`. Siehe Erweitert Dienste.
Optional (Property auf Stammebene)
urlFetchWhitelist list(string) Eine Liste der vom Connector verwendeten HTTPS-URL-Präfixe. Beliebiger URL-Endpunkt abgerufenen muss mit einem der Präfixe in dieser Liste übereinstimmen. Dies kann dabei helfen, Nutzerdaten zu schützen. Weitere Informationen finden Sie unter Safelisting URLs.

AuthType

Folgende Werte für den Typ der Authentifizierungsmethode sind möglich:

Enum-Wert Beschreibung
NONE Gibt an, dass für den Connector.
OAUTH2 Gibt an, dass der Connector OAuth 2.0 verwendet.
KEY Gibt an, dass der Connector einen API-Schlüssel verwendet.
USER_PASS Gibt an, dass der Connector Nutzername/Passwort verwendet.
USER_TOKEN Gibt an, dass der Connector Nutzername/Token verwendet.
PATH_USER_PASS Gibt an, dass der Connector Pfad/Nutzername/Passwort verwendet.
PATH_KEY Gibt an, dass der Connector Pfad/Schlüssel verwendet.

FeeType

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

Enum-Wert Beschreibung
FREE Gibt an, dass der Connector vollständig kostenlos verwendet werden kann.
FREE_TRIAL Gibt an, dass für den Connector eine kostenlose Testoption verfügbar ist.
PAID Gibt an, dass der Nutzer für die Verwendung des Connectors bezahlen muss.

Quellen

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

Beispielmanifest für einen Community-Connector

Das folgende Beispiel zeigt 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/"
  ]
}