ממשק API של Looker Studio

ב-Looker Studio API אפשר לחפש ולנהל נכסים של Looker Studio.

התרחיש לדוגמה העיקרי ב-API הוא לאפשר לארגונים ב-Google Workspace או ב-Cloud Identity להפוך את הניהול וההעברה של נכסים ב-Looker Studio לאוטומטיים.

נקודה חשובה: ה-API זמין רק למשתמשים ששייכים לארגון באמצעות Google Workspace או Cloud Identity.

סקירה כללית של הדרישות

כדי להשתמש ב-Looker Studio API, צריך לבצע את הפעולות הבאות:

1. איך מגדירים אפליקציה לשימוש ב-API.
2. השתמשו במסוף Google Admin כדי לתת הרשאה לאפליקציה.
3. קבלת אסימוני גישה מסוג OAuth 2.0 וקריאה ל-API.

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

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

1. הגדרת אפליקציה לשימוש ב-API

כדי להגדיר את האפליקציה, צריך לבצע את הפעולות הבאות:

• הפעלה של ה-API
• יצירת לקוח OAuth

מפעילים את ה-API

כדי להפעיל ממשק API בפרויקט:

1. פותחים את Looker Studio API ב-Google API Console.
2. אם מתבקשים, בוחרים פרויקט או יוצרים פרויקט חדש.
3. לוחצים על Enable.
4. אם תתבקשו, עליכם לקרוא את התנאים וההגבלות של ה-API ולאשר אותם.

יצירת לקוח OAuth

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

חשוב: אין להוסיף היקפי הרשאות ל-Looker Studio ללקוח OAuth. ההיקפים יתווספו על ידי האדמין ב-Workspace אחרי שהם יאשרו את האפליקציה.

1. עוברים אל הגדרת מסך הסכמה ל-OAuth.
   1. בוחרים באפשרות פנימי ולוחצים על יצירה.
   2. ממלאים את שדות החובה ולוחצים על שמירה.
2. עוברים אל Credentials.
   1. לוחצים על יצירת תפקידים.
   2. בוחרים באפשרות מזהה לקוח OAuth.
   3. יש לבחור את Application Type המתאים. (אפליקציית אינטרנט היא הנפוצה ביותר).
   4. ממלאים את שדות החובה ולוחצים על יצירה.
3. יש לרשום את מזהה הלקוח, מאחר שהוא משמש למתן הרשאה לאפליקציה.

2. מתן הרשאה לאפליקציה לארגון

אפליקציות שמשתמשות ב-Looker Studio API יכולות לאמת משתמשים של Google Workspace ולתת להם הרשאה רק אם הארגון אישר זאת באמצעות הענקת גישה ברמת הדומיין לשליטה בגישה ל-API.

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

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

1. נכנסים למסוף Google Admin ועוברים להענקת גישה ברמת הדומיין.
2. בקטע API clients, לוחצים על הוספת חדש.
3. מזינים את Client ID האפליקציה שרוצים לאשר (כלומר האפליקציה שמשתמשת ב-Looker Studio API).
4. מזינים את כל היקפי ההרשאות של OAuth שנדרשים על ידי האפליקציה. כדי לנהל את הנכסים, בדרך כלל משתמשים בהיקפים הבאים:
   • https://www.googleapis.com/auth/datastudio
   • https://www.googleapis.com/auth/userinfo.profile
5. לוחצים על Authorize.

הערה: אם אין צורך לנהל את הנכסים ב-Looker Studio באפליקציה, כדאי להשתמש בהיקף המגביל יותר של https://www.googleapis.com/auth/datastudio.readonly במקום https://www.googleapis.com/auth/datastudio.

אחרי שתאשרו את האפליקציה, כל משתמשי Workspace ששייכים לארגון יקבלו הרשאה אוטומטית להשתמש באפליקציה עם Looker Studio API.

3. קבלת אסימוני גישה מסוג OAuth 2.0 וקריאה ל-API

לאחר הפיתוח וההרשאה של האפליקציה, תקבלו את הגישה הנדרשת כדי לקרוא ל-API למשתמשי Workspace. למידע נוסף על השימוש ב-Google APIs באמצעות OAuth, ראו שימוש ב-OAuth 2.0 לגישה אל Google APIs. מידע על הפעולות הזמינות זמין בהפניית API.

פתרון בעיות

חסרה תיבת דו-שיח של OAuth

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

שגיאה 400: היקף_לא_חוקי

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