קידום תוסף למשתמשים

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

הצ'אט של השיחה

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

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

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

שיתוף המסך

בדף הזה מוסבר איך לקדם תוסף למשתמשים בזמן שמשתפים מסך של כרטיסייה ב-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 חייבת להיות שייכת לאותו מקור כמו כתובות ה-URL שצוינו במניפסט של התוסף.

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

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

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

npm install @googleworkspace/meet-addons

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

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

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

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

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

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

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

כשהמשתמש משתף את המסך בשיחה ב-Meet, מופיע ב-Meet באנר של מצגת. לחיצה על הלחצן שבבאנר פותחת את התוסף עבור מספר פרויקט הענן שצוין בחלונית הצדדית. מאחר שהמאפיין 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: מחרוזת. מספר הפרויקט ב-Cloud.
• ‫SIDE_PANEL_URL: מחרוזת. כתובת ה-URL של חלונית הצד.

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

התאמה למקור

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

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

מידע נוסף זמין במאמר בנושא אבטחת תוספים.

נושאים קשורים

• שיתוף פעולה באמצעות תוסף ל-Meet
• אבטחת תוספים