Promosikan add-on kepada pengguna melalui berbagi layar

Mempromosikan add-on melalui layar berbagi.

Halaman ini menjelaskan cara mempromosikan add-on kepada pengguna saat membagikan tab layar ke Google Meet dengan menempatkan sejumlah kecil kode pada laman web lain.

Tujuan exposeToMeetWhenScreensharing() memungkinkan situs mengirim informasi ke Meet saat tab dibagikan di layar yang dibagikan. Informasi ini digunakan dalam add-on dengan Meet saat pengguna mengklik "Mulai aktivitas" di spanduk presentasi jika mereka memiliki add-on diinstal. Jika pengguna tidak memiliki diinstal saat mereka berbagi layar tab, mereka diminta untuk menginstal add-on.

Tujuan AddonScreenshareInfo berisi lima properti yang dapat ditambahkan berdasarkan kasus penggunaan:

  • additionalData: Info yang dapat digunakan add-on untuk melakukan inisialisasi sendiri. Kaleng hanya ditetapkan jika properti startActivityOnOpen benar dan dapat diakses menggunakan ActivityStartingState. Untuk informasi selengkapnya, lihat Menggunakan awal aktivitas status.

  • cloudProjectNumber: Wajib diisi. Nomor project Google Cloud Anda.

  • mainStageUrl: URL yang dibuka panggung utama setelah add-on dimulai, seperti https://www.example.com. URL harus berasal dari origin sebagai URL yang ditentukan dalam manifes add-on.

  • sidePanelUrl: URL yang akan dibuka panel samping setelah add-on dimulai, seperti https://www.example.com. URL harus berasal dari origin sebagai URL yang ditentukan dalam manifes add-on.

  • startActivityOnOpen: Wajib diisi. Apakah akan memulai add-on aktivitas pengguna di Meet secara langsung saat pengguna memulai {i>add-on <i}dari spanduk presentasi. Harus benar jika properti mainStageUrl digunakan.

Menginstal dan mengimpor SDK

Anda dapat mengakses SDK menggunakan npm atau menggunakan gstatic.

Jika proyek Anda menggunakan npm, Anda dapat mengikuti petunjuk untuk Perkenalkan paket npm Add-on SDK.

Pertama, instal paket npm:

npm install @googleworkspace/meet-addons

Kemudian, SDK Add-on Meet tersedia dengan mengimpor MeetAddonScreenshareExport antarmuka:

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

Untuk pengguna TypeScript, definisi TypeScript dikemas dengan modul.

{i>gstatic<i}

SDK Add-on Google Meet tersedia sebagai Paket JavaScript dari gstatic, domain yang menayangkan konten statis.

Untuk menggunakan SDK Add-on Meet, tambahkan tag skrip berikut ke aplikasi:

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

SDK Add-on Meet tersedia melalui antarmuka MeetAddon di bagian window.meet.addon.

Contoh: Memuat di panggung utama

Dalam contoh kode berikut, pengguna yang layar membagikan halaman web di Meet yang berisi kode berikut akan diminta untuk meluncurkan {i>add-on<i}:

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

Ganti kode berikut:

  • CLOUD_PROJECT_NUMBER: String. Nomor project project Google Cloud Anda.
  • MAIN_STAGE_URL: String. URL untuk panggung utama.

Saat pengguna di layar panggilan Meet membagikan halaman tersebut, dia akan melihat banner presentasi di Meet. Mengklik tombol pada banner membuka add-on untuk nomor project cloud yang ditentukan di layar utama. Properti mainStageUrl dimuat, dan Properti additionalData digunakan untuk menyetel aktivitas yang dimulai status add-on. Pengguna lain dalam panggilan tersebut langsung diminta untuk menginstal atau meluncurkan add-on.

Contoh: Memuat di panel samping

Dalam contoh kode berikut, layar pengguna membagikan halaman kepada {i>add-on <i}yang ingin dimulai di panel samping, daripada tahap utama:

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

Ganti kode berikut:

  • CLOUD_PROJECT_NUMBER: String. Nomor project project Google Cloud.
  • SIDE_PANEL_URL: String. URL untuk panel samping.

Saat pengguna di layar panggilan Meet membagikan halaman tersebut, dia akan melihat banner presentasi di Meet. Mengklik tombol pada banner membuka add-on untuk nomor project cloud yang ditentukan di panel samping. Properti sidePanelUrl dimuat, dan Properti additionalData digunakan untuk menyetel aktivitas yang dimulai status add-on. Pengguna lain dalam panggilan tersebut langsung diminta untuk menginstal atau meluncurkan add-on.

Contoh: Memuat di panel samping tanpa memulai aktivitas

Dalam contoh kode berikut, layar pengguna membagikan halaman kepada yang harus menyesuaikan izin resource sebelum aktivitas dapat dimulai. Karena persyaratan ini, harus dimulai di panel samping, tanpa yang dimulai untuk semua orang.

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

Ganti kode berikut:

  • CLOUD_PROJECT_NUMBER: String. Nomor project project Google Cloud.
  • SIDE_PANEL_URL: String. URL untuk panel samping.

Saat pengguna di layar panggilan Meet membagikan halaman tersebut, dia akan melihat banner presentasi di Meet. Mengklik tombol pada banner membuka add-on untuk nomor project cloud yang ditentukan di panel samping. Karena startActivityOnOpen disetel ke false (salah), tombol start activity dinonaktifkan sampai ActivityStartingState disetel. Untuk informasi selengkapnya, lihat Menggunakan aktivitas status awal.

Setelah aktivitas dimulai, pengguna lain dalam panggilan diminta untuk meluncurkan atau menginstal add-on.

Pencocokan origin

Origin yang diberikan dalam mainStageUrl dan atribut sidePanelUrl dibandingkan dengan origin dalam add-on dari nomor project cloud yang disediakan. Jika semuanya cocok, pengguna diizinkan meluncurkan add-on.

Selain itu, asal situs yang menginisiasi berbagi layar harus dicantumkan di kolom addOnOrigins pada add-on manifes.

Untuk informasi selengkapnya, lihat Add-on keamanan.