Konfigurasi project Google Cloud

Halaman ini berisi informasi yang perlu Anda ketahui tentang membuat dan mengonfigurasi project Google Cloud untuk add-on Classroom. Project Google Cloud digunakan untuk menerapkan Google Single Sign-On melalui OAuth 2.0 (SSO Google), mengizinkan permintaan yang dibuat oleh add-on, dan mengelola listingan add-on di toko Google Workspace Marketplace.

Untuk mengetahui informasi umum lebih lanjut tentang memublikasikan add-on ke Marketplace, lihat Memublikasikan aplikasi.

Pembuatan project Google Cloud

Ada dua jenis project yang dapat dibuat: project pribadi yang digunakan untuk pengembangan dan project publik yang dapat dijangkau oleh pengguna akhir. Label "publik" dan "pribadi" mengacu pada visibilitas aplikasi Anda di Google Workspace Marketplace; aplikasi Marketplace pribadi hanya dapat diinstal oleh pengguna dalam domain tempatnya dibuat, sementara aplikasi Marketplace publik tersedia untuk semua domain Google Workspace. Aplikasi tersebut harus merupakan dua aplikasi terpisah karena project tidak boleh bersifat publik dan pribadi. Aplikasi publik harus ditinjau dan disetujui sebelum tersedia di marketplace.

Penting: Anda tidak dapat mengonversi project pribadi menjadi project publik. Buat project pribadi untuk mengembangkan add-on Anda dan project publik untuk mewakili versi siap produksi.

Untuk mengetahui informasi umum pembuatan project Google Cloud, buka Membuat project Google Cloud.

Membuat project Google Cloud pribadi

Project pribadi ini mewakili aplikasi add-on yang digunakan untuk pengembangan. Elemen ini tidak dapat diakses oleh pengguna di luar domain tempatnya dibuat, tetapi tidak perlu disetujui sebelum penginstalan. Oleh karena itu, Google merekomendasikan penggunaan project ini untuk mengembangkan dan menguji add-on Anda di lingkungan yang terkontrol.

Anda memerlukan akses ke domain Google Workspace for Education dengan lisensi Teaching & Learning atau Plus untuk membuat project pribadi. Jika Anda belum memiliki akses ke domain tersebut, ikuti langkah-langkah berikut untuk menyiapkan domain demo Google Workspace for Education, mengupgradenya ke lisensi Plus, dan mengizinkannya untuk mengakses API add-on Classroom:

1. Selesaikan langkah-langkah untuk mendapatkan domain uji coba developer.

2. Saat login sebagai administrator di domain demo, buat project Google Cloud baru.

   Membuat project Google Cloud

   Peringatan: Pastikan project berada dalam domain demo dan Anda telah login ke konsol Google Cloud menggunakan akun administrator domain demo.

   Jika Anda tidak dapat mengakses konsol Google Cloud atau membuat project Cloud, periksa hal berikut di konsol Admin:

   • Buka halaman Setelan akun > Setelan akses berbasis usia, lalu pilih opsi untuk Semua pengguna di grup atau unit organisasi ini berusia 18 tahun ke atas.
   • Di bagian Aplikasi > Layanan Google tambahan:
   • Google Cloud Platform AKTIF untuk semua orang.
   • Setelan Pembuatan Project adalah Izinkan pengguna membuat project.
   • Setelan Akses Cloud Shell adalah Izinkan akses ke Cloud Shell.

3. Isi dan kirimkan formulir permintaan upgrade domain demo. Mengirimkan formulir ini akan meminta Google mengupgrade domain demo Anda ke Google Workspace for Education Plus dengan sepuluh lisensi dan mengizinkan project Cloud Anda masuk ke API add-on Classroom.

   Anda akan menerima email saat proses upgrade dan daftar yang diizinkan selesai. Tetapkan lisensi Plus untuk akun pengajar pengujian di konsol Admin. Pada Direktori > Pengguna, buat atau pilih akun pengajar pengujian. Di setiap Lisensi pengajar, pastikan Google Workspace for Education Plus telah Ditugaskan.

4. Aktifkan Classroom API di project Cloud Anda.

   Mengaktifkan Classroom API

5. Aktifkan Google Workspace Marketplace SDK di project Cloud Anda.

   Mengaktifkan Google Workspace Marketplace SDK

6. Tetapkan Konfigurasi Aplikasi Visibilitas Aplikasi Marketplace SDK ke pribadi.

7. Lengkapi kolom wajib diisi di halaman Listingan Play Store Marketplace SDK, lalu klik PUBLIKASIKAN. Setelah listingan aplikasi dipublikasikan, pengguna di domain dapat menemukan dan menginstal aplikasi di Google Workspace Marketplace atau dengan membuka URL Aplikasi yang ditampilkan di halaman Listingan Play Store.

Membuat project Google Cloud publik

Project ini merepresentasikan aplikasi add-on yang dapat diakses oleh administrator, pengajar, dan siswa. Project publik harus ditinjau dan disetujui oleh tim Google Workspace Marketplace sebelum dapat diluncurkan atau diinstal.

1. Buat project Google Cloud baru di domain produksi Anda.

   Membuat project Google Cloud

   Peringatan: Pastikan project berada dalam domain produksi Anda dan bahwa Anda telah login ke konsol Google Cloud sebagai pengguna domain tersebut.

2. Aktifkan Classroom API di project Cloud Anda.

   Mengaktifkan Classroom API

3. Aktifkan Google Workspace Marketplace SDK di project Cloud Anda.

   Mengaktifkan Google Workspace Marketplace SDK

4. Tetapkan Konfigurasi Aplikasi App Visibility SDK Marketplace ke Publik dan centang kotak Tidak Publik.

   Poin Penting: Anda tidak dapat membagikan atau mengonversi project pribadi yang digunakan selama pengembangan dan pengujian internal.
   Poin Penting: Aplikasi yang tidak publik tidak dapat ditemukan di Google Workspace Marketplace dengan menjelajahi atau menelusuri. Dalam konfigurasi Marketplace SDK, Anda dapat menemukan URL langsung yang dapat digunakan untuk menginstal add-on. Hanya Google dan developer yang dapat menemukan listingan Play Store. Aplikasi Anda harus tetap tidak publik sampai Anda merasa nyaman untuk merilisnya ke publik. Anda dapat beralih apakah add-on tercantum di halaman Konfigurasi Aplikasi di Marketplace SDK.

5. Lengkapi kolom wajib diisi di halaman Listingan Play Store Marketplace SDK, lalu klik PUBLIKASIKAN.

6. Aplikasi Anda akan ditinjau oleh tim Google Workspace Marketplace. Mereka akan berkomunikasi dengan Anda menggunakan alamat email developer yang ditentukan di Marketplace SDK. Setelah aplikasi disetujui, hapus centang pada kotak Tidak Publik agar pengajar dan administrator dapat menemukannya di Marketplace.

OAuth 2.0

Akses ke Classroom API memerlukan izin akses data pengguna. Akses ini diperoleh dengan meminta Google akses ke cakupan OAuth untuk pengguna yang login dan menerima token yang dapat digunakan untuk melakukan panggilan API selanjutnya ke Google Classroom. Cakupan harus dikonfigurasi di listingan Play Store Google Workspace Marketplace sehingga administrator domain dapat memberikan izin atas nama pengguna domain jika mereka menginstal add-on.

Penting: Jika add-on Anda meminta cakupan tambahan, sertakan cakupan tersebut di layar izin OAuth, tab Konfigurasi Aplikasi Marketplace SDK, dan kode aplikasi add-on Anda. Cakupan yang tidak cocok di lokasi ini dapat menyebabkan masalah bagi pengguna selama penginstalan add-on.

Lihat halaman Cakupan OAuth untuk Google API guna mengetahui daftar mendetail tentang semua cakupan yang tersedia dan penggunaannya. Lihat halaman Mengonfigurasi OAuth dalam dokumentasi Workspace untuk mengetahui informasi konfigurasi OAuth umum.

Izin pengguna

Aplikasi web Anda harus meminta setidaknya salah satu dari cakupan berikut:

• https://www.googleapis.com/auth/userinfo.email, yang memungkinkan aplikasi melihat alamat email pengguna.
• https://www.googleapis.com/auth/userinfo.profile, yang memungkinkan aplikasi melihat informasi pribadi seperti nama potret, nama depan dan terakhir, serta informasi pribadi lainnya yang disediakan pengguna untuk publik.

Setelah pengguna mengizinkan salah satu cakupan ini di add-on Anda, cakupan tersebut akan diidentifikasi oleh parameter kueri login_hint. Parameter ini diteruskan ke URL aplikasi web Anda saat iframe dibuka. Jika pengguna belum mengizinkan salah satu cakupan ini, login_hint tidak akan dikirim.

Peringatan: Aplikasi Anda harus meminta setidaknya salah satu dari cakupan userinfo.email atau userinfo.profile agar dapat menerima login_hint pada kunjungan berikutnya oleh pengguna yang sama.

login_hint adalah parameter OpenID Connect standar yang secara opsional dapat Anda teruskan ke Google saat menggunakan Login dengan Google atau meminta token OAuth. Hal ini dimaksudkan untuk membuat pengalaman otorisasi lebih lancar bagi pengguna akhir.

Cakupan add-on Classroom

Cakupan berikut khusus untuk add-on Classroom:

• https://www.googleapis.com/auth/classroom.addons.teacher, yang memungkinkan akses ke semua metode API.
• https://www.googleapis.com/auth/classroom.addons.student, yang memungkinkan akses untuk meluncurkan operasi baca lampiran dan validasi.

Meskipun memiliki token akses OAuth valid yang menunjukkan kredensial pengguna, panggilan API akan dibatasi oleh persyaratan tambahan:

• Semua metode mengharuskan pengguna menjadi pengajar atau siswa dalam kursus yang ditentukan oleh courseId dalam permintaan.
• Pembuatan, pembaruan, penghapusan, dan passback nilai lampiran mengharuskan pengguna menjadi pengajar.
• Panggilan ke postingan Google Classroom tertentu dibatasi oleh pemeriksaan berikut.
  • Jika sudah memiliki setidaknya satu lampiran pada postingan, add-on dapat membuat permintaan untuk:
    • validasi peluncuran iframe
    • Operasi baca, perbarui, dan hapus lampiran
    • Beri nilai pada postingan tersebut
  • Saat iframe Penemuan Lampiran pertama kali dibuka, add-on mungkin belum memiliki lampiran pada postingan. Tersedia parameter kueri addOnToken, yang dapat digunakan untuk membuat permintaan untuk hal berikut:
    • Membuat lampiran di bawah postingan (diperlukan addOnToken)
    • Validasi peluncuran (addOnToken divalidasi jika diberikan dan diperlukan saat add-on tidak memiliki lampiran pada postingan)

Verifikasi OAuth

Catatan: Anda tidak dapat membuat video demo untuk dikirim sebagai bagian dari proses verifikasi OAuth. Sebagai gantinya, publikasikan add-on tanpa memverifikasi OAuth. Tindakan ini akan memberi tahu tim Peninjau Google Workspace Marketplace untuk membuat video demo atas nama Anda. Selanjutnya, tim peninjau akan memberikan video tersebut agar Anda dapat menyertakannya dalam pengiriman verifikasi OAuth.

Add-on Classroom menggunakan Google API untuk mengakses data pengguna Google.

• Verifikasi identitas merek Anda.
• Verifikasi cakupan OAuth sensitif.

Lihat FAQ verifikasi OAuth API untuk mengetahui informasi lebih lanjut tentang proses verifikasi.

Listingan Google Workspace Marketplace

Peringatan: Setelah opsi visibilitas disimpan selama proses publikasi, Anda tidak dapat mengubah pilihan nanti.

Untuk informasi konfigurasi Google Workspace Marketplace SDK umum, buka Mengaktifkan dan mengonfigurasi Google Workspace Marketplace SDK dan Membuat listingan Play Store Google Workspace Marketplace.

Pertimbangan listingan

Listingan Toko Marketplace SDK publik Anda menentukan nama dan deskripsi aplikasi yang ditujukan bagi pengguna akhir. Anda dapat memberikan detail ini dalam beberapa bahasa di bagian Detail Aplikasi.

Ikuti panduan berikut di listingan Anda:

• Di bagian Detail Aplikasi:

  • Hindari tanda baca dalam Application Name. Misalnya, gunakan "Add-on Saya oleh Perusahaan Saya" bukan "Perusahaan Saya: Add-on Saya" atau "Add-on Saya, oleh Perusahaan Saya".

  • Deskripsi Singkat dan Deskripsi Mendetail tidak boleh berisi teks yang sama persis.

  + Pastikan Anda telah memilih nilai untuk kolom Pricing. Kolom ini mencakup opsi Gratis, Dibayar dengan uji coba gratis, Dibayar dengan fitur gratis, dan harga Berbayar. Anda tidak perlu menentukan jumlah biaya di listingan Marketplace.

  • Pastikan Anda telah memilih nilai untuk kolom Category. Academic Resources atau Teacher and Admin Tools dapat menjadi pilihan tepat untuk add-on Classroom.

  • Lihat item yang tercantum dalam Deskripsi detail aplikasi Marketplace untuk mengetahui informasi selengkapnya.

Penting: Periksa Detail Aplikasi untuk setiap bahasa yang Anda tawarkan dalam add-on.

• Di bagian Aset Grafik:

  • Semua aset visual yang disediakan tidak membingungkan dan memenuhi ukuran yang ditentukan dalam standar Google Workspace Marketplace

  • Screenshot yang diberikan adalah representasi akurat dari pengalaman add-on Anda.

• Di bagian Link Dukungan:

  • Pastikan Anda telah memberikan link ke Persyaratan Layanan aplikasi Anda.

• Pastikan Anda memenuhi Pedoman Branding Google API, yang mencakup nama dan deskripsi yang diizinkan.

• Jika Anda merujuk ke produk Google apa pun dalam listingan Anda, gunakan namanya dalam format yang disediakan dalam Daftar Merek Dagang. Pastikan Anda menyertakan simbol merek dagang (TM) jika ditentukan; gunakan "Google DokumenTM", bukan "Google Dokumen".

Melakukan integrasi dengan layanan penagihan dan pemberian lisensi Google

Jika Anda tertarik untuk mengintegrasikan aplikasi Google Workspace Marketplace dengan layanan pemberian lisensi dan penagihan Google, kunjungi Marketplace API.

Setelan penginstalan

Add-on dapat mengizinkan penginstalan individual selain penginstalan administrator. Halaman ini menyoroti beberapa perbedaan antara kedua jenis penginstalan. Halaman ini tidak dimaksudkan untuk mempromosikan kedua jenis penginstalan. Anda dapat memilih apakah akan mengizinkan penginstalan individual di halaman Konfigurasi Aplikasi Google Workspace Marketplace SDK.

Penginstalan administrator

Penginstalan administrator memungkinkan administrator menambahkan add-on ke semua akun di domain atau ke grup akses atau unit organisasi tertentu. Hanya administrator domain yang dapat melakukan penginstalan administrator. Secara opsional, administrator dapat mengizinkan semua cakupan akses atas nama semua pengguna di domain tersebut; pengguna tidak diminta untuk menyetujui cakupan akses apa pun jika administrator memilih untuk melakukannya.

Berikut adalah beberapa pertimbangan terkait penginstalan administrator.

• Kontrol yang lebih ketat. Administrator dapat membatasi pengguna yang dapat mengakses add-on.
• Kompatibilitas dengan pemberian lisensi. Jika aplikasi Anda memerlukan lisensi, penginstalan penyaluran melalui administrator dapat membantu memastikan bahwa lisensi didistribusikan dan digunakan dengan tepat bersama institusi terkait.
• Mengurangi beban bagi pengguna akhir. Penginstalan oleh administrator akan mengurangi beban penyiapan untuk pengajar dan siswa. Hal ini dapat menghasilkan pengalaman pengguna yang lebih lancar dengan lebih sedikit klik dan lebih sedikit peluang kebingungan.

Lihat artikel Menginstal aplikasi Marketplace di domain Anda untuk mengetahui informasi selengkapnya tentang cara melakukan penginstalan administrator dan Cara kerja struktur organisasi untuk mempelajari unit organisasi dan grup akses lebih lanjut.

Penginstalan individual

Penginstalan individual akan menambahkan add-on ke akun pengguna. Pengguna akan diminta untuk mengizinkan cakupan akses add-on selama penginstalan.

Berikut adalah beberapa pertimbangan terkait penginstalan individual.

• Memfasilitasi adopsi. Lebih banyak pengguna dapat melihat dan menginstal add-on Anda dari Google Workspace Marketplace. Mengizinkan penginstalan satu per satu dapat mendorong lebih banyak pengajar untuk mengadopsi atau mendukung produk Anda.
• Pengujian administrator. Administrator dapat menginstal add-on secara terpisah untuk menguji atau mengevaluasinya sebelum menyetujui atau menginstalnya untuk grup yang lebih luas.

Selain menginstal add-on atas nama pengguna, administrator juga dapat mengelola daftar yang diizinkan untuk mengizinkan pengguna menginstal add-on yang mengizinkan penginstalan individual. Jika add-on tidak ada dalam daftar yang diizinkan, pengguna tetap dapat melihat listingan add-on tersebut di Google Workspace Marketplace, tetapi tidak dapat menginstal add-on tersebut; mereka akan melihat pesan yang menjelaskan bahwa add-on tersebut belum diizinkan untuk diinstal oleh administrator domain. Lihat Mengelola aplikasi Google Workspace Marketplace dalam daftar yang Anda izinkan untuk mempelajari perilaku ini lebih lanjut.

Lihat dokumentasi setelan penginstalan Google Workspace Marketplace untuk mengetahui informasi selengkapnya.

Integrasi Apl

Anda harus memberikan URL iframe peluncuran di kolom URI Penyiapan Lampiran. URL ini digunakan sebagai nilai src iframe untuk iframe Lampiran Penemuan. iframe Penemuan Lampiran digunakan oleh pengajar untuk menemukan konten atau aktivitas untuk dilampirkan ke tugas mereka.

Anda juga harus menentukan semua awalan URI tempat lampiran diizinkan dari add-on Anda. Fitur ini meningkatkan keamanan dengan mencegah lampiran dari sumber yang tidak sah.

Lihat halaman panduan iframe untuk detail selengkapnya terkait kolom ini.

Akun pengujian

Buat akun pengujian di domain demo untuk memverifikasi perilaku add-on pribadi yang benar. Dua akun siswa diperlukan untuk menguji peralihan antar siswa dalam iframe Ulasan Tugas Siswa.

Akun pengujian yang disarankan:

• Tammy Teacher, tammy.teacher@<your demo domain>
• Sam Student, sam.student@<domain demo Anda>
• Sally Student, sally.student@<domain demo Anda>

Ikuti prosedur ini untuk membuat akun pengujian baru:

1. Login ke konsol Admin.
2. Buka Pengguna.
3. Klik Add new user (lihat Gambar 1).
4. Masukkan informasi pengguna dan tetapkan peran yang sesuai.

Gambar 1. Lokasi link Add new user dalam konsol Admin.

Ikuti prosedur ini untuk membuat grup pengujian baru:

1. Login ke konsol Admin.
2. Buka Grup.
3. Klik Buat grup (lihat Gambar 2).
4. Masukkan anggota dan pemilik grup.

Gambar 2. Lokasi link Buat grup di konsol Admin.