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

Zastępowane parametry konfiguracji umożliwiają edytującym raporty modyfikowanie wartości domyślnych w źródle danych. Ustawienie parametrów konfiguracyjnych jako możliwych do zastąpienia sprawia, że źródło danych jest bardziej elastyczne, i umożliwia użytkownikom tworzenie możliwych do skonfigurowania szablonów raportów.

Na przykład oprogramowanie sprzęgające dostarczające dane o pogodzie może zawierać parametr lokalizacji, który umożliwia użytkownikom wysyłanie próśb o raport o pogodzie z innego języka niż domyślny.

W tym dokumencie opisujemy sposób definiowania parametrów zastępowanych, włączania ich do modyfikowania oraz modyfikowania wartości parametrów przez użytkowników raportów. Więcej informacji o sposobie wykorzystywania parametrów w Looker Studio znajdziesz w artykule Parametry źródła danych.

Role

Role użytkowników, do których odwołuje się dokument:

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 uprawnieniami do edycji raportu w trybie edycji.
Przeglądający raporty	Użytkownik z uprawnieniami do wyświetlania raportu w trybie wyświetlania.

Definiowanie parametrów możliwych do zastępowania

Deweloper oprogramowania sprzęgającego definiuje parametry konfiguracji w funkcji getConfig() społecznościowego oprogramowania sprzęgającego. Aby zdefiniować parametr konfiguracji jako możliwy do zastąpienia, oprogramowanie sprzęgające wywołuje metodę setAllowOverride(true).

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

Ten przykład określa 2 parametry, które można zastąpić: zipcode i units, oraz 1 parametr, którego nie można zastąpić: 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łączać zastępowania parametru, możesz pominąć wywołanie setAllowOverride().

Kiedy należy unikać definiowania parametru jako możliwego do zastąpienia

Warto dowiedzieć się, jak oprogramowanie sprzęgające, źródła danych i raporty są ze sobą powiązane. Zapoznaj się z artykułem Jak Looker Studio łączy się z Twoimi danymi.

Unikaj definiowania parametru jako możliwego do zastąpienia w tych przypadkach:

1. Kiedy wartość parametru wpływa na schemat.
   • Jeśli użytkownik zmieni wartość parametru, a schemat zwracanych danych będzie się różnić od zdefiniowanego w źródle danych, każdy raport zależny od źródła danych może nie działać z powodu brakujących pól.
2. Jeśli wartość parametru kontroluje dane wrażliwe. Na przykład wybór konta.
   • Nie definiuj parametru jako możliwego do zastąpienia, jeśli chcesz zapobiec przypadkowemu wyświetlaniu lub udostępnianiu danych wrażliwych.

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

Właściciele źródła danych określają, które parametry zastępowane mogą być modyfikowane przez edytorów raportów. Podobnie edytujący raporty określają, które parametry mogą być modyfikowane przez osoby przeglądające raport.

Zezwalaj edytorom raportów na modyfikowanie wartości parametrów

Właściciel źródła danych określa, które parametry można zmieniać w raportach. Jest ona konfigurowana podczas tworzenia lub edytowania źródła danych i ma zastosowanie tylko w przypadku parametrów, które zostały zdefiniowane jako zastąpione przez dewelopera oprogramowania sprzęgającego. Jeśli ta opcja jest włączona, edytujący raporty będą mogli modyfikować parametry w raporcie.

W tym przykładzie oprogramowanie sprzęgające ma 2 parametry zdefiniowane jako możliwe do zastąpienia: zipcode i units. Właściciel źródła danych zezwolił na modyfikowanie w raportach tylko tych elementów (zipcode). W raporcie edytor raportów może zmieniać wartość parametru zipcode.

Zezwalaj osobom przeglądającym raport na modyfikowanie wartości parametrów

Edytujący raporty określają, które parametry mogą być modyfikowane przez osoby przeglądające raport. Wartości parametrów mogą być następnie modyfikowane w adresie URL raportu przez dowolną osobę przeglądającą raport.

Uwaga: opcja edytora raportów nad zezwalaniem na modyfikowanie parametrów jest ograniczona do parametrów dozwolonych przez właściciela źródła danych.

Przeanalizujmy na przykład oprogramowanie sprzęgające, które ma 2 parametry zdefiniowane jako możliwe do zastąpienia: zipcode i units (ilustracja 1). Jeśli właściciel źródła danych zezwolił na modyfikację elementu zipcode w raportach (ilustracja 2), edytujący raporty będą mogli tylko zezwalać na modyfikowanie elementu zipcode przez osoby przeglądające raport. Edytor raportów nie będzie mieć dostępu ani widoczności umożliwiającej modyfikowanie parametru units przez osoby przeglądające raport.

Rysunek 1.Konfiguracja oprogramowania sprzęgającego

Rysunek 2. Zarządzanie parametrami.

Ostrzeżenie: Przeglądający raporty będą mieli dostęp do wszystkich danych, nad którymi sterują parametry. Aby uniknąć przypadkowego udostępnienia danych wrażliwych, przed zezwoleniem na modyfikację parametru sprawdź i potwierdź, że źródło danych i dane logowania do źródła danych są prawidłowo skonfigurowane. Jeśli parametr umożliwia dostęp do danych wrażliwych, warto użyć danych logowania osoby przeglądającej, aby mieć pewność, że osoba przeglądająca raport będzie mogła zobaczyć tylko jego dane.

Parametry adresu URL

Aby umożliwić osobom przeglądającym raport edytowanie wartości parametrów za pomocą adresu URL raportu:

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

Modyfikowanie wartości parametrów

Osoby edytujące raporty mogą zmieniać wartości parametrów w panelu właściwości raportu, a osoby przeglądające raporty mogą zmieniać wartości parametrów z poziomu adresu URL raportu.

Panel właściwości raportu

Więcej informacji o tym, jak edytor raportów może ustawiać wartości parametrów, znajdziesz w artykule 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 ustawić za pomocą zakodowanego w adresie 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 adresu URL raportu.
   3. Zapisz nazwy parametrów, które chcesz ustawić w adresie URL raportu.

   Na przykład na ilustracji pod nazwą parametru jest ds0.zipcode.

   

2. Tworzenie obiektu parametru

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

   {
     "parameterName": parameterValue
   }
   

   Typy wartości parametru to STRING, NUMBER lub BOOLEAN. W przypadku parametrów, które akceptują wiele wartości (np. menu z możliwością 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. Kodowanie obiektu parametru URL

   Po utworzeniu obiektu parametru użyj funkcji JSON.stringify(), aby przekształcić go w ciąg znaków, a następnie zakoduj go za pomocą polecenia [encodeuriKomponent].

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

   Wynikiem jest ten zakodowany ciąg znaków:

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

4. Tworzenie adresu URL raportu

   Gdy będziesz już mieć zakodowany w adresie URL obiekt parametru, dołącz go do adresu URL widoku raportu, korzystając z parametru zapytania params.

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

   Pamiętaj, aby zastąpić REPORT_ID i PAGE_ID wartościami raportu i strony.

5. Użyj adresu URL

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

Przykład obiektu parametru

Poniższy obiekt parametrów pokazuje, jak ustawić wiele parametrów. Pokazuje też wartości parametrów dla różnych typów danych wejściowych.

• Pole ds0.includeToday jest polem wyboru
• ds0.units to pojedyncze pole wejściowe
• 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 parametrze ma kolejność nadrzędności zależną od miejsca, w którym go ustawiono. Parametry ustawione w lokalizacjach o wyższym priorytecie zastępują te ustawione w miejscach o niższym priorytecie. Kolejność pierwszeństwa (od najniższego do najwyższej)

1. Źródło danych (domyślnie)
2. URL raportu
3. w panelu właściwości raportu zgodnie z regułami dziedziczenia parametrów ze źródła danych.