Überschreibbare Konfigurationsparameter

Überschreibbare Konfigurationsparameter bieten Berichtseditor die Möglichkeit, Standardwerte in einer Datenquelle zu ändern. Wenn Sie Konfigurationsparameter als überschreibbar definieren, wird eine Datenquelle flexibler und Nutzer können Berichtsvorlagen erstellen, die sie selbst konfigurieren können.

Beispielsweise kann ein Connector, der Wetterdaten zurückgibt, einen Standortparameter enthalten, über den Betrachter Wetterberichte für einen anderen als den standardmäßigen Ort anfordern können.

In diesem Dokument wird beschrieben, wie überschreibbare Parameter definiert und für die Änderung aktiviert werden und wie Parameterwerte von Berichtsnutzern geändert werden können. Weitere Informationen zur Verwendung von Parametern in Data Studio finden Sie unter Datenquellenparameter.

Rollen

Die in diesem Dokument erwähnten Nutzerrollen:

Rolle	Definition
Connector-Entwickler	Ein Nutzer, der einen Community-Connector erstellt hat.
Inhaber der Datenquelle	Ein Nutzer, der eine Datenquelle erstellt und Inhaber dieser Datenquelle ist.
Berichtseditor	Ein Nutzer mit Zugriff auf den Bearbeitungsmodus eines Berichts.
Berichtsbetrachter	Ein Nutzer mit Zugriff auf den Ansichtsmodus eines Berichts.

Überschreibbare Parameter definieren

Der Connector-Entwickler definiert Konfigurationsparameter in der getConfig() Funktion eines Community-Connectors. Wenn ein Konfigurationsparameter als überschreibbar definiert werden soll, ruft der Connector setAllowOverride(true) auf.

**Hinweis**: Parameter können auch als Teil einer benutzerdefinierten BigQuery-Abfrage definiert werden.

Im folgenden Beispiel werden zwei überschreibbare Parameter definiert: zipcode und units. Außerdem wird ein Parameter definiert, der nicht überschreibbar ist: days-to-forcecast.

function getConfig(request) {
  var config = cc.getConfig();

  // A
  config
      .newTextInput()
      .setId("zipcode")
      .setName("ZIP Code")
      .setAllowOverride(true);

  // B
  config
    .newSelectSingle()
    .setId("units")
    .setName("Units")
    .addOption(
        config
          .newOptionBuilder()
          .setLabel("Metric")
          .setValue("metric")
    )
    .addOption(
      config
        .newOptionBuilder()
        .setLabel("Imperial")
        .setValue("imperial")
    )
    .setAllowOverride(true);

  // C
  config
    .newTextInput()
    .setId("days-to-forecast")
    .setName("Days to forecast")
      .setAllowOverride(false);


  return config.build();
}

Hinweis: Der Standardwert für allowOverride ist false. Wenn Sie das Überschreiben für einen Parameter nicht aktivieren möchten, können Sie den Aufruf von setAllowOverride() weglassen.

Wann sollte ein Parameter nicht als überschreibbar definiert werden?

Informationen dazu, wie Connectors, Datenquellen und Berichte zusammenarbeiten, finden Sie unter Datenverbindungen in Data Studio.

In den folgenden Fällen sollten Sie einen Parameter nicht als überschreibbar definieren:

1. Wenn der Wert eines Parameters das Schema beeinflusst.
   • Wenn ein Nutzer einen Parameterwert ändert und das Schema der zurückgegebenen neuen Daten sich von dem in der Datenquelle definierten Schema unterscheidet, kann es bei allen Berichten, die von der Datenquelle abhängig sind, zu Fehlern kommen, weil Felder fehlen.
2. Wenn ein Parameterwert sensible Daten steuert. Beispiel: Kontoauswahl.
   • Definieren Sie einen Parameter nicht als überschreibbar, wenn Sie verhindern möchten, dass sensible Daten unbeabsichtigt angezeigt oder freigegeben werden.

Parameter für Berichtsnutzer aktivieren

Inhaber der Datenquelle legen fest, welche überschreibbaren Parameter von Berichtseditor geändert werden dürfen. Ebenso legen Berichtseditor fest, welche Parameter von Berichtsbetrachter geändert werden können.

Berichtseditor erlauben, Parameterwerte zu ändern

Der Inhaber der Datenquelle legt fest, welche Parameter in Berichten geändert werden dürfen. Dies wird beim Erstellen oder Bearbeiten einer Datenquelle konfiguriert und ist nur für Parameter anwendbar, die vom Connector Entwickler als überschreibbar definiert wurden. Wenn diese Option aktiviert ist, können Berichtseditor Parameter in einem Bericht ändern.

Im folgenden Beispiel hat ein Connector zwei Parameter, die als überschreibbar definiert sind: zipcode und units. Der Inhaber der Datenquelle hat nur zugelassen, dass zipcode in Berichten geändert wird. Im Bericht hat der Berichtseditor die Möglichkeit, den Parameterwert zipcode zu ändern.

Berichtsbetrachter erlauben, Parameterwerte zu ändern

Berichtseditor legen fest, welche Parameter von Berichtsbetrachter geändert werden können. Die Parameterwerte können dann von jedem Betrachter des Berichts über die Berichts-URL geändert werden.

**Hinweis**: Die Möglichkeit eines Berichtseditor , das Ändern von Parametern zuzulassen, ist auf die Parameter beschränkt, die vom Inhaber der Datenquelle zugelassen wurden.

Nehmen wir beispielsweise einen Connector mit zwei Parametern, die als überschreibbar definiert sind: zipcode und units (Abbildung 1). Wenn der Inhaber der Datenquelle zugelassen hat, dass zipcode in Berichten geändert wird (Abbildung 2), können Berichtseditor nur zulassen, dass zipcode von Berichtsbetrachter geändert wird. Der Berichtseditor hat keinen Zugriff oder keine Sichtbarkeit, zuzulassen, dass der Parameter units von Berichtsbetrachtern geändert wird.

Abbildung 1: Connector-Konfiguration.

Abbildung 2: Parameter verwalten.

Warnung: Berichtsbetrachter können auf alle Daten zugreifen, die über Parameter gesteuert werden. Um zu vermeiden, dass sensible Daten unbeabsichtigt weitergegeben werden, überprüfen Sie, ob die Datenquelle und die Anmeldedaten für Datenquelle richtig konfiguriert sind, bevor Sie zulassen, dass ein Parameter geändert wird. Wenn ein Parameter Zugriff auf sensible Daten ermöglicht, sollten Sie die Anmeldedaten des Betrachters verwenden, um sicherzustellen, dass Berichtsbetrachter nur ihre Daten sehen können.

URL-Parameter

So erlauben Sie Berichtsbetrachter , Parameterwerte über die Berichts-URL zu bearbeiten:

1. Öffnen Sie den Bericht zum Bearbeiten.
2. Wählen Sie Ressource -> Berichtsparameter verwalten aus.
3. Über die Kästchen Änderungen in der Berichts-URL zulassen können Sie festlegen, ob Parameterwerte in der Berichts-URL geändert werden dürfen. Änderungen werden automatisch gespeichert.
4. Klicken Sie rechts oben auf Schließen.

Parameterwerte ändern

Berichtseditor können Parameterwerte über den Bereich „Berichtseigenschaften“ ändern, während Berichtsbetrachter Parameterwerte über die Berichts-URL ändern können.

Bereich „Berichtseigenschaften“

Informationen dazu, wie ein Berichtseditor Parameterwerte festlegen kann, finden Sie unter Parameter in einem Bericht ändern.

Berichts-URL-Parameter

Für Parameter, die in der Berichts-URL geändert werden dürfen, können Werte über ein URL-codiertes JSON-Objekt festgelegt werden, das im Ansichtsmodus an die Berichts-URL angehängt wird.

So erstellen Sie eine URL-Konfiguration:

1. Parameternamen erfassen

   1. Öffnen Sie den Bericht zum Bearbeiten.
   2. Wählen Sie Ressource -> Berichtsparameter verwalten aus.
   3. Notieren Sie sich den Namen der Parameter, die Sie über die Berichts-URL festlegen möchten.

   In der Abbildung unten ist der Parametername beispielsweise ds0.zipcode.

   

2. Parameterobjekt erstellen

   Parameter werden über ein JSON-Objekt definiert. Die Schlüssel für die Parameterwerte sind die Parameternamen.

   {
     "parameterName": parameterValue
   }
   

   Parameterwerttypen sind STRING, NUMBER oder BOOLEAN. Verwenden Sie für Parameter, die mehrere Werte akzeptieren (z.B. Drop-down-Menüs mit Mehrfachauswahl), ein Array von Werten.

   Wenn der Parametername beispielsweise ds0.zipcode ist und Sie die Postleitzahl auf 94094 festlegen möchten, sieht das JSON so aus:

   {
     "ds0.zipcode": "94094"
   }
   

3. Parameterobjekt URL-codieren

   Nachdem Sie das Parameterobjekt erstellt haben, wandeln Sie es mit JSON.stringify() in einen String um und URL-codieren Sie es dann mit [encodeURIComponent].

   var params = {
     "ds0.zipcode": "94094"
   };
   var paramsAsString = JSON.stringify(params);
   var encodedParams = encodeURIComponent(paramsAsString)
   

   Das Ergebnis ist der folgende codierte String:

   "%7B%22ds0.zipcode%22%3A%2294094%22%7D"
   

4. Berichts-URL erstellen

   Hängen Sie das URL-codierte Parameterobjekt mit dem Suchparameter params an die URL der Berichtsansicht an.

   https://lookerstudio.google.com/reporting/REPORT_ID/page/PAGE_ID?params=%7B%22ds0.zipcode%22%3A%2294094%22%7D

   Ersetzen Sie REPORT_ID und PAGE_ID durch die Werte für Ihren Bericht und Ihre Seite.

5. URL verwenden

   Die Berichts-URL überschreibt Parameter gemäß der Definition im JSON-Parameter objekt basierend auf der Parametervererbung.

Beispiel für ein Parameterobjekt

Das folgende Parameterobjekt zeigt, wie mehrere Parameter festgelegt werden. Außerdem wird veranschaulicht, wie Parameterwerte für die verschiedenen Eingabetypen festgelegt werden.

• ds0.includeToday ist eine Checkbox-Eingabe.
• ds0.units ist eine Eingabe mit Einfachauswahl.
• ds1.countries ist eine Eingabe mit Mehrfachauswahl.
• ds1.labelName ist eine Texteingabe.

  {
    "ds0.includeToday": true,
    "ds0.units": "Metric",
    "ds1.countries": ["Canada", "Mexico"],
    "ds1.labelName": "Population"
  }

Parameter übernehmen

Der für einen Parameter verwendete Wert folgt einer Rangfolge, je nachdem, wo der Parameter festgelegt ist. Parameter, die an Stellen mit höherer Priorität festgelegt sind, überschreiben Parameter, die an Stellen mit niedrigerer Priorität festgelegt sind. Dabei wird die folgende Reihenfolge (von der niedrigsten zur höchsten Ebene) eingehalten:

1. Datenquelle (Standard)
2. Berichts-URL
3. Bereich „Berichtseigenschaften“ gemäß den Regeln für die Datenquelle Parametervererbung.