פרמטרים של config שניתנים לשינוי

פרמטרים של הגדרת תצורה שאפשר לשנות מאפשרים לעורכי דוחות לשנות ערכי ברירת מחדל במקור נתונים. הגדרת פרמטרים של תצורה כפרמטרים שאפשר לשנות הופכת את מקור הנתונים לגמיש יותר, ומאפשרת למשתמשים ליצור תבניות דוחות שניתנות להגדרה על ידי המשתמש.

לדוגמה, מחבר שמספק נתוני מזג אוויר יכול לכלול פרמטר מיקום שמאפשר לצופים בדוח לבקש דוח מזג אוויר ממיקום שונה מהמיקום שמוגדר כברירת מחדל.

במאמר הזה מוסבר איך מגדירים פרמטרים שאפשר לשנות, איך מאפשרים שינוי שלהם ואיך משתמשים בדוחות יכולים לשנות את ערכי הפרמטרים. מידע נוסף על השימוש בפרמטרים ב-Data Studio זמין במאמר פרמטרים של מקור נתונים.

תפקידים

תפקידי המשתמשים שמוזכרים לאורך המסמך:

תפקיד הגדרה
מפתח מחברים משתמש שבנה פלאגין חיבור למקור נתונים.
הבעלים של מקור הנתונים משתמש שיצר מקור נתונים והוא הבעלים שלו.
כלי הדוחות משתמש עם גישה לדוח במצב עריכה.
משתמש עם הרשאת צפייה בדוח משתמש עם גישה לדוח במצב צפייה.

הגדרת פרמטרים שאפשר לשנות

מפתח פלאגין חיבור למקור נתונים מגדיר פרמטרים של הגדרות בפונקציה getConfig() של פלאגין חיבור למקור נתונים. כדי להגדיר פרמטר של הגדרות כפרמטר שאפשר לשנות, מחבר קורא ל-setAllowOverride(true).

בדוגמה הבאה מוגדרים 2 פרמטרים שאפשר לשנות: zipcode ו-units, ופרמטר אחד שלא ניתן לשינוי: days-to-forcecast.

צילום מסך של 2 פרמטרים שאפשר לשנות

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

מתי לא כדאי להגדיר פרמטר כפרמטר שאפשר לשנות

מומלץ לקרוא את המאמר [איך Data Studio מתחבר לנתונים שלכם] כדי להבין איך מחברים, מקורות נתונים ודוחות פועלים ביחד.

לא מומלץ להגדיר פרמטר כניתן לשינוי במקרים הבאים:

  1. מתי הערך של פרמטר משפיע על הסכימה.
    • אם משתמש משנה ערך פרמטר והסכימה של הנתונים החדשים שמוחזרים שונה מהסכימה שמוגדרת במקור הנתונים, יכול להיות שדוחות שתלויים במקור הנתונים ייפגמו בגלל שדות חסרים.
  2. אם ערך פרמטר שולט במידע אישי רגיש. לדוגמה, בחירת חשבון.
    • אל תגדירו פרמטר כניתן לשינוי אם אתם רוצים למנוע צפייה לא מכוונת במידע אישי רגיש או שיתוף לא מכוון של מידע אישי רגיש.

הפעלת פרמטרים למשתמשי דוחות

בעלי מקורות הנתונים קובעים אילו פרמטרים שאפשר לשנות עורכי הדוחות יכולים לשנות. באופן דומה, משתמשים עם הרשאת עריכה בדוח קובעים אילו פרמטרים צופים בדוח יכולים לשנות.

לאפשר לבעלי הרשאת עריכה בדוח לשנות את ערכי הפרמטרים

הבעלים של מקור הנתונים קובע אילו פרמטרים אפשר לשנות בדוחות. ההגדרה הזו מתבצעת במהלך יצירה או עריכה של מקור נתונים, והיא רלוונטית רק לפרמטרים שמפתחי המחברים הגדירו כפרמטרים שאפשר לשנות. אם האפשרות הזו מופעלת, משתמשים עם הרשאת עריכה בדוח יוכלו לשנות את הפרמטרים בדוח.

בדוגמה הבאה, למחבר יש 2 פרמטרים שמוגדרים כפרמטרים שאפשר לשנות: zipcode ו-units. הבעלים של מקור הנתונים הרשה רק את השינוי של zipcode בדוחות. בדוח, בכלי הדוחות יש אפשרות לשנות את ערך הפרמטר zipcode.

הפעלת האפשרות לשינוי ברירת המחדל

לאפשר לצופים בדוח לשנות את ערכי הפרמטרים

עורכי דוחות קובעים אילו פרמטרים צופים בדוחות יכולים לשנות. לאחר מכן, כל מי שיש לו גישה לדוח יכול לשנות את ערכי הפרמטרים דרך כתובת ה-URL של הדוח.

לדוגמה, נניח שיש מחבר עם 2 פרמטרים שמוגדרים כפרמטרים שאפשר לשנות את הערך שלהם: zipcode ו-units (איור 1). אם הבעלים של מקור הנתונים אפשר לשנות את zipcode בדוחות (איור 2), אז בעלי הרשאת עריכה בדוח יוכלו רק לאפשר לצופים בדוח לשנות את zipcode. לעורך הדוחות לא תהיה גישה או נראות שיאפשרו למשתמשים עם הרשאת צפייה בדוחות לשנות את הפרמטר units.

הפרמטר של המיקוד מופעל
איור 1: הגדרת מחבר.

אפשר לשנות רק את הפרמטר של המיקוד
איור 2: ניהול פרמטרים.

פרמטרים של כתובת אתר

כדי לאפשר לצופים בדוחות לערוך ערכי פרמטרים דרך כתובת ה-URL של הדוח:

  1. עורכים את הדוח.
  2. בוחרים באפשרות מקור -> ניהול פרמטרים של דוחות.
  3. משתמשים בתיבות הסימון לאפשר שינוי בכתובת ה-URL של הדוח כדי לאפשר או לא לאפשר שינוי של ערכי הפרמטרים בכתובת ה-URL של הדוח. השינויים נשמרים אוטומטית.
  4. לוחצים על סגירה בפינה השמאלית העליונה.

שינוי ערכי פרמטרים

משתמשים עם הרשאת עריכה בדוחות יכולים לשנות ערכי פרמטרים באמצעות חלונית מאפייני הדוח, ומשתמשים עם הרשאת צפייה בדוחות יכולים לשנות ערכי פרמטרים באמצעות כתובת האתר של הדוח.

חלונית המאפיינים של הדוח

כדי ללמוד איך עורכי דוחות יכולים להגדיר ערכי פרמטרים, אפשר לעיין במאמר שינוי פרמטרים בדוח.

פרמטרים של כתובת URL בדוח

לפרמטרים שמותר לשנות בכתובת ה-URL של הדוח, אפשר להגדיר ערכים באמצעות אובייקט JSON מקודד בכתובת ה-URL, שמצורף לכתובת ה-URL של הדוח במצב תצוגה.

כדי ליצור הגדרת כתובת URL:

  1. איסוף שמות של פרמטרים

    1. עורכים את הדוח.
    2. בוחרים באפשרות מקור -> ניהול פרמטרים של דוחות.
    3. שימו לב לשמות הפרמטרים שאתם מתכוונים להגדיר באמצעות כתובת ה-URL של הדוח.

    לדוגמה, באיור שלמטה שם הפרמטר הוא ds0.zipcode.

    הפעלת פרמטרים של כתובות אתרים

  2. יצירת אובייקט הפרמטר

    הפרמטרים מוגדרים באמצעות אובייקט JSON. המפתחות של ערכי הפרמטרים הם שמות הפרמטרים.

    {
  "parameterName": parameterValue
}

    סוגי ערכי הפרמטרים הם STRING,‏ NUMBER או BOOLEAN. לפרמטרים שמקבלים כמה ערכים (כלומר, תפריטים נפתחים עם אפשרות לבחירת כמה ערכים), צריך להשתמש במערך של ערכים.

    לדוגמה, אם שם הפרמטר הוא ds0.zipcode, כדי להגדיר את המיקוד ל-94094, קובץ ה-JSON יהיה כזה:

    {
  "ds0.zipcode": "94094"
}

  3. קידוד URL של אובייקט הפרמטר

    אחרי שיוצרים את אובייקט הפרמטר, משתמשים ב-JSON.stringify() כדי להפוך אותו למחרוזת, ואז משתמשים ב-[encodeURIComponent] כדי לבצע קידוד URL.

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

    התוצאה היא המחרוזת המקודדת הבאה:

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

  4. יצירת כתובת ה-URL של הדוח

    אחרי שיוצרים את אובייקט הפרמטר עם קידוד כתובת ה-URL, מוסיפים אותו לכתובת ה-URL של תצוגת הדוח באמצעות פרמטר השאילתה params.

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

    חשוב להחליף את REPORT_ID ו-PAGE_ID בערכים של הדוח והדף שלכם.

  5. שימוש בכתובת ה-URL

    כתובת ה-URL של הדוח תבטל פרמטרים כמו שהם מוגדרים באובייקט הפרמטרים של JSON על סמך העברת פרמטרים בירושה.

דוגמה לאובייקט פרמטר

באובייקט הפרמטרים הבא אפשר לראות איך מגדירים כמה פרמטרים. הוא גם מראה איך מגדירים ערכי פרמטרים לסוגי הקלט השונים.

  • ‫ds0.includeToday הוא קלט של תיבת סימון
  • ‫ds0.units הוא קלט עם אפשרות בחירה אחת
  • ds1.countries הוא קלט עם אפשרות לבחירה מרובה
  • ‫ds1.labelName הוא קלט טקסט.
  {
    "ds0.includeToday": true,
    "ds0.units": "Metric",
    "ds1.countries": ["Canada", "Mexico"],
    "ds1.labelName": "Population"
  }

ירושה של פרמטרים

הערך שמשמש לפרמטר נקבע לפי סדר עדיפות שנקבע על סמך המקום שבו הפרמטר מוגדר. פרמטרים שמוגדרים במיקומים עם עדיפות גבוהה יותר מבטלים פרמטרים שמוגדרים במיקומים עם עדיפות נמוכה יותר. סדר העדיפות (מהנמוך לגבוה) הוא:

  1. מקור נתונים (ברירת מחדל)
  2. כתובת URL לדיווח
  3. חלונית מאפייני הדוח, בהתאם לכללי ירושת הפרמטרים של מקור הנתונים.