Data Studio API

‫Data Studio API מאפשר לכם לחפש נכסים של Data Studio ולנהל אותם.

מקרה השימוש העיקרי ב-API הוא לאפשר לארגונים ב-Google Workspace או ב-Cloud Identity לבצע אוטומציה של הניהול וההעברה של נכסי Data Studio.

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

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

כדי להשתמש ב-Data Studio API, צריך לבצע את השלבים הבאים:

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

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

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

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

כדי להגדיר את האפליקציה:

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

הפעלת ה-API

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

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

יצירת לקוח OAuth

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

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

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

2. איך נותנים הרשאה לאפליקציה לארגון

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

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

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

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

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

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

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