از طریق اشتراک‌گذاری صفحه نمایش، افزونه‌ای را برای کاربران تبلیغ کنید

تبلیغ یک افزونه از طریق صفحه نمایش اشتراک گذاری

این صفحه نحوه تبلیغ یک افزونه را برای کاربران در حین اشتراک‌گذاری صفحه با Google Meet با قرار دادن مقدار کمی کد در یک صفحه وب دیگر توضیح می‌دهد.

متد exposeToMeetWhenScreensharing() به سایت اجازه می‌دهد اطلاعاتی را برای Meet ارسال کند، زمانی که برگه‌اش به اشتراک گذاشته می‌شود. این اطلاعات در تجربه افزودنی با Meet زمانی استفاده می‌شود که کاربر در صورت نصب افزونه، روی «شروع فعالیت» روی بنر ارائه کلیک می‌کند. اگر کاربر هنگام استفاده از برگه اشتراک‌گذاری روی صفحه، افزونه را نصب نکرده باشد، از او خواسته می‌شود که افزونه را نصب کند.

شی AddonScreenshareInfo شامل پنج ویژگی است که می توان بر اساس مورد استفاده اضافه کرد:

  • additionalData : اطلاعاتی که افزونه می تواند برای مقداردهی اولیه خود از آن استفاده کند. فقط در صورتی می توان تنظیم کرد که ویژگی startActivityOnOpen درست باشد و با استفاده از ActivityStartingState بتوان به آن دسترسی داشت. برای اطلاعات بیشتر، به دریافت وضعیت شروع فعالیت مراجعه کنید.

  • cloudProjectNumber : الزامی است. شماره پروژه پروژه Google Cloud شما.

  • mainStageUrl : آدرس اینترنتی که مرحله اصلی پس از شروع افزونه باز می شود، مانند https://www.example.com . نشانی وب باید به همان مبدأ مربوط به URL های مشخص شده در مانیفست افزودنی باشد.

  • sidePanelUrl : نشانی اینترنتی که پانل کناری پس از شروع افزونه باز می شود، مانند https://www.example.com . نشانی وب باید به همان مبدأ مربوط به URL های مشخص شده در مانیفست افزودنی باشد.

  • startActivityOnOpen : الزامی است. این که آیا بلافاصله زمانی که کاربر افزونه را از بنر ارائه شروع می‌کند، تجربه افزودنی فعالیت در Meet شروع شود. اگر از ویژگی mainStageUrl استفاده شود، باید درست باشد.

SDK را نصب و وارد کنید

با استفاده از npm یا gstatic می توانید به SDK دسترسی پیدا کنید.

اگر پروژه شما از npm استفاده می‌کند، می‌توانید دستورالعمل‌های بسته npm SDK افزونه‌های Meet را دنبال کنید.

ابتدا بسته npm را نصب کنید:

npm install @googleworkspace/meet-addons

سپس، SDK افزودنی Meet با وارد کردن رابط MeetAddonScreenshareExport در دسترس است:

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

برای کاربران TypeScript، تعاریف TypeScript با ماژول بسته بندی می شود.

gstatic

SDK افزونه‌های Google Meet به‌عنوان یک بسته جاوا اسکریپت از gstatic در دسترس است، دامنه‌ای که محتوای ثابت را ارائه می‌کند.

برای استفاده از افزونه‌های Meet SDK، تگ اسکریپت زیر را به برنامه خود اضافه کنید:

<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 : رشته. شماره پروژه پروژه 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 برای تنظیم وضعیت شروع فعالیت افزونه استفاده می‌شود. از دیگر کاربران حاضر در تماس بلافاصله خواسته می شود که افزونه را نصب یا راه اندازی کنند.

تطبیق مبدا

مبداهای ارائه شده در ویژگی mainStageUrl و ویژگی sidePanelUrl با مبداهای موجود در مانیفست الحاقی شماره پروژه ابری ارائه شده مقایسه می شوند. اگر همه چیز مطابقت داشته باشد، کاربر مجاز است افزونه را راه اندازی کند.

علاوه بر این، مبدأ سایتی که اشتراک‌گذاری صفحه را آغاز می‌کند باید در قسمت addOnOrigins در مانیفست افزودنی فهرست شود.

برای اطلاعات بیشتر، امنیت افزونه را ببینید.