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

Zastępowane parametry konfiguracji umożliwiają wprowadzanie zmian przez osoby edytujące raporty domyślnych wartościach w źródle danych. Definiowanie parametrów konfiguracji jako możliwych do zastąpienia bardziej elastyczne źródło danych i umożliwia użytkownikom szablonów raportów.

Na przykład oprogramowanie sprzęgające udostępniające dane pogodowe może zawierać lokalizację parametr, który pozwala zgłosić przeglądającym prośbę o raport pogodowy z danego języka. różni się od domyślnego.

W tym dokumencie opisujemy sposób definiowania zastępowanych parametrów oraz włączania ich dla oraz sposób zmiany wartości parametrów przez użytkowników raportu. Aby się uczyć więcej informacji o użyciu parametrów w Looker Studio znajdziesz Parametry źródła danych.

Role

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

Rola Definicja
Programista 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.
Przeglądarka raportów Użytkownik z dostępem w trybie wyświetlania do raportu.

Definiowanie zastępowanych parametrów

Deweloper oprogramowania sprzęgającego definiuje parametry konfiguracji w Funkcja getConfig() w argumencie społecznościowego oprogramowania sprzęgającego. Aby zdefiniować parametr konfiguracji jako możliwy do zastąpienia w oprogramowaniu sprzęgającym dzwoni pod numer setAllowOverride(true).

Ten przykład definiuje 2 parametry, które można zastępować: zipcode i units i 1 parametr, którego nie można zastąpić: days-to-forcecast.

Zrzut ekranu przedstawiający 2 parametry, które można zastępować

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();
}

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

Warto zapoznać się z działaniem oprogramowania sprzęgającego, źródeł danych i raportów znajdziesz w artykule Jak Looker Studio łączy się z Twoimi danymi.

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

  1. Gdy wartość parametru wpływa na schemat.
    • Jeśli użytkownik zmieni wartość parametru i schemat nowych danych zwracany jest inny niż zdefiniowany w źródle danych, w zależności od źródła danych może spowodować awarię z powodu brakujących pól.
  2. Czy 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 niezamierzonego wyświetlenia lub udostępnienia danych wrażliwych.

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

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

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

Właściciel źródła danych określa, które parametry mogą być modyfikowane w raportów. Jest to konfigurowane podczas tworzenia lub edytowania źródła danych i jest ma zastosowanie tylko do parametrów, które zostały zdefiniowane jako możliwe do zastąpienia przez oprogramowanie sprzęgające . Jeśli włączysz tę opcję, edytorzy raportów będą mogli Modyfikować parametrów w raporcie.

W poniższym 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 dostęp tylko do źródła danych zipcode zmodyfikowane w raportach. W raporcie edytor raportów może edytować wartość parametru zipcode.

Włączam opcję zastępowania

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

Osoby edytujące raporty określają, które parametry mogą być modyfikowane przez osoby przeglądające raporty. Wartości parametrów mogą następnie modyfikować za pomocą adresu URL raportu. w odniesieniu do raportu.

Weźmy na przykład oprogramowanie sprzęgające, które ma 2 określone parametry, które można zastąpić: zipcode i units (ilustracja 1). Jeśli właściciel źródła danych zezwolił zipcode do zmodyfikowania w raportach (ilustracja 2), a edytujący raporty musi umożliwiać przeglądanie raportu parametr zipcode. Raport Editor nie będzie mieć dostępu ani widoczności, które pozwoliłyby parametr units na zmodyfikowane przez osoby przeglądające raport.

Parametr kodu pocztowego włączony
Rysunek 1. Konfiguracja oprogramowania sprzęgającego.

Można modyfikować tylko parametr Kod pocztowy
Rys. 2: Zarządzanie parametrami.
.

Parametry adresu URL

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

  1. Przeprowadź edycję raportu.
  2. Wybierz Zasób -> Zarządzaj parametrami adresów URL raportów.
  3. Zaznacz pola wyboru Zezwalaj na modyfikowanie w adresie URL raportu, aby zezwolić na zabronić modyfikacji wartości parametrów w adresie URL raportu. Zmiany są automatycznie zapisane.
  4. W prawym górnym rogu kliknij Zamknij.

Zmiana wartości parametrów

Edytujący raporty mogą zmieniać wartości parametrów za pomocą panelu właściwości raportu. a przeglądający raporty mogą zmieniać wartości parametrów, korzystając z adresu URL raportu.

Panel właściwości raportu

Informacje o tym, jak edytor raportów może ustawiać wartości parametrów: Modyfikować parametrów w raporcie.

Parametry adresu URL raportu

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

Aby utworzyć konfigurację adresu URL:

  1. Zbierz nazwy parametrów

    1. Przeprowadź edycję raportu.
    2. Wybierz Zasób -> Zarządzaj parametrami adresów URL raportów.
    3. Zapisz nazwy parametrów, które chcesz ustawiać w raporcie Adres URL.

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

    Włączam parametry adresu URL

  2. Tworzenie obiektu parametru

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

    {
      "parameterName": parameterValue
    }
    

    Typy wartości parametrów to STRING, NUMBER i BOOLEAN. Dla: , które akceptują wiele wartości (np. menu wielokrotnego wyboru), używają funkcji tablicę wartości.

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

    {
      "ds0.zipcode": "94094"
    }
    
  3. Kodowanie obiektu parametru w adresie URL

    Po utworzeniu obiektu parametru użyj JSON.stringify(), aby go zmienić w ciągu znaków, a następnie zakoduj go w adresie URL za pomocą elementu [encodeURIKomponent].

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

    W efekcie otrzymasz taki zakodowany ciąg:

    "%7B%22ds0.zipcode%22%3A%2294094%22%7D"
    
  4. Tworzenie adresu URL raportu

    Po zakodowaniu obiektu parametru URL dołącz go do widoku raportu Adres URL z parametrem zapytania params.

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

    Pamiętaj, by zastąpić REPORT_ID i PAGE_ID wartościami dla w raporcie i na stronie.

  5. Użyj adresu URL

    Adres URL raportu zastąpi parametry zdefiniowane w parametrach JSON w oparciu o dziedziczenie parametrów.

Przykład obiektu parametru

Poniższy obiekt parametru pokazuje, jak ustawić większą liczbę parametrów. Dodatkowo pokazuje ustawianie wartości parametrów dla różnych typów danych wejściowych.

  • ds0.includeToday to pole wyboru
  • ds0.units to dane wejściowe do wyboru
  • ds1.countries to pole do wprowadzania danych 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żyta w parametrze jest zgodna z kolejnością pierwszeństwa wynikającą z miejsca parametru . Parametry ustawione w lokalizacjach o wyższym priorytecie zastępują w lokalizacjach o niższym priorytecie. Kolejność obowiązywania zasad (od od najniższej do najwyższej) to:

  1. Źródło danych (domyślnie)
  2. URL raportu
  3. Panel właściwości raportu, po źródle danych dziedziczenia parametrów.