ממשק API לקישור

מבוא

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

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

תרחיש לדוגמה ויתרונות

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

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

איך זה עובד

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

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

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

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

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

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

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

דרישות

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

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

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

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

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

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

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

זו דוגמה לכתובת URL של קישור 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:

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

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

שם הפרמטר תיאור
c.reportId
אפשרות. מזהה הדוח של התבנית. המערכת של Looker 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 למדידת השימוש בדוחות. אם יש כמה מזהים, צריך להשתמש בפסיק.

אם לא צוינו 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, ברירת המחדל לשם של מקור הנתונים היא מוסכמה למתן שמות שכוללת את סוג המחבר ואת שעת היצירה (לדוגמה: דוגמאות – 12/12/21, 22:53). אם ds.datasourceName ו-ds.keepDatasourceName מוגדרים, ds.datasourceName מקבלת עדיפות להגדרת השם של מקור הנתונים.
ds.alias.keepDatasourceName

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

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

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

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

אם לא צוינו, ניתן לציין אפס פרמטרים של מחבר או יותר עבור סוג המחבר בכתובת האתר של 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 של קישור ה-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

פרמטרים שסופקו ל-Link 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 לשליחת שאילתה על טבלה.

TABLE שאילתות

אפשר להחיל את הפרמטרים הבאים אם הערך של 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, המערכת תבחר תבנית ברירת מחדל של שדות, אלא אם תצוין תבנית אחת. עיינו בפרמטרים שקשורים לטבלה Fields template (תבנית שדות).
ds.alias.billingProjectId
אפשרות. מזהה הפרויקט שישמש לחיוב. אם המדיניות לא מוגדרת, המערכת תשתמש ב-projectId.
ds.alias.isPartitioned
אפשרות. מגדירים את הערך true אם הטבלה מחולקת למחיצות ואם רוצים להשתמש בעמודת החלוקה למחיצות (partitioning) כמאפיין של טווח התאריכים. האפשרות הזו רלוונטית רק לחלוקה למחיצות (partitioning) מבוססת זמן (למשל, באמצעות עמודת חלוקה למחיצות (Partitions) לפי זמן או בעמודה פסאודו-עמודה _PARTITIONTIME, והיא לא פועלת בטבלאות שמחולקות למחיצות בטווח מספרים שלמים. אם לא צוין, ברירת המחדל היא false. מידע נוסף זמין במאמר מבוא לטבלאות מחולקות למחיצות (Partitions).
ds.alias.refreshFields
אפשרות. אם לא צוין ערך, ברירת המחדל היא true. אפשר לקרוא פרטים נוספים ב-refreshFields.
תבנית שדות של Google Analytics, Firebase Analytics ו-Crashlytics

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

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

שאילתות CUSTOM

אפשר להחיל את הפרמטרים הבאים אם 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 לשליחת שאילתה לגבי טבלה מחולקת למחיצות (partitioning) של הטמעת הנתונים, ושימוש בעמודת החלוקה למחיצות (partitioning) כמאפיין של טווח תאריכים:

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 עבור מחבר קהילה.

אם היא מוגדרת, היא מחליפה את מקור הנתונים בתצורה שסופקה של מחבר הקהילה. למידע נוסף, אפשר לקרוא את המאמר החלפה לעומת עדכון.
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.

אם היא מוגדרת, היא מחליפה את מקור הנתונים בהגדרה שצוינה של 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.

דוגמה

התחברות לכלי הניתוחים ב-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 ולכן אין צורך בגישת תצוגה מפורטת.
לשימוש חוזר עדכון למשתמשים נדרשת גישת צפייה. נדרשת גישת צפייה למקור הנתונים כדי של-Link API לקרוא את ההגדרה ממקור הנתונים של התבנית ולהשתמש בה. אם למשתמשים אין גישת צפייה, תופיע הודעת שגיאה כשינסו לטעון את הדוח.

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

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

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

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

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

בדוגמאות הבאות מוצגות כתובות URL שונות של קישור 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 להטמעת 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 של דוח ב-Looker Studio. מזהה הדוח מודגש.
מוצאים את מזהה הדוח בכתובת ה-URL של הדוח.

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

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

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

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

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

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

סוג המחבר

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

  1. עורכים את הדוח.
  2. בסרגל הכלים, בוחרים באפשרות משאב > ניהול מקורות נתונים שנוספו.
  3. בודקים את העמודה סוג המחבר כדי לזהות את המחבר המשמש ליצירת מקור נתונים.
רשימה של מקורות נתונים בדף ניהול המשאבים של מקור הנתונים. העמודה 'סוג המחבר' מודגשת.
מוצאים את הסוג של המחבר של מקור הנתונים בדף הניהול של מקורות הנתונים.

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

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

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

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

  • כשהמערכת נתקלת בשגיאה במהלך ניתוח כתובת ה-URL של קישור ה-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.

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

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

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

משוב ותמיכה

אפשר להשתמש במעקב אחר בעיות כדי לדווח על בעיות בקישור ל-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 כדי להגדיר את מצב הדוח למצב View או למצב Edit בזמן הטעינה.
  • מעכשיו אפשר להחליף את ההגדרות של מקורות הנתונים באופן מלא או חלקי. ההתנהגות הזו נקבעת על ידי הגדרת הפרמטר 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.
  • מחבר סקרים
    • עכשיו אפשר להזין מזהה סקר יחיד ב-surveyId או רשימה של מזהי סקרים שמופרדים בפסיקים.

2021-12-16

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