Parametry konfiguracji, które można zastępować

Parametry konfiguracyjne, które można zastąpić, umożliwiają edytującym raporty modyfikowanie wartości domyślnych w źródle danych. Zdefiniowanie parametrów konfiguracji jako możliwych do zastąpienia zwiększa elastyczność źródła danych i umożliwia użytkownikom tworzenie szablonów raportów, które można konfigurować.

Na przykład oprogramowanie sprzęgające dostarczające dane pogodowe może zawierać parametr lokalizacji, który umożliwia osobom przeglądającym raporty żądanie raportu pogodowego z lokalizacji innej niż domyślna.

Z tego dokumentu dowiesz się, jak definiować parametry, które można zastępować, jak włączać możliwość ich modyfikowania oraz jak użytkownicy raportów mogą zmieniać wartości parametrów. Więcej informacji o tym, jak parametry są używane w Studiu danych, znajdziesz w artykule Parametry źródła danych.

Role

Role użytkowników, o których mowa w tym dokumencie:

Rola	Definicja
Deweloper oprogramowania sprzęgającego	Użytkownik, który utworzył społecznościowe oprogramowanie sprzęgające.
Właściciel źródła danych	Użytkownik, który utworzył źródło danych i jest jego właścicielem.
Edytor raportów	Użytkownik z dostępem do raportu w trybie edycji.
Wyświetlający raport	Użytkownik z dostępem do raportu w trybie widoku.

Określanie parametrów, które można zastępować

Deweloper oprogramowania sprzęgającego definiuje parametry konfiguracji w funkcji getConfig() społecznościowego oprogramowania sprzęgającego. Aby zdefiniować parametr konfiguracji jako parametr, który można zastąpić, oprogramowanie sprzęgające wywołuje funkcję setAllowOverride(true).

Uwaga: parametry można też zdefiniować w ramach niestandardowego zapytania BigQuery.

W tym przykładzie zdefiniowano 2 parametry, które można zastępować: zipcode i units, oraz 1 parametr, którego nie można zastępować: 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();
}

Uwaga: domyślna wartość parametru allowOverride to false. Jeśli nie chcesz włączyć zastępowania parametru, możesz pominąć wywołanie funkcji setAllowOverride().

Kiedy unikać definiowania parametru jako zastępowalnego

Zalecamy zapoznanie się z tym, jak łączniki, źródła danych i raporty działają w odniesieniu do siebie nawzajem. W tym celu przeczytaj artykuł [Jak Studio danych łączy się z Twoimi danymi].

Nie definiuj parametru jako zastępowalnego w tych przypadkach:

1. Gdy wartość parametru wpływa na schemat.
   • Jeśli użytkownik zmieni wartość parametru, a schemat nowych zwróconych danych będzie inny niż zdefiniowany w źródle danych, każdy raport zależny od tego źródła danych może przestać działać z powodu brakujących pól.
2. Jeśli wartość parametru kontroluje dane wrażliwe. Np. wybór konta.
   • Nie definiuj parametru jako zastępowalnego, jeśli chcesz zapobiec przypadkowemu wyświetlaniu lub udostępnianiu danych wrażliwych.

Włączanie parametrów dla użytkowników raportu

Właściciele źródeł danych określają, które parametry z możliwością zastąpienia mogą być modyfikowane przez osoby z uprawnieniami do edytowania raportów. Podobnie edytorzy raportów określają, które parametry mogą być modyfikowane przez osoby wyświetlające raporty.

Zezwalanie osobom edytującym raporty na modyfikowanie wartości parametrów

Właściciel źródła danych określa, które parametry można modyfikować w raportach. Jest to konfigurowane podczas tworzenia lub edytowania źródła danych i ma zastosowanie tylko do parametrów, które zostały zdefiniowane jako możliwe do zastąpienia przez dewelopera oprogramowania sprzęgającego. Jeśli ta opcja jest włączona, edytorzy raportów będą mogli modyfikować parametry w raporcie.

W tym przykładzie oprogramowanie sprzęgające ma 2 parametry, które można zastąpić: zipcode i units. Właściciel źródła danych zezwolił tylko na modyfikowanie zipcode w raportach. W raporcie osoba edytująca raport może modyfikować wartość parametru zipcode.

Zezwalaj osobom wyświetlającym raporty na modyfikowanie wartości parametrów

Edytorzy raportów określają, które parametry mogą być modyfikowane przez osoby wyświetlające raporty. Wartości parametrów można następnie modyfikować w adresie URL raportu przez dowolną osobę wyświetlającą raport.

Uwaga: kontrola osoby edytującej raport nad zezwalaniem na modyfikowanie parametrów jest ograniczona do parametrów dozwolonych przez właściciela źródła danych.

Załóżmy, że masz łącznik z 2 parametrami, które można zastąpić: zipcode i units (rysunek 1). Jeśli właściciel źródła danych zezwolił na modyfikowanie zipcode w raportach (rysunek 2), osoby edytujące raport będą mogły zezwolić na modyfikowanie zipcode tylko osobom przeglądającym raport. Edytor raportów nie będzie mieć dostępu ani wglądu, aby umożliwić widzom raportu modyfikowanie parametru units.

Rysunek 1. Konfiguracja oprogramowania sprzęgającego.

Rysunek 2. Zarządzanie parametrami.

Ostrzeżenie: Osoby wyświetlające raporty będą mieć dostęp do wszystkich danych kontrolowanych przez parametry. Aby uniknąć przypadkowego udostępnienia danych wrażliwych, przed zezwoleniem na modyfikację parametru sprawdź i potwierdź, czy źródło danych i uprawnienia do źródła danych są prawidłowo skonfigurowane. Jeśli parametr umożliwia dostęp do danych wrażliwych, rozważ użycie danych logowania osoby przeglądającej, aby zapewnić, że osoba przeglądająca raport będzie widzieć tylko swoje dane.

Parametry adresu URL

Aby zezwolić osobom wyświetlającym raporty na edytowanie wartości parametrów za pomocą adresu URL raportu:

1. Przeprowadź edycję raportu.
2. Kliknij Zasób –> Zarządzaj parametrami raportu.
3. Zaznacz pola wyboru Zezwalaj na modyfikację w adresie URL raportu, aby zezwolić na modyfikację wartości parametrów w adresie URL raportu lub jej zabronić. Zmiany są zapisywane automatycznie.
4. W prawym górnym rogu kliknij Zamknij.

Modyfikowanie wartości parametrów

Edytujący raporty mogą modyfikować wartości parametrów za pomocą panelu ustawień komponentu raportu, a osoby wyświetlające raporty mogą to robić za pomocą adresu URL raportu.

Panel ustawień komponentu raportu

Aby dowiedzieć się, jak osoba edytująca raport może ustawiać wartości parametrów, przeczytaj artykuł Modyfikowanie parametrów w raporcie.

Parametry adresu URL raportu

W przypadku parametrów, które można modyfikować w adresie URL raportu, wartości można ustawiać za pomocą zakodowanego w formacie URL obiektu JSON dołączonego do adresu URL raportu w trybie widoku.

Aby utworzyć konfigurację adresu URL:

1. Zbieranie nazw parametrów

   1. Przeprowadź edycję raportu.
   2. Kliknij Zasób –> Zarządzaj parametrami raportu.
   3. Zanotuj nazwy parametrów, które chcesz ustawić za pomocą adresu URL raportu.

   Na przykład na ilustracji poniżej nazwa parametru to ds0.zipcode.

   

2. Tworzenie obiektu parametru

   Parametry są definiowane za pomocą obiektu JSON. Kluczami wartości parametrów są nazwy parametrów.

   {
     "parameterName": parameterValue
   }
   

   Typy wartości parametrów to STRING, NUMBER lub BOOLEAN. W przypadku parametrów, które akceptują wiele wartości (np. menu wielokrotnego wyboru), użyj tablicy wartości.

   Jeśli np. nazwa parametru to ds0.zipcode, aby ustawić kod pocztowy na 94094, kod JSON będzie wyglądać tak:

   {
     "ds0.zipcode": "94094"
   }
   

3. Zakoduj obiekt parametru w formacie URL.

   Po utworzeniu obiektu parametru użyj funkcji JSON.stringify(), aby przekształcić go w ciąg znaków, a następnie użyj funkcji [encodeURIComponent], aby zakodować go w formacie adresu URL.

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

   W wyniku tego powstanie ten zakodowany ciąg znaków:

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

4. Tworzenie adresu URL raportu

   Gdy uzyskasz obiekt parametru zakodowany w adresie URL, dołącz go do adresu URL widoku raportu, używając parametru zapytania params.

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

   Zastąp REPORT_ID i PAGE_ID wartościami raportu i strony.

5. Używanie adresu URL

   Adres URL raportu zastąpi parametry zdefiniowane w obiekcie parametrów JSON na podstawie dziedziczenia parametrów.

Przykład obiektu parametru

Obiekt parametru poniżej pokazuje, jak ustawić wiele parametrów. Pokazuje też, jak ustawiać wartości parametrów dla różnych typów danych wejściowych.

• ds0.includeToday to pole wyboru
• ds0.units to pole jednokrotnego wyboru.
• ds1.countries to pole wielokrotnego wyboru
• ds1.labelName to pole tekstowe.

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

Dziedziczenie parametrów

Wartość używana w przypadku parametru jest określana na podstawie kolejności ważności zależnej od miejsca, w którym parametr jest ustawiony. Parametry ustawione w lokalizacjach o wyższym priorytecie zastępują parametry ustawione w lokalizacjach o niższym priorytecie. Kolejność pierwszeństwa (od najniższego do najwyższego):

1. Źródło danych (domyślne)
2. URL zgłoszenia
3. panel ustawień komponentu raportu zgodnie z regułami dziedziczenia parametrów źródła danych.