הדף הזה כולל את המידע שצריך לדעת על יצירה ועל הגדרת פרויקטים ב-Google Cloud לתוספים ל-Classroom. פרויקטים ב-Google Cloud משמשים להטמעת כניסה יחידה (SSO) של Google באמצעות OAuth 2.0 (SSO של Google), כדי לאשר בקשות שנשלחו על ידי התוסף וכדי לנהל דף האפליקציה של התוסף ב-Google Workspace Marketplace החנות.
למידע כללי יותר על פרסום תוסף ל: ראו פרסום אפליקציה ב-Marketplace.
יצירת פרויקט ב-Google Cloud
אפשר ליצור שני סוגי פרויקטים: פרויקט פרטי שמשמש למטרות הבאות: ופרויקט ציבורי שמשתמשי הקצה יכולים להגיע אליהם. ההגדרה "ציבורית" וגם "פרטי" תוויות מתייחסות לחשיפה של האפליקציה שלך Google Workspace Marketplace; זירת מסחר פרטית רק משתמשים בדומיין שבו היא הותקנה יכולים להתקין אותו בזמן שאפליקציה ציבורית מ-Marketplace זמינים לכל דומיין Google Workspace. צריכים להיות שני סוגים של מאחר שפרויקט לא יכול להיות גם ציבורי וגם פרטי. אפליקציות ציבוריות חייבים לעבור בדיקה ולקבל אישור לפני שהם זמינים בזירת המסחר.
למידע כללי על יצירת פרויקט ב-Google Cloud, קראו את המאמר יצירת פרויקט ב-Google Cloud.
יצירת פרויקט ציבורי ב-Google Cloud
הפרויקט הזה מייצג את אפליקציית התוסף שאפשר לגשת אליה אדמינים, מורים ותלמידים. פרויקט ציבורי חייב לעבור בדיקה אושר על ידי צוות Google Workspace Marketplace לפני השקתו או מותקנת.
יוצרים פרויקט חדש ב-Google Cloud בדומיין הייצור.
מפעילים את Classroom API בפרויקט בענן.
מפעילים את Google Workspace Marketplace SDK בפרויקט Cloud.
הגדרת ה-SDK של Marketplace הגדרת האפליקציה חשיפה של האפליקציה לגלוי לכולם ומסמנים את התיבה לא רשום.
צריך למלא את שדות החובה ב-SDK של Marketplace את הדף דף האפליקציה בחנות ולוחצים על פרסום.
האפליקציה שלך תיבדק על ידי צוות Google Workspace Marketplace. הם יתקשר איתך באמצעות כתובת האימייל של המפתח שמצוינת Marketplace SDK. אחרי שהאפליקציה תאושר, מוחקים את התיבה לא רשום כדי שמורים ואדמינים יוכלו למצוא אותה Marketplace.
יצירת פרויקט פרטי ב-Google Cloud
הפרויקט הפרטי הזה מייצג את אפליקציית התוסף שמשמשת לפיתוח. הוא לא נגיש למשתמשים מחוץ לדומיין שבו הוא נוצר, אבל אין צורך לאשר אותו לפני ההתקנה. לכן, Google ממליצה באמצעות הפרויקט הזה כדי לפתח ולבדוק את התוסף שלכם בסביבה מבוקרת.
נדרשת גישה לדומיין ב-Google Workspace for Education עם ההוראה Teaching & מצב למידה או Plus כדי ליצור פרויקט פרטי. אם עדיין אין לך גישה הדומיין, יש לפעול לפי השלבים הבאים כדי להגדיר דומיין הדגמה (דמו) ב-Google Workspace for Education, ולשדרג אותו מוסיפים רישיון כדי לתת לו גישה ל-Classroom Add-ons API:
- מבצעים את השלבים לקבלת דומיין בדיקה של מפתח.
לאחר הכניסה כאדמין בדומיין ההדגמה, יצירת שם משתמש חדש פרויקט ב-Google Cloud.
אם אין לכם גישה למסוף Google Cloud או ליצירת אירוע בפרויקטים ב-Cloud, צריך לבדוק את הדברים הבאים מסוף Admin:
- עוברים אל הגדרות חשבון > לדף הגדרות גישה מבוססות-גיל בוחרים באפשרות כל המשתמשים בקבוצה או ביחידה הארגונית הזו הם בני 18 ומעלה, older.
- בקטע אפליקציות > שירותי Google נוספים:
- Google Cloud Platform מופעלת לכולם.
- ההגדרות ליצירת פרויקטים הן המשתמשים יכולים ליצור פרויקטים.
- הגדרות הגישה ל-Cloud Shell הן Allow access to Cloud Shell.
ממלאים ושולחים את טופס הבקשה לשדרוג דומיין להדגמה. השליחה מתבצעת טופס בקשה ש-Google תשדרג את דומיין ההדגמה ל-Google Workspace for Education Plus עם והם מאפשרים לפרויקט ב-Cloud API לתוספים של Classroom.
נשלח לך אימייל כשתהליך השדרוג ויצירת רשימת ההיתרים הושלם. עליך להקצות רישיונות Plus לחשבונות של מורים לבדיקה ב מסוף Admin. מתחת ספרייה > משתמשים, יצירה או בחירה של חשבונות מורים לבחינות. בכל פעם רישיונות של המורים, מוודאים ש-Google Workspace for Education Plus הוקצתה.
מפעילים את Classroom API בפרויקט בענן.
מפעילים את Google Workspace Marketplace SDK בפרויקט Cloud.
הגדרת ה-SDK של Marketplace הגדרת האפליקציה חשיפה של האפליקציה לפרטית.
צריך למלא את שדות החובה ב-SDK של Marketplace את הדף דף האפליקציה בחנות ולוחצים על פרסום. לאחר הפרסום של דף האפליקציה, המשתמשים בדומיין למצוא את האפליקציה ולהתקין אותה ב-Google Workspace Marketplace, או עוברים אל כתובת ה-URL של האפליקציה שמופיעה בדף האפליקציה בחנות.
OAuth 2.0
כדי לקבל גישה ל-Classroom API, צריך לתת למשתמשים הסכמה לגישה לנתוני המשתמשים. האלה מתקבלים באמצעות שליחת בקשת גישה ל-Google להיקפי הרשאות OAuth עבור משתמשים שמחוברים לחשבון והם מקבלים אסימון שיכול לשמש לאחר מכן לביצוע קריאות ל-API Google Classroom צריך להגדיר היקפים בקטע דף האפליקציה בחנות Google Workspace Marketplace, כך שמנהל הדומיין יכולים להביע הסכמה בשם המשתמשים בדומיין שלהם אם הם מתקינים את התוסף.
רשימה מפורטת של כל ממשקי ה-API הזמינים מופיעה בדף היקפי OAuth עבור Google APIs ואת השימושים שלהם. מידע נוסף זמין במאמר הגדרת דף OAuth במשאבי העזרה של Workspace למידע כללי על תצורת OAuth.
הרשאות של משתמשים
אפליקציית האינטרנט צריכה לבקש לפחות אחד מהיקפי ההרשאות הבאים:
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 של פרויקט Google Cloud הציבורי שלך רישום מציין את שם האפליקציה תיאורים שמיועדים למשתמשי הקצה. אפשר לספק את הפרטים האלה בכמה פעמים שפות בקטע פרטי האפליקציה.
פועלים לפי ההנחיות הבאות בכרטיסי המוצר:
בקטע פרטי האפליקציה:
יש להימנע מסימני פיסוק בשם האפליקציה. לדוגמה, אפשר להשתמש בשדה התוסף שלי על ידי החברה שלי" במקום 'החברה שלי: התוסף שלי' או "התוסף שלי, מבית חברה".
התיאור הקצר והתיאור המפורט לא יכולים לכלול בדיוק אותו הטקסט.
+ מוודאים שבחרתם ערך בשדה 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, אבל אין לכם אפשרות להתקין אותו add-on; במקום זאת, הם רואים הודעה שמסבירה שהתוסף לא מורשה להתקנה על ידי מנהל דומיין. למידע נוסף על ניהול Google Workspace אפליקציות מ-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.