Anforderungen für Partner-Connectors

In der Veröffentlichungen – Übersicht erfahren Sie mehr über die Vorteile und den erforderlichen Aufwand für die Veröffentlichung eines Connectors. Wenn Sie einen Partner-Connector veröffentlichen möchten, muss Ihr Connector alle unten beschriebenen Anforderungen erfüllen.

Apps Script

Bevor Sie Ihren Connector zur Überprüfung einreichen, führen Sie in Apps Script die folgenden Schritte aus:

  1. Lesezugriff auf Ihr Apps Script-Projekt für die folgenden Personen freigeben:
  2. Erstellen Sie eine Bereitstellung mit dem Namen Production und aktualisieren Sie die Production Bereitstellung auf die Version des Codes, die Sie veröffentlichen möchten.
  3. Prüfen Sie, ob Sie die Bereitstellung Production auf die Version des Codes aktualisiert haben, die überprüft werden soll.
  4. Prüfen Sie, ob die Manifestdatei in Apps Script sichtbar ist. Klicken Sie links auf Projekteinstellungen . Wählen Sie das Kästchen Manifestdatei „appsscript.json“ im Editor anzeigen aus.

Manifest

Fügen Sie das Folgende in das Manifest Ihres Connectors ein und prüfen Sie, ob Ihr Apps Script-Projekt so konfiguriert ist, dass die Manifestdatei appsscript.json im Editor angezeigt wird.

Weitere Informationen finden Sie in der Manifestreferenz für Community-Connectors.

dataStudio

  1. description sollte Informationen und Anleitungen für ein grundlegendes Verständnis des Connectors und seiner Verwendung enthalten. Connectors mit vagen und unvollständigen Beschreibungen werden abgelehnt.
  2. addOnUrl sollte eine eigene gehostete Seite zu Ihrem Connector sein, die vorzugsweise in Ihrer eigenen Domain gehostet wird. Die Seite muss Folgendes enthalten:
    • Eine Datenschutzerklärung und Nutzungsbedingungen oder einen Link zu diesen Inhalten in derselben Domain wie die addOnUrl.
    • Details, die der Nutzer für die Verwendung Ihres Connectors benötigt.
    • Den Link zur Registrierung, falls ein Konto für die Verwendung Ihres Connectors erforderlich ist.
    • Inhalte, die vorzugsweise in Ihrer Domain gehostet werden. Das Hosting auf https://sites.google.com/ ist nicht zulässig.
    • Beispielseiten von bestehenden Partnern: Funnel, Supermetrics, CallRail.
  3. supportUrl sollte eine gehostete Seite sein, um Support für Ihren Connector zu erhalten. Dies darf keine E-Mail-Adresse oder kein Mailto-Link sein.
  4. logoUrl sollte auf ein statisches Bild verweisen das unter Ihrer Kontrolle gehostet wird. Sie dürfen keine Bilder verwenden, die von Google-Diensten auf Domains wie *.gstatic.com, *.ggpht.com, *.google.com oder *.googleusercontent.com bereitgestellt werden. Die Verwendung von Google Cloud Storage zum Bereitstellen von Bildern aus der Domain *.googleapis.com ist zulässig und wird empfohlen.
    • Connectors mit animierten Symbolen werden abgelehnt. Verwenden Sie statische Bilder.
    • Wir empfehlen, ein Bild mit mindestens 48 × 48 Pixeln zu verwenden.
    • Vermeiden Sie Bilder, die nur Text enthalten und bei einer Skalierung auf 48 × 48 Pixel schwer zu lesen sind.
  5. Füllen Sie die sources Property mit allen Quellen aus, mit denen Ihr Connector eine Verbindung herstellt. Weitere Informationen finden Sie unter Quellen in der Manifestreferenz für Details.
    • Die vorhandene Liste der Quellen finden Sie im 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. Ihr Connector besteht die Überprüfung nicht, wenn die Quellen in Ihrem Manifest nicht im Repository vorhanden sind.
    • Dies sind zusätzliche Metadaten für den Connector, die für die Suchfunktion in der Galerie indexiert werden. Ihr Connector wird in den Suchergebnissen angezeigt, wenn Nutzer in der Galerie nach einer bestimmten Quelle suchen.
  6. Geben Sie Werte für shortDescription, authType, feeType, privacyPolicyUrl, und termsOfServiceUrl an.
  7. name sollte den Zweck von dem Connector direkt widerspiegeln. Ein klarer Name hilft Nutzern, zu entscheiden, ob Ihr Connector ihren Anforderungen entspricht. Vermeiden Sie die Verwendung des Wortes Connector im Namen, da Nutzer bereits wissen, dass sie sich einen Connector ansehen.
    • Fügen Sie keine Sonderzeichen oder nicht sichtbaren Zeichen hinzu, um die Aufmerksamkeit auf Ihren Connector zu lenken oder seine Position zu ändern.
  8. Verwenden Sie im Manifest keine Kurznamen für Data Studio (z.B. GDS, DS usw.).
  9. Emojis sind in keinem Manifestfeld zulässig (description, shortDescription, name usw.). Fügen Sie im Allgemeinen keine Sonderzeichen oder nicht sichtbaren Zeichen hinzu, um die Aufmerksamkeit auf Ihren Connector zu lenken.
  10. Wenn Ihr Connector ein festes Schema hat, erstellen Sie eine Berichtsvorlage für Ihren Connector und fügen Sie sie dem Manifest hinzu. Aktivieren Sie die Freigabe per Link für den Bericht.

urlFetchWhitelist

  1. Beschränken Sie die Anzahl der von UrlFetchApp aufgerufenen Endpunkte auf die, die für die Connector-Funktionalität unbedingt erforderlich sind. Fügen Sie die Property urlFetchWhitelist der Stammebene Ihres Manifests hinzu. Weitere Informationen finden Sie in der Referenz zu urlFetchWhitelist.
    • Fügen Sie alle Endpunkte hinzu, die mit dem Dienst UrlFetchApp verwendet werden.
    • Wenn Ihr Connector keine Ressourcen mit dem Dienst UrlFetchApp abruft, legen Sie für urlFetchWhitelist eine leere Liste [] fest.
    • Wenn Ihr Connector keine Verbindung zu einer Reihe fester Endpunkte herstellt oder das Endpunktpräfix variiert, lassen Sie die Property urlFetchWhitelist weg und geben Sie die Details beim Einreichen der Überprüfungsanfrage im Formularfeld Ausnahme für urlFetchWhitelist an.

oauthScopes

  1. Legen Sie im Manifest explizite OAuth-Bereiche fest. Connectors ohne explizite OAuth-Bereiche werden abgelehnt.

Connector

  1. Wenn der Nutzer ein Konto benötigt, um den Connector zu verwenden, muss die description des Connectors oder der Link addOnUrl eine Anleitung zum Erstellen eines Kontos enthalten.
  2. Ihr Connector darf sich nicht im Status „Unvollständig“ oder „Beta“ befinden. Sie müssen einen vollständigen und funktionsfähigen Connector veröffentlichen. Sie können Ihren Connector jederzeit aktualisieren, aber die Produktionsbereitstellung, die für Nutzer freigegeben wird, sollte getestet und vollständig sein.
  3. Geben Sie Nutzern aussagekräftige und umsetzbare Fehlermeldungen, wenn Nutzer auf einen internen Connector-Fehler stoßen. Dazu gehören auch Fälle, in denen ein Nutzer bei der Konfiguration eine ungültige oder leere Eingabe macht.
  4. shortDescription, description, addOnUrl-Link, supportUrl-Link und die OAuth-Seite (falls zutreffend) sollten keine Rechtschreib- und Grammatikfehler enthalten.
  5. shortDescription darf keine URLs enthalten.
  6. Verwenden Sie Authentifizierungsmethoden, die von getAuthType() bereitgestellt werden. Fordern Sie keine Anmeldedaten über getConfig() an.
  7. Führen Sie die OAuth-Clientüberprüfung durch. Die Überprüfung ist für alle Connectors unabhängig von der Authentifizierungsmethode in getAuthType() obligatorisch. Die Überprüfung ist ein anderer Prozess als die Connector-Überprüfung und wird von einem separaten Team und nicht von Data Studio durchgeführt. Weitere Informationen finden Sie in den FAQs zur OAuth-API-Überprüfung. Ihr Connector wird abgelehnt, wenn die OAuth-Clientüberprüfung nicht abgeschlossen ist.
    • Fügen Sie während der OAuth-Überprüfung, die erforderlichen OAuth-Bereiche Ihres Connectors als Teil der OAuth Zustimmungsbildschirmkonfiguration hinzu. Wenn Sie nicht alle erforderlichen Zugriffsbereiche hinzufügen, bestehen Sie möglicherweise die OAuth-Überprüfung, aber für Ihren Connector wird trotzdem der Bildschirm „Nicht überprüfte App“ angezeigt. Dadurch schlägt die Überprüfung des Partner-Connectors fehl.
      Autorisieren und testen Sie Ihren Connector mit einem neuen Konto, nachdem Sie die OAuth-Überprüfung bestanden haben, damit der Bildschirm „Nicht überprüfte App“ Ihren Nutzern nicht angezeigt wird.
  8. Achten Sie darauf, dass Sie die Nutzungsbedingungen für Galerien in Data Studio (einreichende Personen) einhalten.

Wenn Sie alle Anforderungen erfüllt haben, klicken Sie auf die folgende Schaltfläche, um eine Überprüfung für Ihren Connector anzufordern:

Partner-Connector veröffentlichen