בדף הזה תוכלו למצוא מידע על יצירה והגדרה של פרויקטים ב-Google Cloud לתוספים ל-Classroom. הפרויקטים ב-Google Cloud משמשים להטמעת כניסה יחידה (SSO) של Google באמצעות OAuth 2.0 (Google SSO), כדי לאשר בקשות של התוסף שלכם ולנהל דפים עסקיים של תוסף בחנות Google Workspace Marketplace.
למידע כללי נוסף על פרסום תוסף ב-Marketplace, ראו פרסום אפליקציה.
יצירת פרויקט ב-Google Cloud
אפשר ליצור שני סוגי פרויקטים: פרויקט פרטי שמשמש לפיתוח, ופרויקט ציבורי למשתמשי הקצה. התוויות 'ציבורי' ו'פרטי' מתייחסות לחשיפה של האפליקציה ב-Google Workspace Marketplace. אפליקציה פרטית מ-Marketplace יכולה להתקין רק משתמשים בדומיין שבו היא נוצרה, ואפליקציה ציבורית מ-Marketplace זמינה לכל דומיין של Google Workspace. האפליקציות האלה צריכות להיות שתי אפליקציות נפרדות, כי פרויקט לא יכול להיות גם ציבורי וגם פרטי. אפליקציות ציבוריות חייבות לעבור בדיקה ולקבל אישור לפני שהן זמינות בזירת המסחר.
מידע כללי על יצירת פרויקטים ב-Google Cloud מופיע במאמר יצירת פרויקט ב-Google Cloud.
יצירת פרויקט ציבורי ב-Google Cloud
הפרויקט הזה מייצג את אפליקציית התוסף שאדמינים, מורים ותלמידים יכולים לגשת אליה. צוות Google Workspace Marketplace צריך לבדוק ולאשר פרויקט ציבורי לפני שאפשר יהיה להפעיל או להתקין אותו.
יוצרים פרויקט חדש ב-Google Cloud בדומיין הייצור.
מפעילים את Classroom API בפרויקט בענן.
מפעילים את Google Workspace Marketplace SDK בפרויקט Cloud.
מגדירים את ה-SDK של Marketplace הגדרת האפליקציה חשיפה של האפליקציה כ-Public ומסמנים את התיבה לא רשום.
ממלאים את שדות החובה בדף Store Listing של Marketplace SDK ולוחצים על Publish (פרסום).
האפליקציה שלך תיבדק על ידי צוות Google Workspace Marketplace. הם יתקשרו איתכם באמצעות כתובת האימייל של המפתח שצוינה ב-Marketplace SDK. אחרי שהאפליקציה תאושר, מנקים את התיבה לא רשום כדי שמורים ואדמינים יוכלו למצוא אותה ב-Marketplace.
יצירת פרויקט פרטי ב-Google Cloud
הפרויקט הפרטי הזה מייצג את אפליקציית התוסף שמשמשת לפיתוח. הוא לא נגיש למשתמשים מחוץ לדומיין שבו הוא נוצר, אבל לא צריך לאשר אותו לפני ההתקנה. לכן, Google ממליצה להשתמש בפרויקט הזה כדי לפתח ולבדוק את התוסף בסביבה מבוקרת.
כדי ליצור פרויקט פרטי, צריך גישה לדומיין ב-Google Workspace for Education עם רישיון Teaching & Learning או Plus. אם עדיין אין לכם גישה לדומיין כזה, צריך לבצע את השלבים הבאים כדי להגדיר דומיין הדגמה (דמו) ב-Google Workspace for Education, לשדרג אותו ל-Plus רישיון ולאפשר לו לגשת ל-API של התוספים ב-Classroom:
- מבצעים את השלבים לקבלת דומיין בדיקה של מפתח.
יוצרים פרויקט חדש ב-Google Cloud כאדמין בדומיין ההדגמה.
אם אין לכם גישה למסוף Google Cloud או שאתם לא מצליחים ליצור פרויקטים ב-Cloud, עליכם לבדוק את הדברים הבאים ב מסוף Admin:
- נכנסים לדף הגדרות חשבון > הגדרות גישה מבוססות-גיל ובוחרים באפשרות כל המשתמשים בקבוצה או ביחידה הארגונית הזו הם בני 18 ומעלה.
- בקטע אפליקציות > שירותי Google נוספים:
- Google Cloud Platform מופעלת לכולם.
- ההגדרות ליצירת פרויקטים הן המשתמשים יכולים ליצור פרויקטים.
- הגדרות הגישה ל-Cloud Shell הן Allow access to Cloud Shell.
ממלאים ושולחים את טופס הבקשה לשדרוג דומיין להדגמה. לאחר השליחה של הטופס הזה אנחנו מבקשים מ-Google לשדרג את הדומיין להדגמה ל-Google Workspace for Education Plus עם עשרה רישיונות, ולאפשר לפרויקט ב-Cloud גישה ל-API לתוספים ל-Classroom.
תקבלו אימייל כשנשלים את תהליכי השדרוג וההוספה לרשימת ההיתרים. מקצים רישיונות Plus לחשבונות של מורים לבדיקה ב מסוף Admin. בקטע Directory > Users (ספרייה > משתמשים), יוצרים או בוחרים את החשבונות של מורים לבחינות. בכל רישיונות של מורה, מוודאים ש-Google Workspace for Education Plus מוקצית.
מפעילים את Classroom API בפרויקט בענן.
מפעילים את Google Workspace Marketplace SDK בפרויקט Cloud.
מגדירים את ה-SDK של Marketplace להגדרת האפליקציה הרשאות גישה לאפליקציה כ-private.
ממלאים את שדות החובה בדף Store Listing של Marketplace SDK ולוחצים על Publish (פרסום). אחרי שדף האפליקציה מתפרסם, המשתמשים בדומיין יכולים למצוא ולהתקין את האפליקציה ב-Google Workspace Marketplace או בכתובת כתובת ה-URL של האפליקציה שמופיעה בדף האפליקציה בחנות.
OAuth 2.0
כדי לקבל גישה ל-Classroom API, צריך לתת למשתמשים הסכמה לגישה לנתוני המשתמשים. כדי לקבל את ההרשאות האלה, צריך לבקש מ-Google גישה להיקפי ההרשאות של OAuth בשביל המשתמש שמחובר לחשבון, ולקבל אסימון שבאמצעותו אפשר לשלוח קריאות ל-API ל-Google Classroom. צריך להגדיר היקפים בדף האפליקציה בחנות Google Workspace Marketplace, כדי שמנהל הדומיין יוכל להביע הסכמה בשם משתמשי הדומיין אם יתקינו את התוסף.
בדף היקפי OAuth של Google APIs תוכלו למצוא רשימה מפורטת של כל היקפי ההרשאות הזמינים והשימושים בהם. מידע כללי על הגדרות OAuth זמין במאמר הגדרת הדף OAuth במשאבי העזרה של Workspace.
הרשאות של משתמשים
אפליקציית האינטרנט צריכה לבקש לפחות אחד מהיקפי ההרשאות הבאים:
https://www.googleapis.com/auth/userinfo.email, שמאפשר לאפליקציה להציג את כתובת האימייל של המשתמש.https://www.googleapis.com/auth/userinfo.profile, שמאפשר לאפליקציה לראות מידע אישי כמו תמונות לאורך, שמות פרטיים ושם משפחה ומידע אישי אחר שהמשתמש הגדיר כזמין לציבור.
אחרי שמשתמש אישר את אחד מההיקפים האלה בתוסף, הוא מזוהה באמצעות פרמטר השאילתה login_hint. הפרמטר הזה מועבר לכל אחת מכתובות ה-URL של אפליקציית האינטרנט כשפותחים iframe. אם המשתמש לא אישר את אחד מההיקפים האלה, לא יישלח login_hint.
login_hint הוא פרמטרים רגילים של OpenID Connect שאפשר להעביר ל-Google כשמשתמשים בכניסה באמצעות חשבון Google או כשמבקשים אסימון OAuth. המטרה היא להפוך את תהליך ההרשאה לפשוט יותר עבור משתמש הקצה.
היקפי ההרשאות של התוספים ל-Classroom
ההיקפים הבאים ספציפיים לתוספים ל-Classroom:
https://www.googleapis.com/auth/classroom.addons.teacher, שמאפשר גישה לכל ה-methods של ה-API.https://www.googleapis.com/auth/classroom.addons.student, שמאפשר גישה להפעלת פעולות אימות וקריאה של קבצים מצורפים.
גם אם אסימון גישה תקין ל-OAuth מציין את פרטי הכניסה של המשתמשים, הקריאות ל-API מוגבלות על ידי דרישות נוספות:
- בכל השיטות המשתמש חייב להיות מורה או תלמיד בקורס שצוין על ידי
courseIdבבקשה. - כדי ליצור קבצים מצורפים, לעדכן, למחוק ולמחוק ציונים, המשתמש צריך להיות מורה.
- שיחות לפוסט ספציפי ב-Google Classroom מוגבלות באמצעות הבדיקות הבאות.
- כשתוסף כבר כולל לפחות קובץ מצורף אחד בפוסט, הוא יכול לשלוח בקשות הבאות:
- אימות השקה של iframe
- פעולות של קריאה, עדכון ומחיקה של קבצים מצורפים
- עדכוני ציונים לגבי הפוסט הזה
- כשפותחים בפעם הראשונה את ה-iframe של גילוי הקבצים המצורפים, יכול להיות שהתוסף עדיין לא כולל קובץ מצורף בפוסט. יש פרמטר שאילתה
addOnTokenשיכול לשמש לשליחת בקשות עבור הדברים הבאים:- יצירת קובץ מצורף מתחת לפוסט (חובה לציין
addOnToken) - אימות ההפעלה (אם צוין
addOnTokenאומת, והוא נדרש כשלתוסף אין קובץ מצורף קיים בפוסט)
- יצירת קובץ מצורף מתחת לפוסט (חובה לציין
- כשתוסף כבר כולל לפחות קובץ מצורף אחד בפוסט, הוא יכול לשלוח בקשות הבאות:
אימות OAuth
תוסף של Classroom משתמש ב-Google APIs כדי לגשת לנתוני המשתמשים ב-Google.
מידע נוסף על תהליך האימות מופיע במאמר שאלות נפוצות לגבי אימות OAuth API.
דף האפליקציה של Google Workspace Marketplace
מידע כללי על הגדרות SDK ב-Google Workspace Marketplace זמין במאמרים הפעלה והגדרה של Google Workspace Marketplace SDK ויצירת דף אפליקציה בחנות Google Workspace Marketplace.
שיקולים בנוגע לרשימה
ב-Marketplace SDK Store Listing של הפרויקט הציבורי שלכם ב-Google Cloud מצוין שם האפליקציה והתיאורים שמיועדים למשתמשי הקצה. אפשר לספק את הפרטים האלה בכמה שפות בקטע פרטי האפליקציה.
פועלים לפי ההנחיות הבאות בכרטיסי המוצר:
בקטע פרטי האפליקציה:
יש להימנע מסימני פיסוק בשם האפליקציה. לדוגמה, אפשר להשתמש ב-"My Addon by My Company" במקום ב-"My Company: My Add-on" או ב-"My Addon, by My Company".
התיאור הקצר והתיאור המפורט לא יכולים להכיל את אותו טקסט בדיוק.
+ מוודאים שבחרתם ערך בשדה Pricing (תמחור). השדה הזה כולל אפשרויות לתמחור בחינם, לבתשלום עם תקופת ניסיון בחינם, לתכונות בתשלום באמצעות תכונות בחינם ולתמחור בתשלום. לא צריך לציין את סכום העלות בדף האפליקציה ב-Marketplace.
מוודאים שבחרתם ערך בשדה Category. יכול להיות שמשאבים אקדמיים או כלים להוראה ולניהול הם אפשרויות טובות לתוסף של Classroom.
למידע נוסף, ראו את הפריטים במאמר תיאור פרטי האפליקציה ב-Marketplace.
בקטע נכסים גרפיים:
הנכסים הגרפיים שסופקו אינם מטושטשים ומתאימים לגדלים שצוינו בתקנים של Google Workspace Marketplace
צילומי המסך שסופקו מייצגים בצורה מדויקת את חוויית התוסף.
בקטע קישורים לתמיכה:
- חשוב לוודא שסיפקת קישור לתנאים ולהגבלות של האפליקציה.
ודאו שאתם עומדים בהנחיות המיתוג של Google API, שכוללות שמות ותיאורים מותרים.
אם אתם מתייחסים למוצרי Google בדף העסקי שלכם, עליכם לציין את השם שלהם בפורמט שמופיע ברשימת הסימנים המסחריים. אם צוין, הקפידו לכלול את סמל הסימן המסחרי (TM); צריך להשתמש ב-Google DocsTM ולא ב-'Google Docs'.
שילוב עם שירותי הרישוי והחיוב של Google
כדי לאפשר לאפליקציות מ-Google Workspace Marketplace לשלב את שירותי הרישוי והחיוב של Google, צריך להיכנס אל Marketplace API.
הגדרות התקנה
תוספים יכולים לאפשר התקנה נפרדת בנוסף להתקנת אדמין. בדף הזה מפורטים כמה הבדלים בין שני סוגי ההתקנה, והוא לא מיועד לקדם אף אחד מסוגי ההתקנה. תוכלו לבחור אם לאפשר התקנה ספציפית בדף הגדרת האפליקציה של Google Workspace Marketplace SDK.
התקנה על ידי האדמין
התקנות לאדמינים מאפשרות לאדמין להוסיף תוסף לכל החשבונות בדומיין או לקבוצות גישה או ליחידות ארגוניות ספציפיות. רק מנהל דומיין יכול להתקין התקנה של אדמין. האדמין יכול להסכים לכל היקפי הגישה בשם כל המשתמשים בדומיין. המשתמשים לא מתבקשים להביע הסכמה להיקפי גישה כלשהם אם האדמין בוחר לעשות זאת.
בהמשך מפורטים כמה שיקולים בנוגע להתקנה של אדמין.
- אמצעי בקרה חזקים יותר. אדמינים יכולים להגביל את המשתמשים שיכולים לגשת לתוסף.
- תאימות לרישוי. אם האפליקציה דורשת רישיון, ניתוב התקנות דרך אדמין יכול לעזור לוודא שהרישיונות מופצים ונעשה בהם שימוש בהתאם למוסד הרלוונטי.
- הפחתת העומס על משתמשי הקצה. התקנה של אדמין מפחיתה את עומס ההגדרה למורים ולתלמידים. כתוצאה מכך, חוויית המשתמש עשויה להיות חלקה יותר עם פחות קליקים ופחות הזדמנויות לבלבול.
מידע נוסף על ביצוע התקנות של מנהלי מערכת ואיך פועל המבנה הארגוני מופיע במאמר התקנת אפליקציות מ-Marketplace בדומיין.
התקנה בנפרד
התקנות נפרדות מוסיפות תוסף לחשבון של המשתמש עצמו. המשתמשים יתבקשו להביע הסכמה להיקפי הגישה של התוסף במהלך ההתקנה.
בהמשך מפורטים כמה שיקולים בנוגע להתקנה ספציפית.
- מעודדים אימוץ. יותר משתמשים יכולים לראות את התוסף ולהתקין אותו מ-Google Workspace Marketplace. אם תאפשרו להתקין את האפליקציה באופן פרטני, זה עשוי לעודד מורים יותר לאמץ את המוצר שלכם או להמליץ עליו.
- בדיקות אדמין. אדמינים יכולים להתקין תוסף בנפרד כדי לבדוק או לבדוק אותו לפני שהם מאשרים או מתקינים אותו לקבוצה רחבה יותר.
בנוסף להתקנת תוספים בשם משתמשים, אדמינים יכולים גם לשמור על רשימת היתרים כדי לאפשר למשתמשים להתקין תוספים שמאפשרים התקנה אישית. גם אם תוסף לא מופיע ברשימת ההיתרים, המשתמשים יוכלו לראות את הדף שלו ב-Google Workspace Marketplace, אבל לא יוכלו להתקין אותו. במקום זאת הם יראו הודעה שמנהל הדומיין לא אישר להתקין אותו. מידע נוסף על ההתנהגות הזו זמין במאמר ניהול אפליקציות מ-Marketplace מ-Marketplace ברשימת ההיתרים.
מידע נוסף מופיע במאמרי העזרה בנושא הגדרות ההתקנה של Google Workspace Marketplace.
שילוב אפליקציות
עליך לציין כתובת URL של iframe להפעלה בשדה URI להגדרת קובץ מצורף. כתובת ה-URL הזו משמשת כערך src של ה-iframe בשביל Attachment Discovery iframe. מורים משתמשים ב-iframe של Discovery על קבצים מצורפים כדי למצוא תוכן או פעילויות לצירוף למטלה שלהם.
צריך גם לציין את כל קידומות ה-URI שמהן אפשר לצרף קבצים מהתוסף. התכונה הזו מגבירה את האבטחה על ידי מניעת קבצים מצורפים ממקורות לא מורשים.
מידע נוסף על השדות האלה זמין בדף המדריך בנושא iframes.
חשבונות בדיקה
יוצרים חשבונות בדיקה בדומיין להדגמה כדי לוודא שהתוסף הפרטי פועל בצורה נכונה. כדי לבדוק את המעבר בין התלמידים ב-iframe של עבודות התלמידים, צריך שני חשבונות של תלמידים.
חשבונות בדיקה מוצעים:
- תמי מורה, tammy.teacher@<דומיין ההדגמה שלכם>
- .Sam סטודנט, sam.student@<דומיין ההדגמה שלך>
- סאלי סטודנט, sally.student@<דומיין ההדגמה שלך>
כדי ליצור חשבון בדיקה חדש:
- מתחברים למסוף Admin.
- עוברים אל משתמשים.
- לוחצים על הוספת משתמש חדש (ראו איור 1).
- מזינים את פרטי המשתמש ומקצים תפקידים מתאימים.
איור 1. מיקום הקישור הוספת משתמש חדש במסוף Admin.
כך יוצרים קבוצת בדיקה חדשה:
- מתחברים למסוף Admin.
- עוברים אל קבוצות.
- לוחצים על יצירת קבוצה (ראו איור 2).
- מזינים את רשימת חברי הקבוצה ואת הבעלים שלה.
איור 2. מיקום הקישור ליצירת קבוצה במסוף Admin.