קידום תוסף למשתמשים באמצעות שיתוף המסך

קידום תוסף באמצעות שיתוף מסך.

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

השיטה exposeToMeetWhenScreensharing() מאפשרת לאתר לשלוח מידע ל-Meet כשמשתפים את המסך של הכרטיסייה שלו. המידע הזה משמש שלכם ב-Meet, משתמש לוחץ על 'התחלת פעילות' בבאנר של המצגת, אם יש להם והתוסף הותקן. אם למשתמש אין את ואז להתקין את התוסף כשהמשתמש משתף כרטיסייה, צריך להתקין את התוסף.

AddonScreenshareInfo האובייקט מכיל חמישה מאפיינים שאפשר להוסיף בהתאם לתרחיש לדוגמה:

  • additionalData: מידע שבעזרתו התוסף יכול לאתחל את עצמו. אפשר להגדיר את הערך רק אם המאפיין startActivityOnOpen מוגדר כ-True ואפשר לגשת אליו באמצעות ActivityStartingState. מידע נוסף זמין במאמר התחלת הפעילות .

  • cloudProjectNumber: זהו שדה חובה. מספר הפרויקט ב-Google Cloud.

  • mainStageUrl: כתובת ה-URL שבה נפתחת הבמה הראשית אחרי שהתוסף מתחיל לפעול, למשל https://www.example.com. כתובת ה-URL חייבת להיות שייכת לאותו מקור כמו כתובות ה-URL שצוינו במניפסט של התוסף.

  • sidePanelUrl: כתובת ה-URL שהחלונית הצדדית נפתחת אחרי התוסף מתחיל, למשל https://www.example.com. כתובת ה-URL חייבת להשתייך לאותה origin ככתובות ה-URL שצוינו מניפסט של תוסף.

  • startActivityOnOpen: זהו שדה חובה. האם להפעיל את תוסף הפעילות ב-Meet מיד כשהמשתמש מתחיל מהבאנר של המצגת. חייב להיות true אם נעשה שימוש במאפיין mainStageUrl.

התקנה וייבוא של ה-SDK

אפשר לגשת ל-SDK באמצעות npm או באמצעות gstatic.

אם בפרויקט שלכם נעשה שימוש ב-NPM, תוכלו לפעול לפי ההוראות של חבילת NPM של SDK לתוספים ב-Meet

קודם כול, מתקינים את חבילת ה-npm:

npm install @googleworkspace/meet-addons

לאחר מכן, תוכלו לייבא את הממשק MeetAddonScreenshareExport כדי להשתמש ב-SDK של תוספי Meet:

import {meet} from '@googleworkspace/meet-addons/meet.addons.screenshare';

למשתמשי TypeScript, ההגדרות של TypeScript ארוזות במודול.

Gstatic

Google Meet Add-ons SDK זמין בתור חבילת JavaScript מ-gstatic, דומיין שמציג תוכן סטטי.

כדי להשתמש ב-SDK של תוספי Meet, צריך להוסיף את תג הסקריפט הבא app:

<script src="https://www.gstatic.com/meetjs/addons/1.1.0/meet.addons.screenshare.js"></script>

ה-SDK של תוספי Meet זמין דרך הממשק של MeetAddon בקטע window.meet.addon.

דוגמה: טעינה בחלונית הצדדית בלי להתחיל פעילות

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

<script>
meet.addon.screensharing.exposeToMeetWhenScreensharing(
  {
    cloudProjectNumber: CLOUD_PROJECT_NUMBER,
    startActivityOnOpen: false,
    sidePanelUrl: SIDE_PANEL_URL,
  }
);
</script>

מחליפים את מה שכתוב בשדות הבאים:

  • CLOUD_PROJECT_NUMBER: מחרוזת. מספר הפרויקט פרויקט בענן.
  • SIDE_PANEL_URL: מחרוזת. כתובת ה-URL של חלונית הצד.

כשהמשתמש במסך השיחה ב-Meet משתף את הדף, הוא רואה באנר של הצגה ב-Meet. לחיצה על הלחצן בבאנר פותחת את התוסף של מספר הפרויקט ב-Cloud בחלונית הצדדית. מאז startActivityOnOpen שהוגדר כ-False, הלחצן 'התחלת פעילות' מושבת עד ActivityStartingState הוגדרה. מידע נוסף זמין במאמר שימוש בפעילות מצב התחלתי.

אחרי שהפעילות מתחילה, משתמשים אחרים בשיחה יתבקשו לבצע את הפעולות הבאות: להפעיל או להתקין את התוסף.

"אנימציה" דוגמה של תוסף ב-GitHub כולל את הדוגמה הזו כחלק מתוסף מלא. מתי דף האינדקס של אפליקציית האינטרנט שמשויכת לתוסף מוצגת, המשתמש שמציג את האפליקציה מתבקש להתקין או להגדיר

דוגמה: טעינה בשלב הראשי

בדוגמת הקוד הבאה, משתמש שמשתף מסך עם דף אינטרנט ב-Meet שמכיל את הקוד הבא יתבקש להפעיל את התוסף:

<script>
meet.addon.screensharing.exposeToMeetWhenScreensharing(
  {
    cloudProjectNumber: CLOUD_PROJECT_NUMBER,
    startActivityOnOpen: true,
    mainStageUrl: MAIN_STAGE_URL,
    additionalData: "{\"selected_item\": \"42\"}",
  }
);
</script>

מחליפים את מה שכתוב בשדות הבאים:

  • CLOUD_PROJECT_NUMBER: מחרוזת. מספר הפרויקט פרויקט ב-Google Cloud.
  • MAIN_STAGE_URL: מחרוזת. כתובת ה-URL של הבמה הראשית.

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

דוגמה: טעינת נתונים בחלונית הצדדית

בדוגמת הקוד הבאה, מסך המשתמש משתף דף עם תוסף שרוצה להתחיל בחלונית הצדדית במקום בחלונית הראשית:

<script>
meet.addon.screensharing.exposeToMeetWhenScreensharing(
  {
    cloudProjectNumber: CLOUD_PROJECT_NUMBER,
    startActivityOnOpen: true,
    sidePanelUrl: SIDE_PANEL_URL,
    additionalData: "{\"selected_item\": \"42\"}",
  }
);
</script>

מחליפים את מה שכתוב בשדות הבאים:

  • CLOUD_PROJECT_NUMBER: מחרוזת. מספר הפרויקט פרויקט בענן.
  • SIDE_PANEL_URL: מחרוזת. כתובת ה-URL של חלונית הצד.

כשהמשתמש במסך השיחה ב-Meet משתף את הדף, הוא רואה באנר של הצגה ב-Meet. לחיצה על הלחצן בבאנר פותחת את התוסף של מספר הפרויקט ב-Cloud בחלונית הצדדית. המאפיין sidePanelUrl נטען, והמאפיין additionalData משמש להגדרת מצב ההתחלה של הפעילות בתוסף. משתמשים אחרים בשיחה יתבקשו להתקין או להפעיל את התוסף באופן מיידי.

התאמה למקור

המקורות שצוינו mainStageUrl של הנכס sidePanelUrl מושוות למקורות של התוסף של מספר הפרויקט בענן שסופק. אם הכול תואם, המשתמש מורשה להפעיל את התוסף.

בנוסף, יש לציין את המקור של האתר שמתחיל את שיתוף המסך בשדה addOnOrigins שבתוסף מניפסט.

למידע נוסף, ראו תוסף .