Das Manifest (appsscript.json) ist eine JSON-Datei in Ihrem Apps Script-Connectorprojekt. Es enthält bestimmte Informationen zu Ihrem Community-Connector, die für die Bereitstellung und Verwendung des Connectors in Data Studio erforderlich sind. Weitere Informationen zu Manifesten in Apps Script.
Ihr Manifest sollte die folgenden Informationen enthalten:
| Attributname | Typ | Beschreibung |
|---|---|---|
Erforderlich (unter dem Attribut dataStudio)
|
||
name
|
string
|
Name Ihres Connectors. Max. 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 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 tut und auf welche Daten er zugreift. Sie sollten diese
Seite hosten und verwalten. Diese Seite muss Ihre Nutzungsbedingungen und Datenschutzerklärung enthalten oder einen Link dazu haben. |
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 verwalten. |
description
|
string
|
Die Beschreibung für Ihren Connector. Nutzer sehen die vollständige Beschreibung auf der Konfigurationsseite Ihres Connectors. Links sind anklickbar. |
Optional (unter dem Attribut dataStudio)
|
||
shortDescription
|
string
|
Max.114 Zeichen Wenn Ihr Connector veröffentlicht ist, wird diese Kurzbeschreibung auf der Galeriekarten für Ihren Connector angezeigt. Beschreiben Sie hier kurz, was Ihr Connector tut. Nutzer können diese Beschreibung sehen, wenn sie in der Galerie nach Connectors suchen. |
privacyPolicyUrl
|
string (link)
|
Link zur Datenschutzerklärung für den Connector bzw. die Organisation des Entwicklers. |
termsOfServiceUrl
|
string (link)
|
Link zu den Nutzungsbedingungen für den Connector bzw. die Organisation des Entwicklers. |
authType
|
list(AuthType)
|
Typ der Authentifizierungsmethode 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 Sources 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 Data Studio-Bericht sein, der als Vorlage verwendet wird. Weitere Informationen finden Sie in der Anleitung zum Bereitstellen
von Berichtsvorlagen.
|
forceViewersCredentials
|
boolean
|
Gibt an, ob die Anmeldedaten des Betrachters für Datenquellen
erzwungen werden sollen, die aus diesem Connector erstellt wurden. Dieses Attribut ist optional und standardmäßig auf
false festgelegt. Weitere Informationen zu den Anmeldedaten des Betrachters finden Sie unter Daten
quellen-Anmeldedaten.
|
useQueryConfig
|
boolean
|
VERWORFEN: 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 finden Sie unter Erweiterte Dienste. |
advancedServices.schema
|
boolean
|
Gibt an, ob dieser Connector eine Abfragekonfiguration für `getSchema()` zurückgibt. Weitere Informationen finden Sie unter Erweiterte Dienste. |
| Optional (Attribut 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. Dies kann dazu beitragen, Nutzerdaten zu schützen. Weitere Informationen finden Sie unter URLs auf die Zulassungsliste setzen. |
AuthType
Die Werte für den Typ der Authentifizierungsmethode 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 der Connector OAuth 2.0 verwendet. |
KEY |
Gibt an, dass der Connector einen API-Schlüssel verwendet. |
USER_PASS |
Gibt an, dass der Connector einen Nutzernamen und ein Passwort verwendet. |
USER_TOKEN |
Gibt an, dass der Connector einen Nutzernamen und ein Token verwendet. |
PATH_USER_PASS |
Gibt an, dass der Connector einen Pfad, einen Nutzernamen und ein Passwort verwendet. |
PATH_KEY |
Gibt an, dass der Connector einen Pfad und einen Schlüssel verwendet. |
FeeType
Die Werte für den Gebührentyp können einer der 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, dass der Nutzer für die Verwendung des Connectors bezahlen muss. |
Quellen
„Quellen“ 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,
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 wird als GOOGLE_ANALYTICS angegeben). Verwenden Sie im Manifest Ihres Community-Connectors den Wert des Attributs für die Datenquellen-ID, z.B. GOOGLE_ANALYTICS.
Beispielmanifest für einen Community-Connector
Das folgende Beispiel zeigt ein vollständiges Manifest: