הגדרת פרויקט ב-Google Cloud

בדף הזה תוכלו למצוא מידע על יצירה והגדרה של פרויקטים ב-Google Cloud לתוספים ל-Classroom. פרויקטים ב-Google Cloud משמשים להטמעת כניסה יחידה ל-Google דרך OAuth 2.0‏ (Google SSO), לאישור בקשות שנשלחות על ידי התוסף ולניהול כרטיס התוסף בחנות Google Workspace Marketplace.

מידע כללי נוסף על פרסום תוסף ב-Marketplace זמין במאמר פרסום אפליקציה.

יצירת פרויקט ב-Google Cloud

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

מידע כללי על יצירת פרויקטים ב-Google Cloud מופיע במאמר יצירת פרויקט ב-Google Cloud.

יצירת פרויקט ציבורי ב-Google Cloud

הפרויקט הזה מייצג את אפליקציית התוסף שאדמינים, מורים ותלמידים יכולים לגשת אליה. לפני שאפשר להשיק או להתקין פרויקט ציבורי, צוות Google Workspace Marketplace צריך לבדוק אותו ולאשר אותו.

  1. יוצרים פרויקט חדש ב-Google Cloud בדומיין הייצור.

    יצירת פרויקט ב-Google Cloud

  2. מפעילים את Classroom API בפרויקט ב-Cloud.

    הפעלת Classroom API

  3. מפעילים את ה-SDK של Google Workspace Marketplace בפרויקט ב-Cloud.

    הפעלת Google Workspace Marketplace SDK

  4. מגדירים את הגדרת האפליקציה הרשאות הגישה לאפליקציה ב-Marketplace SDK ל-גלוי לכולם ומסמנים את התיבה לא רשום.

  5. ממלאים את שדות החובה בדף Store Listing ב-Marketplace SDK ולוחצים על PUBLISH.

  6. האפליקציה שלך תיבדק על ידי צוות Google Workspace Marketplace. הם יפנו אליכם באמצעות כתובת האימייל של המפתח שצוינה ב-SDK של Marketplace. אחרי שהאפליקציה תאושר, צריך לבטל את הסימון בתיבה Unlisted (לא רשומה) כדי שמורים ואדמינים יוכלו למצוא אותה בMarketplace.

יצירת פרויקט פרטי ב-Google Cloud

הפרויקט הפרטי הזה מייצג את אפליקציית התוסף שמשמש לפיתוח. היא לא נגישה למשתמשים מחוץ לדומיין שבו היא נוצרה, אבל לא צריך לאשר אותה לפני ההתקנה. לכן, Google ממליצה להשתמש בפרויקט הזה כדי לפתח ולבדוק את התוסף בסביבה מבוקרת.

כדי ליצור פרויקט פרטי, צריך גישה לדומיין ב-Google Workspace for Education עם רישיון Teaching &Learning או Plus. אם עדיין אין לכם גישה לדומיין כזה, צריך לבצע את השלבים הבאים כדי להגדיר דומיין הדגמה (דמו) ב-Google Workspace for Education, לשדרג אותו ל-Plus רישיון ולאפשר לו לגשת ל-API של התוספים ב-Classroom:

  1. מבצעים את השלבים לקבלת דומיין בדיקה למפתחים.

  2. יוצרים פרויקט חדש ב-Google Cloud כאדמין בדומיין ההדגמה.

    יצירת פרויקט ב-Google Cloud

    אם אין לכם גישה למסוף Google Cloud או שאתם לא מצליחים ליצור פרויקטים ב-Cloud, עליכם לבדוק את הדברים הבאים ב מסוף Admin:

    • עוברים לדף הגדרות חשבון > הגדרות גישה מבוססת-גיל ובוחרים באפשרות כל המשתמשים בקבוצה או ביחידה הארגונית הזו בני 18 ומעלה.
    • בקטע אפליקציות > שירותי Google נוספים:
    • Google Cloud Platform מופעל לכולם.
    • ההגדרות של יצירת פרויקטים הן המשתמשים יכולים ליצור פרויקטים.
    • הגדרות הגישה ל-Cloud Shell הן Allow access to Cloud Shell.

  3. ממלאים את טופס הבקשה לשדרוג דומיין לדמו ושולחים אותו. שליחת הטופס הזה מבקשת מ-Google לשדרג את הדומיין לדמו ל-Google Workspace for Education Plus עם עשרה רישיונות, ולאפשר לפרויקט שלכם ב-Cloud לגשת ל-API של התוספים של Classroom.

    תקבלו אימייל כשתהליך השדרוג ותהליך ההוספה לרשימת ההיתרים יסתיימו. מקצים רישיונות Plus לחשבונות של מורים לבדיקה ב מסוף Admin. בקטע Directory > Users, יוצרים או בוחרים את חשבונות המורים לבדיקה. בדף רישיונות של כל מורה, מוודאים שהרישיון ל-Google Workspace for Education Plus הוקצה.

  4. מפעילים את Classroom API בפרויקט ב-Cloud.

    הפעלת Classroom API

  5. מפעילים את ה-SDK של Google Workspace Marketplace בפרויקט ב-Cloud.

    הפעלת ה-SDK של Google Workspace Marketplace

  6. מגדירים את ה-SDK של Marketplace להגדרת האפליקציה הרשאות גישה לאפליקציה כ-private.

  7. ממלאים את שדות החובה בדף Store Listing ב-Marketplace SDK ולוחצים על PUBLISH. אחרי שדף האפליקציה יפורסם, המשתמשים בדומיין יוכלו למצוא ולהתקין את האפליקציה ב-Google Workspace Marketplace או להיכנס לכתובת ה-URL של האפליקציה שמוצגת בדף האפליקציה בחנות.

OAuth 2.0

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

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

בדף היקפי 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 של Attachment Discovery, יכול להיות שלתוסף עדיין לא יהיה קובץ מצורף בפוסט. הפרמטר addOnToken של השאילתה מאפשר לשלוח בקשות לקבלת הפרטים הבאים:
      • יצירת קובץ מצורף מתחת לפוסט (addOnToken נדרש)
      • אימות ההשקה (addOnToken מאומת אם הוא מסופק, והוא נדרש אם אין לקובץ התוסף קובץ מצורף קיים בפוסט)

אימות OAuth

תוסף ל-Classroom משתמש ב-Google APIs כדי לגשת לנתונים של משתמשי Google.

מידע נוסף על תהליך האימות מופיע במאמר שאלות נפוצות לגבי אימות OAuth API.

דף המוצר ב-Google Workspace Marketplace

מידע כללי על הגדרות SDK ב-Google Workspace Marketplace זמין במאמרים הפעלה והגדרה של Google Workspace Marketplace SDK ויצירת דף אפליקציה בחנות Google Workspace Marketplace.

שיקולים לגבי דף האפליקציה

הרשומה של חנות ה-SDK ב-Marketplace של הפרויקט הציבורי ב-Google Cloud מציינת את השם והתיאורים של האפליקציה למשתמשים הקצה. אפשר לספק את הפרטים האלה בכמה שפות בקטע פרטי האפליקציה.

חשוב לפעול לפי ההנחיות הבאות בנכסי המלון:

  • בקטע פרטי האפליקציה:

    • אין להשתמש בסימני פיסוק בשם האפליקציה. לדוגמה, עדיף להשתמש בשם 'התוסף שלי של חברת My Company' במקום 'חברת My Company: התוסף שלי' או 'התוסף שלי, של חברת My Company'.

    • התיאור הקצר והתיאור המפורט לא יכולים להכיל את אותו טקסט בדיוק.

    + מוודאים שבחרתם ערך בשדה Pricing. השדה הזה כולל את האפשרויות בחינם, בתשלום עם תקופת ניסיון בחינם, בתשלום עם תכונות בחינם ובתשלום. אין צורך לציין את סכום העלות במודעה ב-Marketplace.

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

    • למידע נוסף, אפשר לעיין בפריטים שמפורטים בתיאור פרטי האפליקציה ב-Marketplace.

שילוב עם שירותי הרישוי והחיוב של 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 להפעלה בשדה Attachment Setup URI. כתובת ה-URL הזו משמשת כערך src של ה-iframe בiframe של מודעות Discovery עם קבצים מצורפים. המורים משתמשים ב-iframe של Discovery כדי למצוא תוכן או פעילויות שאפשר לצרף למטלה.

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

פרטים נוספים על השדות האלה זמינים בדף המדריך בנושא iframes.

חשבונות בדיקה

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

הצעות לחשבונות בדיקה:

  • Tammy Teacher, ‏ tammy.teacher@<your demo domain>
  • Sam Student, ‏ sam.student@<your demo domain>
  • סאלי סטודנט, sally.student@<דומיין ההדגמה שלך>

כדי ליצור חשבון בדיקה חדש:

  1. נכנסים למסוף Admin.
  2. עוברים אל משתמשים.
  3. לוחצים על הוספת משתמש חדש (ראו איור 1).
  4. מזינים את פרטי המשתמש ומקצים לו את התפקידים המתאימים.

לוחצים על &#39;הוספת משתמש חדש&#39; איור 1. מיקום הקישור הוספת משתמש חדש במסוף Admin.

כדי ליצור קבוצת בדיקה חדשה:

  1. נכנסים למסוף Admin.
  2. עוברים אל קבוצות.
  3. לוחצים על יצירת קבוצה (ראו איור 2).
  4. מזינים את רשימת חברי הקבוצה ואת הבעלים שלה.

לוחצים על &#39;יצירת קבוצה&#39; איור 2. מיקום הקישור ליצירת קבוצה במסוף Admin.