Anforderungen für Partner-Connectors

Lesen Sie den Abschnitt Veröffentlichung – Übersicht, um sich über die Vorteile und den erforderlichen Aufwand für die Veröffentlichung eines Connectors zu informieren. Damit Sie einen Partner-Connector veröffentlichen können, muss er alle unten beschriebenen Anforderungen erfüllen.

Apps Script

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

  1. Geben Sie den Lesezugriff auf Ihr Apps Script-Projekt für folgende Nutzer frei:
  2. Erstellen Sie ein Deployment mit dem Namen Production und aktualisieren Sie das Production-Deployment auf die Codeversion, die Sie veröffentlichen möchten.
  3. Prüfen Sie, ob Sie die Production-Bereitstellung auf die Codeversion aktualisiert haben, die überprüft werden soll.
  4. Prüfen Sie, ob die Manifestdatei in Apps Script sichtbar ist. Klicken Sie links auf Projekteinstellungen . Klicken Sie das Kästchen Show "appsscript.json" Manifest file in editor (Manifestdatei "appsscript.json" im Editor anzeigen) an.

Manifest

Fügen Sie Folgendes in das Manifest des 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-Connector.

dataStudio

  1. description sollte Informationen und Anleitungen für ein grundlegendes Verständnis des Connectors und seiner Verwendung enthalten. Connectors mit ungenauen und unvollständigen Beschreibungen werden abgelehnt.
  2. addOnUrl sollte eine dedizierte Seite zu Ihrem Connector sein, die vorzugsweise in Ihrer eigenen Domain gehostet wird. Die Seite muss die folgenden Angaben enthalten:
    • Eine Datenschutzerklärung und Nutzungsbedingungen oder ein Link zu diesen Inhalten in derselben Domain wie die addOnUrl.
    • Details, die der Nutzer für die Verwendung des Connectors kennen muss
    • Den Registrierungslink, falls für die Verwendung des Connectors ein Konto erforderlich ist
    • Inhalte, die vorzugsweise auf Ihrer Domain gehostet werden. Das Hosting auf https://sites.google.com/ ist nicht zulässig.
    • Beispielseiten bestehender Partner: Funnel, Supermetrics und CallRail
  3. supportUrl muss eine gehostete Seite sein, damit der Connector unterstützt wird. Dies darf kein E-Mail- oder Mailto-Link sein.
  4. logoUrl sollte auf ein statisches Bild verweisen, das von Ihnen verwaltet wird. Sie können keine Bilder verwenden, die von Google-Diensten in Domains wie *.gstatic.com, *.ggpht.com, *.google.com, *.googleusercontent.com bereitgestellt werden. Die Verwendung von Google Cloud Storage zum Bereitstellen von Bildern aus der Domain *.googleapis.com ist akzeptabel und wird als Hostingoption empfohlen.
    • Connectors mit animierten Symbolen werden abgelehnt. Verwenden Sie statische Bilder.
    • Wir empfehlen mindestens ein Bild mit 48 x 48 Pixeln.
    • Vermeiden Sie reine Textbilder, die schwer zu lesen sind, wenn sie auf 48 × 48 Pixel verkleinert werden.
  5. Geben Sie in das Attribut sources alle Quellen ein, mit denen der Connector eine Verbindung herstellt. Weitere Informationen findest du unter Quellen in Manifestreferenz.
    • Sie können die vorhandene Liste der Quellen im Data Registry-Repository ansehen. Wenn die Quelle, zu der Sie eine Verbindung herstellen, im Repository nicht vorhanden ist, senden Sie eine Pull-Anfrage an das Data Registry-Repository, um die Quelle hinzuzufügen. Ihr Connector schlägt die Überprüfung fehl, 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. Der 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 direkt den Zweck des Connectors darstellen. Anhand eines eindeutigen Namens können Nutzer feststellen, ob Ihr Connector ihren Anforderungen entspricht. Das Wort connector sollte nicht im Namen verwendet werden, da die Nutzer bereits wissen, dass sie sich einen Connector ansehen.
    • Verwenden Sie keine Sonderzeichen oder nicht sichtbaren Zeichen, um die Aufmerksamkeit auf Ihren Connector zu lenken oder seine Position zu verändern.
  8. Verwenden Sie im Manifest keine Kurznamen für Looker Studio wie GDS oder DS.
  9. Emojis sind in keinem Manifestfeld zulässig (description, shortDescription, name usw.). Im Allgemeinen sollten Sie keine Sonderzeichen oder nicht sichtbaren Zeichen einfügen, um die Aufmerksamkeit auf Ihren Connector zu lenken.
  10. Wenn der Connector ein festes Schema hat, erstellen Sie eine Berichtsvorlage für den Connector und fügen Sie sie dem Manifest hinzu. Aktivieren Sie die Option Freigabe per Link für den Bericht.

urlFetchWhitelist

  1. Beschränken Sie die Anzahl der Endpunkte, die von UrlFetchApp aufgerufen werden, auf die Anzahl der Endpunkte, die für die Connector-Funktionalität unbedingt erforderlich sind. Fügen Sie das Attribut urlFetchWhitelist der Stammebene des Manifests hinzu. Weitere Informationen finden Sie in der urlFetchWhitelist-Referenz.
    • Schließen Sie alle Endpunkte ein, die mit dem Dienst UrlFetchApp verwendet werden.
    • Wenn der Connector keine Ressourcen mit dem Dienst UrlFetchApp abruft, legen Sie für urlFetchWhitelist eine leere Liste [] fest.
    • Wenn der Connector keine Verbindung zu einer Gruppe von festen Endpunkten herstellt oder das Endpunktpräfix variiert, lassen Sie das Attribut urlFetchWhitelist weg und geben Sie beim Senden der Überprüfungsanfrage Details 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 der Link description oder addOnUrl eine Anleitung enthalten, die ihm beim Erstellen des Connectors hilft.
  2. Der Connector darf sich nicht im Status „Nicht fertig“ oder „Beta“ befinden. Sie müssen einen vollständigen und funktionsfähigen Connector veröffentlichen. Sie können den Connector jederzeit aktualisieren. Die Produktionsbereitstellung, die für Nutzer freigegeben wird, sollte jedoch getestet werden und die Funktionen sollten vollständig sein.
  3. Geben Sie aussagekräftige und umsetzbare Fehlermeldungen für Nutzer an, wenn sie einen internen Connector-Fehler feststellen. Dies gilt auch für Fälle, in denen ein Nutzer bei der Konfiguration eine ungültige/leere Eingabe vornimmt.
  4. shortDescription, description, addOnUrl-Link, supportUrl-Link und ggf. OAuth-Seite sollten frei von Rechtschreib- und Grammatikfehlern sein.
  5. shortDescription darf keine URLs enthalten.
  6. Verwenden Sie von getAuthType() bereitgestellte Authentifizierungsmethoden. Fordern Sie keine Anmeldedaten über getConfig() an.
  7. Schließen Sie die OAuth-Clientüberprüfung ab. Die Überprüfung ist für alle Connectors obligatorisch, unabhängig von der Authentifizierungsmethode in getAuthType(). Die Überprüfung unterscheidet sich von der Connector-Überprüfung und wird von einem separaten Team durchgeführt, nicht von Looker Studio. Weitere Informationen finden Sie in den FAQs zur OAuth API-Überprüfung. Ihr Connector wird abgelehnt, wenn die OAuth-Clientüberprüfung nicht abgeschlossen wird.
    • Fügen Sie während der OAuth-Überprüfung die erforderlichen OAuth-Bereiche des Connectors als Teil der Konfiguration des OAuth-Zustimmungsbildschirms hinzu. Wenn Sie nicht alle erforderlichen Bereiche hinzufügen, bestehen Sie möglicherweise den OAuth-Überprüfungsprozess. In Ihrem Connector wird jedoch weiterhin der Bildschirm Nicht überprüfte Anwendung angezeigt. Dies führt dazu, dass die Partner-Connector-Überprüfung fehlschlägt.
      Autorisieren und testen Sie den Connector mit einem neuen Konto, nachdem Sie die OAuth-Überprüfung abgeschlossen haben. So sorgen Sie dafür, dass der Bildschirm für nicht überprüfte Anwendungen Ihren Nutzern nicht angezeigt wird.
  8. Halten Sie die Nutzungsbedingungen für Galerien in Looker Studio (einreichende Personen) ein.

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

Partner-Connector veröffentlichen