ממשק API לקישור

מבוא

ממשק Linking API מספק ממשק אמין להגדרה ולהעברה של משתמשים ישירות לדוח Data Studio באמצעות כתובת URL. כשמשתמשים לוחצים על כתובת URL של Linking API, הם יכולים לראות את הנתונים שלהם ולקיים איתם אינטראקציה במהירות ובקלות.

במסמך הזה מוסבר על הפורמט הנדרש של כתובות URL של Linking API ועל הפרמטרים הזמינים.

תרחיש שימוש ויתרונות

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

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

איך זה עובד

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

קישור תהליך עבודה של מפתח API

המפתח מכין את דוחות התבניות, מקורות הנתונים ומעצב כתובת URL של Linking API. תהליך העבודה הטיפוסי למפתחים הוא כזה:

  1. מחליטים אם להשתמש בדוח ריק, בתבנית הדוח שמוגדרת כברירת מחדל ב-Data Studio או ליצור דוח ב-Data Studio שישמש כתבנית. הפעולה הזו כוללת הגדרה של מקורות הנתונים של התבנית.
  2. יוצרים כתובת URL של Linking API שמתאימה לתרחיש השימוש הספציפי. אם רלוונטי, מציינים את תבנית הדוח ופרמטרים אחרים, כולל שם הדוח, שם מקור הנתונים והגדרות מקור הנתונים.
  3. משתמשים בכתובת ה-URL של Linking API כדי להפנות משתמשים לדוח.

חוויית המשתמש בקישור API

המשתמש לוחץ על כתובת URL של Linking API, שאם המפתח הגדיר אותה בצורה נכונה, היא תפנה אותו לדוח ב-Data Studio שבו הוא יוכל לראות את הנתונים שיש לו גישה אליהם ולבצע פעולות שקשורות לנתונים. חוויית משתמש אופיינית יכולה להיות כזו:

  1. בדפדפן, המשתמש נכנס לשירות שמשולב עם Linking API.
  2. הקריאה לפעולה מזמינה את המשתמש ללחוץ על קישור כדי לראות את הנתונים שלו ב-Data Studio.
  3. המשתמש לוחץ על הקישור ומועבר לדוח ב-Data Studio. הדוח נטען והמשתמש יכול לראות את הנתונים שלו ולבצע איתם אינטראקציה.
  4. המשתמש לוחץ על 'עריכה ושיתוף'. הדוח נשמר בחשבון שלו ב-Data Studio.
  5. למשתמש יש עכשיו גישה מלאה לדוח והוא יכול לשלוט בעותק שלו. הם יכולים לצפות, לערוך ולשתף בכל שלב.

דרישות

כדי לוודא שכתובת URL של Linking API פועלת כמצופה, צריך:

  1. דוח, שישמש כתבנית. אם לא מספקים דוח, אפשר להשתמש בדוח ריק או בדוח ברירת מחדל ש-Data Studio מספק.
  2. למשתמשים בכתובת URL של Linking API צריכה להיות לפחות הרשאת צפייה בדוח התבנית. בהתאם לסוג מקורות הנתונים שמשמשים בדוח ולהגדרה שסופקה דרך Linking API, יכול להיות שמשתמשים יצטרכו גם גישת צפייה למקורות הנתונים. פרטים נוספים זמינים במאמר בנושא הרשאות לתבניות.
  3. סוג המחבר של כל מקור נתונים צריך לתמוך בהגדרה דרך Linking API. רשימה של מחברים נתמכים זמינה בחומרי העזר בנושא מחברים.
  4. למשתמשים בכתובת ה-URL של Linking API צריכה להיות גישה לנתונים שהוגדרו בכתובת ה-URL של Linking API. אם למשתמש אין גישה לנתונים הבסיסיים, יוצג שגיאה בכל רכיבי הדוחות שתלויים בנתונים האלה.

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

כתובת URL של Linking API חייבת להיות בפורמט הבא:

https://lookerstudio.google.com/reporting/create?parameters

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

כתובת URL לדוגמה

הנה דוגמה לכתובת URL של Linking API. השם של הדוח מוגדר ומקור נתונים יחיד של BigQuery מוגדר:

https://lookerstudio.google.com/reporting/create?
  c.reportId=12345
  &r.reportName=MyNewReport
  &ds.ds0.connector=bigQuery
  &ds.ds0.datasourceName=MyNewDataSource
  &ds.ds0.projectId=project-1234
  &ds.ds0.type=TABLE
  &ds.ds0.datasetId=456
  &ds.ds0.tableId=789

חלק מהפרמטרים של כתובות ה-URL הם חובה, וחלקם אופציונליים. זוהי רשימה של פרמטרים שמשמשים להגדרת כתובת URL של Linking API:

פרמטרים של בקרה

פרמטרים של בקרה קובעים את מצב הדוח כשצופים בו באמצעות כתובת ה-URL של Linking API.

שם הפרמטר תיאור
c.reportId
אופציונלי. מזהה הדוח של התבנית. ‫Data Studio ייפתח ויגדיר את הדוח שצוין. הוראות לאיתור המזהה מפורטות במאמר בנושא מזהה הדיווח. אם לא מציינים תבנית, המערכת משתמשת בדוח ריק או בתבנית דוח שמוגדרת כברירת מחדל. פרטים נוספים זמינים במאמר בנושא שימוש בדוח ריק או בדוח שמוגדר כברירת מחדל.
c.pageId
אופציונלי. המזהה של הדף הראשוני שנטען בדוח. אם לא מצוין ערך, ברירת המחדל היא הדף הראשון של הדוח.
c.mode
אופציונלי. מצב הדוח הראשוני. אחת מהאפשרויות הבאות: view או edit. אם לא מציינים ערך, ברירת המחדל היא view.
c.explain
אופציונלי. האם תיבת הדו-שיח עם המידע או ניפוי הבאגים גלויה. ההגדרה צריכה להיות true כדי להציג את לחצן תיבת הדו-שיח. אם לא מציינים ערך, ברירת המחדל היא false. מידע נוסף זמין במאמר פתרון בעיות בהגדרות.

דוגמה

https://lookerstudio.google.com/reporting/create?
  c.reportId=12345
  &c.pageId=g7u8s9
  &c.mode=edit
  &r.reportName=MyNewReport
  &ds.ds0.datasourceName=MyNewDataSource
  &ds.ds0.connector=bigQuery
  &ds.ds0.projectId=project-1234
  &ds.ds0.type=TABLE
  &ds.ds0.datasetId=456
  &ds.ds0.tableId=789

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

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

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

אופציונלי. מגדיר את מזהי המדידה של Google Analytics לערך Measure report usage. אם אתם מזינים כמה מספרים, צריך להפריד ביניהם באמצעות פסיקים.

אם לא מציינים את r.measurementId ואת r.keepMeasurementId הגדרת הדוח מזהי מדידה של Google Analytics תוגדר כברירת מחדל לערך 'לא מוגדר'. אם המדיניות r.measurementId וגם המדיניות r.keepMeasurementId מוגדרות, המדיניות r.keepMeasurementId מקבלת עדיפות בהגדרת המזהה.
r.keepMeasurementId

אופציונלי. הערך true מציין שימוש בדוח התבנית מזהי המדידה של Google Analytics. אם לא מציינים ערך, ברירת המחדל היא false.

אם לא מציינים את r.measurementId ואת r.keepMeasurementId הגדרת הדוח מזהי מדידה של Google Analytics תוגדר כברירת מחדל לערך 'לא מוגדר'. אם המדיניות r.measurementId וגם המדיניות r.keepMeasurementId מוגדרות, המדיניות r.keepMeasurementId מקבלת עדיפות בהגדרת המזהה.

דוגמה

https://lookerstudio.google.com/reporting/create?
  c.reportId=12345
  &r.reportName=MyNewReport
  &r.measurementId=G-XXXXXXXXXX
  &ds.ds0.datasourceName=MyNewDataSource
  &ds.ds0.connector=bigQuery
  &ds.ds0.projectId=project-1234
  &ds.ds0.type=TABLE
  &ds.ds0.datasetId=456
  &ds.ds0.tableId=789

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

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

משתמשים ב-alias כדי להפנות למקור נתונים בדוח קיים. שימוש בכינוי מאפשר תאימות לאחור אם מוסיפים או מסירים מקור נתונים מדוח התבנית.

לפרטים על איתור מקור נתונים alias, אפשר לעיין במאמר בנושא כינוי של מקור נתונים.

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

הפרמטרים הבאים משותפים לכל סוגי המחברים:

שם תיאור
ds.alias.datasourceName

אופציונלי. הגדרת השם של מקור הנתונים.

אם לא מציינים את ds.datasourceName ואת ds.keepDatasourceName, שם מקור הנתונים מוגדר כברירת מחדל לפי מוסכמת שמות שכוללת את סוג המחבר ואת שעת היצירה (לדוגמה, samples - 12/12/21, 10:53 PM). אם ההגדרות ds.datasourceName ו-ds.keepDatasourceName מוגדרות, ההגדרה ds.datasourceName מקבלת עדיפות בקביעת השם של מקור הנתונים.
ds.alias.keepDatasourceName

אופציונלי. הערך true מאפשר להשתמש בשם של מקור הנתונים של התבנית. אם לא מציינים ערך, ברירת המחדל היא false.

אם לא מציינים את ds.datasourceName ואת ds.keepDatasourceName, שם מקור הנתונים מוגדר כברירת מחדל לפי מוסכמת שמות שכוללת את סוג המחבר ואת שעת היצירה (לדוגמה, samples - 12/12/21, 10:53 PM). אם ההגדרות ds.datasourceName ו-ds.keepDatasourceName מוגדרות, ההגדרה ds.datasourceName מקבלת עדיפות בקביעת השם של מקור הנתונים.
ds.alias.connector
אופציונלי.

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

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

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

מידע נוסף על ההשפעה של הפרמטר ds.connector על החלפה מלאה של הגדרות מקור נתונים של תבנית או על שימוש בהן לעדכון פרמטרים לא מוגדרים זמין במאמר החלפה לעומת עדכון.
ds.alias.refreshFields
אופציונלי.

הערך true מאפשר להשתמש בהגדרת מקור הנתונים שצוינה באמצעות Linking API כדי לרענן את השדות של מקור הנתונים ולעדכן את רכיבי הדוח עם בחירות חדשות של שדות. בדרך כלל מציינים את true כשמחליפים את סוג המחבר או כשמדובר בסוגי מחברים שבהם שינוי בהגדרות יוצר שדות שונים (למשל, שדות של מקורות נתונים ב-BigQuery משתנים לעיתים קרובות בהתאם להגדרות שונות של טבלאות).

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

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

שיקולים לשימוש ב-refreshFields:
  • אם הערך של refreshFields הוא false והשדות שמוגדרים במקור הנתונים באמצעות Linking API שונים מהשדות שמוגדרים בדוח התבנית, סביר להניח שהמשתמש יראה שגיאת הגדרה ברכיבים המושפעים.
  • שינויים בשדות במקור הנתונים של התבנית (למשל שם, סוג, צבירה וכו') לא מועברים למקורות נתונים חדשים כשההגדרה של refreshFields היא true. מגדירים את refreshFields ל-false כדי לשמור על הגדרות השדות ממקור הנתונים של התבנית.
  • שדות מחושבים ו פרמטרים שמוגדרים במקורות נתונים של תבניות תמיד יועתקו למקורות נתונים שנוצרו לאחרונה, ולא יושפעו מהערך של refreshFields.
ds.alias.connectorParameters
נדרש. ההגדרה של מקור הנתונים עבור סוג המחבר. במאמר סוג המחבר מוסבר איך לזהות את המחבר ששימש ליצירת מקור נתונים. פרטים על הפרמטרים של מקורות הנתונים שזמינים לכל סוג של מחבר מופיעים במאמר בנושא מחברים.

החלפה לעומת עדכון – הגדרות של מקורות נתונים

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

בטבלה הבאה מפורט איך הפרמטר ds.connector משפיע על האופן שבו מוחלף לחלוטין מקור נתונים של תבנית או על האופן שבו הוא משמש לעדכון פרמטרים לא מוגדרים:

האם השעה ds.connector מוגדרת? ההגדרה וההתנהגות הצפויות שימוש רגיל
כן החלפה. ההגדרה של מקור הנתונים בתבנית מוחלפת לחלוטין באמצעות הפרמטרים של מקור הנתונים שצוינו בכתובת ה-URL של Linking API. צריך לציין את כל הפרמטרים הנדרשים לסוג המחבר. פרמטרים נדרשים כשמגדירים את ds.connector
  • כשמשנים את סוג המחבר של מקור נתונים. לדוגמה, אם הגדרתם מקור נתונים של BigQuery בדוח התבנית, אבל אתם רוצים להגדיר מקור נתונים של Sheets באמצעות Linking API. לשם כך, צריך להגדיר מחדש את כל התצורה של המחבר.
  • כשרוצים להבטיח את ההגדרה של מקור נתונים. החלפת ההגדרה מונעת שימוש בערכים לא מוכרים ממקור הנתונים של התבנית.
לא עדכון. ההגדרה של מקור הנתונים של התבנית תשמש כדי לציין פרמטרים שלא סופקו בכתובת ה-URL של Linking API. כל הפרמטרים של מחבר מסוג מסוים הם אופציונליים, אלא אם צוין אחרת.

האפשרות הזו מפשטת את כתובת ה-URL של Linking API, ובדרך כלל מומלצת אם אתם מכירים את הגדרת מקור הנתונים של התבנית ורוצים לשנות רק קבוצת משנה של פרמטרים.
  • אם אתם רוצים לספק רק ערכי פרמטרים ששונים ממקור הנתונים של התבנית, ואתם מסכימים להסתמך על מקור הנתונים של התבנית לכל פרמטר של מחבר שלא צוין. לדוגמה: שינוי רק של מזהה פרויקט החיוב בהגדרת מקור נתונים ב-BigQuery ושימוש בהגדרת התבנית לכל הפרמטרים האחרים.

פרמטרים נדרשים כשהערך של ds.connector מוגדר

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

דוגמאות

מגדיר דוח עם מקור נתונים יחיד של BigQuery ‏ (ds0) ומחליף את ההגדרה של מקור הנתונים במלואה:

https://lookerstudio.google.com/reporting/create?
  c.reportId=12345
  &r.reportName=MyNewReport
  &ds.ds0.datasourceName=MyNewDataSource
  &ds.ds0.connector=bigQuery
  &ds.ds0.type=TABLE
  &ds.ds0.projectId=bigquery-public-data
  &ds.ds0.datasetId=samples
  &ds.ds0.tableId=shakespeare

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

https://lookerstudio.google.com/reporting/create?
  c.reportId=12345
  &r.reportName=MyNewReport
  &ds.datasourceName=MyNewDataSource
  &ds.connector=bigQuery
  &ds.type=TABLE
  &ds.projectId=bigquery-public-data
  &ds.datasetId=samples
  &ds.tableId=shakespeare

מגדיר דוח עם מקור נתונים יחיד של BigQuery‏ (ds0) ומעדכן רק את מזהה פרויקט החיוב של מקור הנתונים:

https://lookerstudio.google.com/reporting/create?
  c.reportId=12345
  &r.reportName=MyNewReport
  &ds.ds0.billingProjectId=my-billing-project

מגדיר דוח עם שני מקורות נתונים, מקור נתונים של BigQuery ‏ (ds0) ומקור נתונים של Google Analytics ‏ (ds1). ההגדרה של מקור הנתונים של BigQuery מוחלפת במלואה, ואילו ההגדרה של Google Analytics מעדכנת פרמטר יחיד ומסתמכת על מקור הנתונים של התבנית ds1 לכל פרמטר לא מוגדר של המחבר:

https://lookerstudio.google.com/reporting/create?
  c.reportId=7890
  &r.reportName=MyNewReportWithMultipleDataSources
  &ds.ds0.datasourceName=MyNewDataSource
  &ds.ds0.connector=bigQuery
  &ds.ds0.type=TABLE
  &ds.ds0.projectId=bigquery-public-data
  &ds.ds0.datasetId=samples
  &ds.ds0.tableId=shakespeare
  &ds.ds1.viewId=92320289

יצירה לעומת הוספה

לפעמים כדאי להשתמש באותו מקור נתונים בכמה דוחות, כדי שעדכונים במקור הנתונים ישפיעו על כל הדוחות יחד. כשיוצרים דוח באמצעות Linking API, אפשר להוסיף מחדש מקור נתונים מדוח התבנית, בתנאי שמתקיימים כל התנאים הבאים:

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

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

תווים כלליים של כינוי למקור נתונים

כדי להחיל פרמטר של Linking API על כמה מקורות נתונים, אפשר להשתמש בכינוי עם תו כללי ds.* במקום בכינוי של מקור הנתונים.

האפשרות הזו יכולה להיות שימושית להסרת פרמטרים חוזרים מכתובת ה-URL. לדוגמה, אם יש לכם תבנית עם שלושה מקורות נתונים של BigQuery שמצורפים אליה, ואתם רוצים להחליף את projectId ואת datasetId בכל אחד מהם, אבל לשמור את tableId, תוכלו לכתוב את זה כך:

  https://lookerstudio.google.com/reporting/create?
  c.reportId=7890
  &ds.ds1.projectId=client-project
  &ds.ds1.datasetId=client-dataset
  &ds.ds2.projectId=client-project
  &ds.ds2.datasetId=client-dataset
  &ds.ds3.projectId=client-project
  &ds.ds3.datasetId=client-dataset

לחלופין, אפשר להשתמש בתו הכללי ds.* כדי להשתמש בכתובת ה-URL המקבילה הזו:

  https://lookerstudio.google.com/reporting/create?
  c.reportId=7890
  &ds.*.projectId=client-project
  &ds.*.datasetId=client-dataset

לפרמטרים שמועברים ל-Linking API שלא משתמשים בתו כללי ds.* יש עדיפות על פני פרמטרים שכן משתמשים בו. בדוגמה שלמעלה, אפשר להוסיף כינוי ספציפי למקור נתונים כדי לבטל את הערך של התו הכללי.

  https://lookerstudio.google.com/reporting/create?
  c.reportId=7890
  &ds.*.projectId=client-project
  &ds.*.datasetId=client-dataset
  &ds.ds1.datasetId=client-dataset

באופן כללי, סדר העדיפות של הפרמטרים הוא:

  1. פרמטר שניתן עם כינוי ספציפי (ds.ds1.datasetId)
  2. פרמטר שסופק באמצעות התו הכללי לחיפוש (ds.*.datasetId)
  3. ערך שנגזר ממקור הנתונים של התבנית, אם לא סופק ds.connector (ראו החלפה לעומת עדכון)
  4. ערך ברירת המחדל של הפרמטר, אם הוא אופציונלי.

מידע על מחברים

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

BigQuery

מחבר BigQuery תומך בשני סוגים של שאילתות: שאילתת TABLE, שבה מציינים את מזהה הטבלה של הטבלה שאליה רוצים לשלוח שאילתה, ושאילתת CUSTOM_QUERY, שבה מציינים הצהרת SQL לשליחת שאילתה לטבלה.

שאילתות של טבלאות

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

שם הפרמטר תיאור
ds.alias.connector
אופציונלי. הערך שמוגדר הוא bigQuery עבור מחבר BigQuery.

אם מציינים את האפשרות הזו, מקור הנתונים מוחלף בהגדרת BigQuery שסופקה. החלפה לעומת עדכון
ds.alias.type
חובה** סוג השאילתה. ההגדרה היא TABLE.
ds.alias.projectId
חובה** מזהה הפרויקט של הטבלה שרוצים לשלוח אליה שאילתה.
ds.alias.datasetId
חובה** מזהה מערך הנתונים של הטבלה שאליה מופנית השאילתה.
ds.alias.tableId
חובה** מזהה הטבלה של הטבלה שרוצים לשלוח אליה שאילתה.

טבלאות עם חלוקה לפי תאריך:
כששולחים שאילתה לטבלאות עם חלוקה לפי תאריך, אפשר להשתמש בסיומת * (תו כללי) או YYYYMMDD.
אם הטבלה מזוהה כטבלה של Google Analytics, ‏ Firebase Analytics או Firebase Crashlytics, תבנית ברירת מחדל של שדות תיבחר אלא אם צוינה תבנית אחרת. בטבלה של תבנית השדות מפורטים פרמטרים קשורים.
ds.alias.billingProjectId
אופציונלי. מזהה הפרויקט שישמש לחיוב. אם לא מגדירים את המדיניות, המערכת תשתמש ב-projectId.
ds.alias.isPartitioned
אופציונלי. מגדירים את הערך true אם הטבלה מחולקת למחיצות ורוצים להשתמש בעמודת החלוקה למחיצות כמאפיין של טווח תאריכים. האפשרות הזו רלוונטית רק לחלוקה למחיצות לפי זמן (למשל, שימוש בעמודה לחלוקה למחיצות לפי זמן או בעמודת _PARTITIONTIME פסאודו) ולא פועלת בטבלאות שמחולקות למחיצות לפי טווח של מספרים שלמים. אם לא מציינים ערך, ברירת המחדל היא false. מידע נוסף זמין במאמר בנושא מבוא לטבלאות עם מחיצות.
ds.alias.refreshFields
אופציונלי. אם לא מציינים ערך, ברירת המחדל היא true. פרטים נוספים מופיעים במאמר בנושא refreshFields.
תבנית של שדות ל-Google Analytics, ל-Firebase Analytics ול-Crashlytics

בטבלאות שמזוהות כ-Google Analytics,‏ Firebase Analytics או Firebase Crashlytics, יש פרמטרים נוספים שאפשר להגדיר כדי להגדיר את תבנית השדות. אם לא מציינים תבנית, המערכת תבחר תבנית ברירת מחדל.

שם תיאור
ds.alias.gaTemplateLevel
אופציונלי. תבנית השדות של Google Analytics שבה רוצים להשתמש. הפונקציה רלוונטית רק כשמבצעים שאילתה בטבלה של ייצוא ל-BigQuery מ-Google Analytics. אחד מהערכים ALL, SESSION, HITS. בטבלאות של Google Analytics, אם לא מציינים ערך, ברירת המחדל היא ALL.
ds.alias.firebaseTemplateLevel
אופציונלי. תבנית השדות של Firebase Analytics שבה רוצים להשתמש. התנאי הזה רלוונטי רק כשמריצים שאילתה על טבלה של BigQuery Export עבור Firebase Analytics. אפשר להגדיר רק את הערך EVENTS. בטבלאות של Firebase Analytics, אם לא מציינים ערך, ברירת המחדל היא EVENTS.
ds.alias.crashlyticsTemplateLevel
תבנית השדות של Firebase Crashlytics שבה רוצים להשתמש. אפשר להגדיר רק את הערך DEFAULT. המאפיין הזה רלוונטי רק כשמריצים שאילתה על טבלת ייצוא של BigQuery עבור Firebase Crashlytics. בטבלאות של Firebase Crashlytics, אם לא מציינים ערך, ברירת המחדל היא DEFAULT.

שאילתות מותאמות אישית

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

שם הפרמטר תיאור
ds.alias.connector
אופציונלי. הערך שמוגדר הוא bigQuery עבור מחבר BigQuery.

אם ההגדרה הזו מוגדרת, מקור הנתונים מוחלף בהגדרות BigQuery שצוינו. החלפה לעומת עדכון
ds.alias.type
חובה** סוג השאילתה. ההגדרה היא CUSTOM_QUERY.
ds.alias.sql
חובה** שאילתת ה-SQL להרצה.
ds.alias.billingProjectId
אופציונלי. מזהה הפרויקט שישמש לחיוב. אם לא מגדירים את המדיניות, המערכת תשתמש ב-projectId. אם לא מגדירים את projectId, המערכת תשתמש בפרויקט של הטבלה שנשלחה לגביה השאילתה.
ds.alias.sqlReplace

אופציונלי. רשימה של מחרוזות תבנית ומחרוזות החלפה שמופרדות בפסיקים, להחלה על שאילתת ה-SQL. החלפת מחרוזת מתבצעת רק אם יש התאמה לתבנית. צריך להפריד בין זוגות של תבנית ומחרוזת החלפה באמצעות פסיק. לדוגמה, stringPattern1,replacementString1, stringPattern2,replacementString2.
ds.alias.refreshFields
אופציונלי. אם לא מציינים ערך, ברירת המחדל היא true. פרטים נוספים מופיעים במאמר בנושא refreshFields.

דוגמאות

הגדרת סוג TABLE שבה השאילתה מוגדרת עם מזהה טבלה:

https://lookerstudio.google.com/reporting/create?
  c.reportId=123abc
  &ds.ds0.connector=bigQuery
  &ds.ds0.type=TABLE
  &ds.ds0.projectId=bigquery-public-data
  &ds.ds0.datasetId=samples
  &ds.ds0.tableId=shakespeare
  &ds.ds0.billingProjectId=myProject

הגדרת סוג TABLE לשליחת שאילתה לטבלה עם שברי נתונים לפי תאריך באמצעות סיומת של תו כללי:

https://lookerstudio.google.com/reporting/create?
  c.reportId=123abc
  &ds.ds0.connector=bigQuery
  &ds.ds0.type=TABLE
  &ds.ds0.projectId=price-data
  &ds.ds0.datasetId=samples
  &ds.ds0.tableId=stock_*

הגדרת סוג TABLE לשאילתה של טבלה עם שברי נתונים לפי תאריך באמצעות הסיומת YYYYMMDD:

https://lookerstudio.google.com/reporting/create?
  c.reportId=123abc
  &ds.ds0.connector=bigQuery
  &ds.ds0.type=TABLE
  &ds.ds0.projectId=price-data
  &ds.ds0.datasetId=samples
  &ds.ds0.tableId=stock_YYYYMMDD

הגדרת סוג TABLE לביצוע שאילתה בטבלת BigQuery Export של Google Analytics, באמצעות תבנית השדות SESSION:

https://lookerstudio.google.com/reporting/create?
  c.reportId=123abc
  &ds.ds0.connector=bigQuery
  &ds.ds0.type=TABLE
  &ds.ds0.projectId=my-gabq-project
  &ds.ds0.datasetId=1234567
  &ds.ds0.tableId=ga_sessions_YYYYMMDD
  &ds.ds0.gaTemplateLevel=SESSION

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

https://lookerstudio.google.com/reporting/create?
  c.reportId=123abc
  &ds.ds0.connector=bigQuery
  &ds.ds0.type=TABLE
  &ds.ds0.projectId=acme-co-logs
  &ds.ds0.datasetId=logs
  &ds.ds0.tableId=logs_table
  &ds.ds0.isPartitioned=true

הגדרת סוג CUSTOM_QUERY שבה השאילתה מוגדרת באמצעות הצהרת SQL:

https://lookerstudio.google.com/reporting/create?
  c.reportId=123abc
  &ds.ds0.connector=bigQuery
  &ds.ds0.type=CUSTOM_QUERY
  &ds.ds0.projectId=bigquery-public-data
  &ds.ds0.sql=SELECT%20word%2C%20word_count%20FROM%20%60bigquery-public-data.samples.shakespeare%60
  &ds.ds0.billingProjectId=myProject

הגדרת סוג CUSTOM_QUERY שבה רק הצהרת ה-SQL מתעדכנת ומקור הנתונים של התבנית משמש לשאר ההגדרות:

https://lookerstudio.google.com/reporting/create?
  c.reportId=123abc
  &ds.ds0.sql=SELECT%20corpus%20FROM%20%60bigquery-public-data.samples.shakespeare%60

הגדרת סוג CUSTOM_QUERY שבה מתבצע עדכון של הצהרת ה-SQL של מקור הנתונים של התבנית באמצעות sqlReplace:

https://lookerstudio.google.com/reporting/create?
  c.reportId=123abc
  &ds.ds0.sqlReplace=bigquery-public-data,new-project,samples,new-dataset

# The following shows a template query before and after sqlReplace is applied.
#
# Template data source custom query:
#   SELECT word, word_count FROM big-query-public-data.samples.shakespeare
#   INNER JOIN
#   SELECT word, word_count FROM big-query-public-data.samples.raleigh
#
# New data source custom query with sqlReplace applied:
#   SELECT word, word_count FROM new-project.new-dataset.shakespeare
#   INNER JOIN
#   SELECT word, word_count FROM new-project.new-dataset.raleigh

Cloud Spanner

שם הפרמטר תיאור
ds.alias.connector
אופציונלי. מגדירים את הערך cloudSpannerבשביל מחבר Cloud Spanner.

אם מציינים את האפשרות הזו, מקור הנתונים מוחלף בהגדרה של Cloud Spanner שסופקה. החלפה לעומת עדכון
ds.alias.projectId
חובה** מזהה הפרויקט.
ds.alias.instanceId
חובה** מזהה המופע.
ds.alias.databaseId
חובה** מזהה מסד הנתונים.
ds.alias.sql
חובה** שאילתת ה-SQL להרצה.
ds.alias.refreshFields
אופציונלי. אם לא מציינים ערך, ברירת המחדל היא true. פרטים נוספים מופיעים במאמר בנושא refreshFields.

דוגמה

הגדרה של Cloud Spanner עם הצהרת SQL:

https://lookerstudio.google.com/reporting/create?
  c.reportId=456def
  &ds.ds1.connector=cloudSpanner
  &ds.ds1.projectId=myProject
  &ds.ds1.instanceId=production
  &ds.ds1.datasetId=transactions
  &ds.ds1.sql=SELECT%20accountId%2C%20date%2C%20revenue%20FROM%20sales%3B

פלאגינים לחיבור למקור נתונים

שם הפרמטר תיאור
ds.alias.connector
אופציונלי. מגדירים את הערך community עבור Community Connector.

אם מוגדר, מחליף את מקור הנתונים בהגדרת מחבר הקהילה שסופקה. החלפה לעומת עדכון
ds.alias.connectorId
חובה** מחבר הקהילה connectorId (נקרא גם deploymentId).
ds.alias.parameters
אופציונלי. פרמטרים נוספים שספציפיים למחבר, כפי שמוגדרים ב הגדרת המחבר של מחבר הקהילה.
ds.alias.refreshFields
אופציונלי. אם לא מציינים ערך, ברירת המחדל היא true. פרטים נוספים מופיעים במאמר בנושא refreshFields.

דוגמה

מתחברים לפלאגין חיבור למקור נתונים עם פרמטרים של הגדרת state ו-city:

https://lookerstudio.google.com/reporting/create?
  c.reportId=161718pqr
  &ds.ds5.connector=community
  &ds.ds5.connectorId=AqwqXxQshl94nJa0E0-1MsZXQL0DfCsJIMWk7dnx
  &ds.ds5.state=CA
  &ds.ds5.city=Sacramento

Google Analytics

שם הפרמטר תיאור
ds.alias.connector
אופציונלי. מגדירים את הערך googleAnalytics עבור המחבר של Google Analytics.

אם המאפיין מוגדר, הוא מחליף את מקור הנתונים בהגדרה שסופקה של Google Analytics. החלפה לעומת עדכון
ds.alias.accountId
חובה** מספר החשבון.
ds.alias.propertyId
חובה** מזהה הנכס.
ds.alias.viewId
מזהה התצוגה המפורטת.
חובה** בנכסי Universal Analytics.
אין להגדיר את הפרמטר הזה בנכסי Google Analytics 4.
ds.alias.refreshFields
אופציונלי. אם לא מציינים ערך, ברירת המחדל היא false. פרטים נוספים מופיעים במאמר בנושא refreshFields.

דוגמאות

הגדרת Google Analytics לנכס Universal Analytics:

https://lookerstudio.google.com/reporting/create?
  c.reportId=789ghi
  &ds.ds2.connector=googleAnalytics
  &ds.ds2.accountId=54516992
  &ds.ds2.propertyId=UA-54516992-1
  &ds.ds2.viewId=92320289

הגדרת Google Analytics עבור נכס Google Analytics 4:

https://lookerstudio.google.com/reporting/create?
  c.reportId=789ghi
  &ds.ds2.connector=googleAnalytics
  &ds.ds2.accountId=54516992
  &ds.ds2.propertyId=213025502

Google Cloud Storage

שם הפרמטר תיאור
ds.alias.connector
אופציונלי. מגדירים את האפשרות googleCloudStorage Google Cloud Storage connector.

אם ההגדרה מוגדרת, היא מחליפה את מקור הנתונים בהגדרת Google Cloud Storage שצוינה. החלפה לעומת עדכון
ds.alias.pathType
חובה** סוג הנתיב. משתמשים ב-FILE כדי לבחור קובץ אחד או ב-FOLDER כדי לבחור את כל הקבצים בנתיב הנתון.
ds.alias.path
חובה** נתיב הקובץ (למשל, MyBucket/MyData/MyFile.csv) אם הערך של pathType הוא FILE, או נתיב התיקייה (למשל, *MyBucket/MyData) אם הערך של pathType הוא FOLDER.
ds.alias.refreshFields
אופציונלי. אם לא מציינים ערך, ברירת המחדל היא true. פרטים נוספים מופיעים במאמר בנושא refreshFields.

דוגמה

הגדרת Google Cloud Storage לקובץ יחיד:

https://lookerstudio.google.com/reporting/create?
  c.reportId=231908kpf
  &ds.ds50.connector=googleCloudStorage
  &ds.ds50.pathType=FILE
  &ds.ds50.path=MyBucket%2FMyData%2FMyFile.csv

הגדרת Google Cloud Storage לכל הקבצים בנתיב:

https://lookerstudio.google.com/reporting/create?
  c.reportId=231908kpf
  &ds.ds50.connector=googleCloudStorage
  &ds.ds50.pathType=FOLDER
  &ds.ds50.path=MyBucket%2FMyData

Google Sheets

שם הפרמטר תיאור
ds.alias.connector
אופציונלי. מגדירים את הערך googleSheets עבור מחבר Google Sheets.

אם ההגדרה הזו מוגדרת, מקור הנתונים מוחלף בהגדרה של Google Sheets שסופקה. החלפה לעומת עדכון
ds.alias.spreadsheetId
חובה** מזהה הגיליון האלקטרוני.
ds.alias.worksheetId
חובה** מזהה גליון העבודה.
ds.alias.hasHeader
אופציונלי. מגדירים את הערך true כדי להשתמש בשורה הראשונה ככותרות. אם לא מציינים ערך, ברירת המחדל היא true. הכותרות של העמודות צריכות להיות ייחודיות. עמודות עם כותרות ריקות לא יתווספו למקור הנתונים.
ds.alias.includeHiddenCells
אופציונלי. מגדירים את הערך true כדי לכלול תאים מוסתרים. אם לא מציינים ערך, ברירת המחדל היא true.
ds.alias.includeFilteredCell
אופציונלי. מגדירים את הערך ל-true כדי לכלול תאים מסוננים. אם לא מציינים ערך, ברירת המחדל היא true.
ds.alias.range
אופציונלי. טווח, למשל A1:B52.
ds.alias.refreshFields
אופציונלי. אם לא מציינים ערך, ברירת המחדל היא true. פרטים נוספים מופיעים במאמר בנושא refreshFields.

דוגמאות

הגדרות ב-Google Sheets:

https://lookerstudio.google.com/reporting/create?
  c.reportId=101112jkl
  &ds.ds3.connector=googleSheets
  &ds.ds3.spreadsheetId=1Qs8BdfxZXALh6vX4zrE7ZyGnR3h5k
  &ds.ds3.worksheetId=903806437

הגדרות של Google Sheets שבהן השורה הראשונה משמשת ככותרות, וכלולות תאים מוסתרים ומסוננים:

https://lookerstudio.google.com/reporting/create?
  c.reportId=101112jkl
  &ds.ds3.connector=googleSheets
  &ds.ds3.spreadsheetId=1Qs8BdfxZXALh6vX4zrE7ZyGnR3h5k
  &ds.ds3.worksheetId=903806437
  &ds.ds3.hasHeader=true
  &ds.ds3.includeHiddenCells=true
  &ds.ds3.includeFilteredCells=true

הגדרת Google Sheets עם טווח (A1:D20):

https://lookerstudio.google.com/reporting/create?
  c.reportId=101112jkl
  &ds.ds3.connector=googleSheets
  &ds.ds3.spreadsheetId=1Qs8BdfxZXALh6vX4zrE7ZyGnR3h5k
  &ds.ds3.worksheetId=903806437
  &ds.ds3.range=A1%3AD20

Looker

שם הפרמטר תיאור
ds.alias.connector
אופציונלי. מגדירים את הערך looker עבור מחבר Looker.

אם הערך מוגדר, מקור הנתונים מוחלף בהגדרת Looker שסופקה. החלפה לעומת עדכון
ds.alias.instanceUrl
חובה** כתובת ה-URL של מופע Looker.
ds.alias.model
חובה** מודל Looker.
ds.alias.explore
חובה** האפשרות הנוספת ב-Looker.
ds.alias.refreshFields
אופציונלי. אם לא מציינים ערך, ברירת המחדל היא false. פרטים נוספים מופיעים במאמר בנושא refreshFields.

דוגמה

חיבור ל-Explore ב-Looker:

https://lookerstudio.google.com/reporting/create?
  c.reportId=161718pqr
  &ds.ds5.connector=looker
  &ds.ds5.instanceUrl=my.looker.com
  &ds.ds5.model=thelook
  &ds.ds5.explore=orders

Search Console

שם הפרמטר תיאור
ds.alias.connector
אופציונלי. מגדירים את הערך searchConsole עבור המחבר של Search Console.

אם ההגדרה הזו מוגדרת, מקור הנתונים מוחלף בהגדרה של Search Console שצוינה. החלפה לעומת עדכון
ds.alias.siteUrl
חובה** כתובת האתר. בנכס לפי דומיין, מוסיפים את הקידומת sc-domain\:.
ds.alias.tableType
חובה** הגדרת סוג הטבלה. הערך יכול להיות SITE_IMPRESSION או URL_IMPRESSION.
ds.alias.searchType
חובה** הגדרת סוג החיפוש. יכול להיות אחד מהערכים הבאים: WEB, IMAGE, VIDEO או NEWS.
ds.alias.refreshFields
אופציונלי. אם לא מציינים ערך, ברירת המחדל היא false. פרטים נוספים מופיעים במאמר בנושא refreshFields.

דוגמה

הגדרה של Search Console עבור נכס לפי קידומת URL:

https://lookerstudio.google.com/reporting/create?
  c.reportId=161718pqr
  &ds.ds5.connector=searchConsole
  &ds.ds5.siteUrl=https%3A%2F%2Fwww.example.com%2Fwelcome
  &ds.ds5.tableType=SITE_IMPRESSION
  &ds.ds5.searchType=WEB

הגדרה של Search Console עבור נכס לפי דומיין:

https://lookerstudio.google.com/reporting/create?
  c.reportId=161718pqr
  ds.ds5.connector=searchConsole
  &ds.ds5.siteUrl=sc-domain%3Aexample.com
  &ds.ds5.tableType=SITE_IMPRESSION
  &ds.ds5.searchType=WEB

הרשאות לתבניות

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

בטבלה הבאה מפורטות ההמלצות לגישה למקורות נתונים כדי להשיג את חוויית המשתמש האופטימלית, על סמך מקורות הנתונים של התבנית וההגדרה של Linking API:

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

שימוש בדוח ריק או בדוח ברירת מחדל

כדי להשתמש בדוח ריק או בדוח ברירת המחדל, צריך להגדיר את Linking API באופן הבא:

סוג הדוח הגדרת פרמטר הבקרה reportId הגדרת פרמטרים של מקור נתונים (ds). הערות
דוח ריק לא לא
דוח ברירת מחדל לא כן

דוח ברירת המחדל מסופק על ידי Data Studio.

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

בדוגמאות הבאות מוצגות כתובות URL שונות של Linking API שמשתמשות בדוח ריק או בדוח ברירת מחדל.

כדי להתחיל את תהליך יצירת הדוח עם דוח ריק:

https://lookerstudio.google.com/reporting/create

מתחילים את תהליך יצירת הדוח עם דוח ריק ומגדירים את שם הדוח:

https://lookerstudio.google.com/reporting/create?r.reportName=MyNewReport

שימוש בתבנית הדוח שמוגדרת כברירת מחדל עם הגדרת מחבר של Google Sheets:

https://lookerstudio.google.com/reporting/create?
  ds.connector=googleSheets
  &ds.spreadsheetId=1Q-w7KeeJj1jk3wFcFm4NsPlppNscs0CtHf_EP9fsYOo
  &ds.worksheetId=0

הטמעת דוח

כדי להטמיע דוח שנוצר באמצעות Linking API, צריך להגדיר פרמטרים של כתובת URL ולכלול את הנתיב /embed/. כתובת URL להטמעה של Linking API צריכה להיות בפורמט הבא:

https://lookerstudio.google.com/embed/reporting/create?parameters

חיפוש מזהים וכינויים

מזהה דוח

כדי למצוא את מזהה הדוח:

  1. פותחים את הדוח שרוצים להשתמש בו כתבנית. בודקים את כתובת ה-URL של הדוח. החלק שבין reporting/ לבין /page הוא מזהה הדוח. לדוגמה, בכתובת ה-URL הבאה, 0B_U5RNpwhcE6SF85TENURnc4UjA הוא מזהה הדוח:
https://lookerstudio.google.com/reporting/0B_U5RNpwhcE6SF85TENURnc4UjA/page/1M
סרגל הכתובות בדפדפן שבו מוצגת כתובת ה-URL של דוח Data Studio. מזהה הדוח מודגש.
מאתרים את מזהה הדוח בכתובת ה-URL של הדוח.

כינוי של מקור נתונים

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

כדי למצוא כינוי של מקור נתונים:

  1. עורכים את הדוח.
  2. בסרגל הכלים, בוחרים באפשרות Resource (מקור) > Manage added data sources (ניהול מקורות נתונים שנוספו).
  3. בודקים את העמודה כינוי כדי למצוא את פרטי הכינוי של כל מקור נתונים.

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

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

סוג המחבר

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

  1. עורכים את הדוח.
  2. בסרגל הכלים, בוחרים באפשרות Resource (מקור) > Manage added data sources (ניהול מקורות נתונים שנוספו).
  3. בודקים את העמודה סוג המחבר כדי לזהות את המחבר ששימש ליצירת מקור הנתונים.
רשימה של מקורות נתונים בדף הניהול של משאב מקור הנתונים. העמודה Connector Type (סוג המחבר) מסומנת.
בדף הניהול מקורות נתונים, מאתרים את סוג המחבר של מקור הנתונים.

טיפים ופתרון בעיות

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

תיבת הדו-שיח לניפוי באגים

משתמשים בתיבת הדו-שיח של ניפוי הבאגים כדי לבדוק את ההגדרה של Linking API כפי שהיא מפורשת על ידי Data Studio. הוא יכול לעזור בניפוי באגים ב-API.

  • אם מתרחשת שגיאה במהלך הניתוח של כתובת ה-URL של Linking API, מוצג באופן אוטומטי דו-שיח עם פרטים על השגיאה.
  • כאשר מתרחשת שגיאה ולא מוצגת תיבת דו-שיח באופן אוטומטי, חפשו את כפתור המידע בפינה השמאלית העליונה של הדוח. אפשר ללחוץ כדי לקבל מידע נוסף על ניפוי הבאגים.
    כפתור מידע שבו אפשר לראות איך נוצר הדוח.
  • אם אין לחצן מידע, אפשר להוסיף את הפרמטר &c.explain=true לסוף של כל כתובת URL של Linking API כדי להפעיל את הלחצן.

הרשאות

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

עדכון לעומת החלפה

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

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

רענון שדות

אם הגדרתם שמות שדות, סוגים או צבירות למקור נתונים של תבנית, השינויים האלה יועברו רק למקור נתונים שהוגדר באמצעות Linking API אם הפרמטר ds.refreshFields מוגדר לערך false.

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

באופן כללי, אם הגדרתם שדות במקור הנתונים של התבנית ואתם בטוחים שהגדרות חדשות של מקור נתונים באמצעות Linking API תמיד יניבו את אותם שדות בדיוק, מומלץ להגדיר את refreshFields ל-false.

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

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

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

משוב ותמיכה

אפשר להשתמש בIssue Tracker כדי לדווח על בעיות ב-Linking API או כדי לשלוח משוב. בקטע תמיכה מפורטים מקורות מידע כלליים לקבלת עזרה ולשאילת שאלות.

יומן שינויים

2023-06-06

  • נוספו פרמטרים של דוחות r.measurementId ו-r.keepMeasurementId להגדרת מזהי המדידה של Google Analytics בדוח.
  • נוסף ds.keepDatasourceName כדי לשלוט בשימוש חוזר בשם של מקור הנתונים בתבנית.
  • הוספנו קטע בנושא הטמעת דוח.
  • מחבר BigQuery
    • הוספת את sqlReplace. מאפשרת לציין מחרוזות של תבניות והחלפות כדי לעדכן את שאילתת ה-SQL של מקור הנתונים של התבנית.

2023-05-22

2022-11-21

2022-11-14

2022-06-15

  • יציאה מגרסת בטא
    • השם של Integration API שונה ל-Linking API.
    • ה-API לקישור יצא מגרסת בטא.
  • הוספנו את פרמטר הבקרה pageId כדי לאפשר קישור לדף ספציפי בדוח.
  • נוסף פרמטר הבקרה mode כדי להגדיר את מצב הדוח לתצוגה או למצב עריכה בזמן הטעינה.
  • מעכשיו אפשר להחליף את ההגדרות של מקורות נתונים באופן מלא או לעדכן אותן באופן חלקי. ההתנהגות הזו נקבעת לפי הגדרת הפרמטר ds.connector. פרטים נוספים זמינים במאמר בנושא החלפה לעומת עדכון.
  • אם לא מציינים תבנית דוח באמצעות הפרמטר c.reportId, נעשה עכשיו שימוש בתבנית ברירת מחדל.
  • נוסף פרמטר של מקור נתונים ds.refreshFields. כך תוכלו לקבוע אם שדות של מקור נתונים יעברו רענון כשמטעינים הגדרה של מקור נתונים.
  • מחבר BigQuery
    • השדה projectId לא נדרש כשהערך של type הוא CUSTOM_QUERY.
    • אם לא מגדירים את billingProjectId, הפרויקט לחיוב יחזור ל-projectId או לפרויקט של הטבלה שנשלחה לגביה שאילתה.
    • הוספנו תמיכה בטבלאות שמחולקות למחיצות לפי תאריך. מגדירים את הפרמטר isPartitioned לערך true כדי להשתמש בשדה החלוקה כמאפיין של טווח תאריכים.
    • הוספנו תמיכה בשאילתות של טבלאות עם חלוקה למחיצות לפי תאריך באמצעות התו הכללי או הסיומת YYYYMMDD של הטבלה.
    • הוספנו תמיכה בשליחת שאילתות לטבלאות של Google Analytics,‏ Firebase Analytics או Crashlytics ובבחירת תבנית של שדות.
  • ‫Google Sheets
    • ברירת המחדל של hasHeader היא true, בהתאם לברירת המחדל בממשק המשתמש באינטרנט.
    • ‫includeHiddenAndFilteredCell פוצל ל-includeHiddenCells ול-
    • ‫includeFilteredCells. עכשיו ברירת המחדל בשניהם היא true, כמו בממשק המשתמש האינטרנטי.
  • המחבר של Search Console
    • השם של הפרמטר propertyType שונה ועכשיו הוא searchType.
  • מחבר של Google Surveys
    • מעכשיו אפשר להזין ב-surveyId מזהה סקר יחיד או רשימה של מזהי סקרים שמופרדים בפסיקים.

2021-12-16

  • גרסה ראשונית של Integration API.
    • אפשר לקשר לדוח קיים ולהגדיר את שם הדוח.
    • אפשר להגדיר כמה מקורות נתונים, ולקבוע שם לכל מקור נתונים.
    • תמיכה בסוגי המחברים הבאים: BigQuery, ‏ Cloud Spanner,‏ Google Analytics, ‏ Google Cloud Storage, ‏ Google Sheets, ‏ Google Surveys,‏ Search Console.