Promosikan add-on kepada pengguna melalui berbagi layar

Mempromosikan add-on melalui berbagi layar.

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 mengeklik "Mulai aktivitas" di banner presentasi jika mereka memiliki add-on diinstal. Jika pengguna belum menginstal add-on saat berbagi layar tab, mereka akan 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. Kaleng hanya ditetapkan jika properti startActivityOnOpen benar dan dapat diakses menggunakan ActivityStartingState. Untuk informasi selengkapnya, lihat Memulai aktivitas status.

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

  • mainStageUrl: URL yang dibuka oleh tahap 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 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 langsung memulai pengalaman add-on aktivitas di Meet saat pengguna memulai add-on dari banner presentasi. Harus benar jika properti mainStageUrl digunakan.

Menginstal dan mengimpor SDK

Anda dapat mengakses SDK menggunakan npm atau menggunakan gstatic.

Jika project Anda menggunakan npm, Anda dapat mengikuti petunjuk untuk paket npm Meet Add-ons 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.

gstatic

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

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

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

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

Contoh: Memuat di panel samping tanpa memulai aktivitas

Dalam contoh kode berikut, layar pengguna berbagi halaman dengan add-on 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 untuk project Cloud Anda.
  • SIDE_PANEL_URL: String. URL untuk panel samping.

Saat pengguna di layar panggilan Meet membagikan halaman, dia akan melihat banner presentasi di Meet. Mengklik tombol di banner akan membuka add-on untuk nomor project cloud tertentu di panel samping. Karena properti startActivityOnOpen ditetapkan ke salah, tombol mulai aktivitas dinonaktifkan hingga ActivityStartingState ditetapkan. Untuk informasi selengkapnya, lihat Menggunakan aktivitas status awal.

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

"Animasi" contoh add-on di GitHub menyertakan contoh ini sebagai bagian dari {i>add-on<i} yang lengkap. Kapan halaman indeks aplikasi web yang terkait dengan {i>add-on<i} tersebut ditampilkan, pengguna yang melihat diminta untuk menginstal atau menyiapkan {i>add-on<i}.

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, mereka akan melihat banner presentasi di Meet. Mengklik tombol di banner akan membuka add-on untuk nomor project cloud tertentu di tahap utama. Properti mainStageUrl dimuat, dan properti additionalData digunakan untuk menetapkan status awal aktivitas add-on. Pengguna lain dalam panggilan akan segera diminta untuk menginstal atau meluncurkan add-on.

Contoh: Memuat di panel samping

Dalam contoh kode berikut, layar pengguna berbagi halaman dengan add-on yang ingin dimulai di panel samping, bukan di panggung 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 untuk project Cloud Anda.
  • SIDE_PANEL_URL: String. URL untuk panel samping.

Saat pengguna di layar panggilan Meet membagikan halaman, mereka akan melihat banner presentasi di Meet. Mengklik tombol di banner akan membuka add-on untuk nomor project cloud tertentu di panel samping. Properti sidePanelUrl dimuat, dan properti additionalData digunakan untuk menetapkan status awal aktivitas add-on. Pengguna lain dalam panggilan akan segera diminta untuk menginstal atau meluncurkan 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 Keamanan add-on.