Konfigurasi project Google Cloud

Halaman ini berisi informasi yang perlu Anda ketahui tentang cara 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), untuk mengizinkan permintaan yang dibuat oleh add-on Anda, dan untuk mengelola listingan add-on Anda di Google Workspace Marketplace Anda.

Untuk informasi umum selengkapnya tentang publikasi add-on ke 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. "Publik" dan "pribadi" label mengacu pada visibilitas aplikasi di Google Workspace Marketplace; Marketplace pribadi aplikasi hanya dapat diinstal oleh pengguna di dalam domain tempat aplikasi itu dibuat, sedangkan aplikasi Marketplace publik tersedia untuk semua domain Google Workspace. Ini harus merupakan dua hal terpisah sebagai proyek tidak bisa bersifat publik dan pribadi. Aplikasi publik harus ditinjau dan disetujui sebelum tersedia di marketplace.

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

Membuat project Google Cloud publik

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

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

    Membuat project Google Cloud

  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. Menetapkan Marketplace SDK Konfigurasi Aplikasi Visibilitas Aplikasi ke Publik, lalu centang kotak Tidak Publik.

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

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

Membuat project Google Cloud pribadi

Project pribadi ini mewakili aplikasi add-on yang digunakan untuk pengembangan. File itu tidak dapat diakses oleh pengguna di luar domain tempatnya dibuat, tetapi tidak perlu disetujui sebelum instalasi. Oleh karena itu, Google merekomendasikan menggunakan proyek ini untuk mengembangkan dan menguji {i>add-on<i} Anda dalam lingkungan yang terkendali.

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

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

  2. Saat masuk sebagai administrator di domain demo, buat project Google Cloud Anda.

    Membuat project Google Cloud

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

    • Buka Setelan akun > halaman setelan akses berbasis usia dan pilih opsi untuk Semua pengguna di grup atau unit organisasi ini berusia 18 tahun atau versi lama.
    • 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 ini formulir permintaan agar Google mengupgrade domain demo Anda ke Google Workspace for Education Plus dengan sepuluh 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. Di Bawah Direktori > Pengguna, buat atau pilih akun pengajar pengujian Anda. Dalam setiap Lisensi pengajar, pastikan bahwa 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. Menetapkan Marketplace SDK Konfigurasi Aplikasi Visibilitas Aplikasi ke pribadi.

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

OAuth 2.0

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

Lihat halaman Cakupan OAuth untuk Google API guna mengetahui daftar mendetail tentang semua cakupan dan kegunaannya. Lihat Mengonfigurasi halaman OAuth di dokumentasi Workspace untuk 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 untuk melihat alamat email pengguna.
  • https://www.googleapis.com/auth/userinfo.profile, yang memungkinkan aplikasi untuk melihat informasi pribadi seperti potret, pertama dan terakhir nama, dan informasi pribadi lainnya yang telah dibuat oleh pengguna secara publik yang tersedia.

Setelah pengguna mengizinkan salah satu cakupan ini di add-on Anda, yang diidentifikasi dengan parameter kueri login_hint. Parameter ini diteruskan ke setiap URL aplikasi web Anda ketika iframe terbuka. Jika pengguna belum memberikan otorisasi dari cakupan ini, login_hint tidak akan dikirim.

login_hint adalah parameter OpenID Connect standar yang secara opsional dapat Anda yang diteruskan ke Google saat menggunakan Login dengan Google atau meminta token OAuth. Ini dimaksudkan untuk membuat pengalaman otorisasi yang 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.

Bahkan dengan token akses OAuth yang valid yang menunjukkan kredensial pengguna, panggilan API dibatasi oleh persyaratan tambahan:

  • Semua metode mengharuskan pengguna untuk menjadi pengajar atau siswa dalam kursus yang ditentukan oleh courseId dalam permintaan.
  • Pembuatan, pembaruan, penghapusan, dan passback nilai lampiran memerlukan pengguna menjadi seorang guru.
  • Panggilan ke postingan Google Classroom tertentu dibatasi oleh hal berikut pemeriksaan.
    • 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. 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 jika add-on tidak memiliki lampiran pada postingan)

Verifikasi OAuth

Add-on Classroom menggunakan Google API untuk mengakses layanan otomatis dan data skalabel.

Lihat FAQ verifikasi OAuth API untuk informasi selengkapnya tentang proses verifikasi Anda.

Listingan Google Workspace Marketplace

Untuk mengetahui 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

Marketplace SDK Store Marketplace proyek Google Cloud publik Anda Listingan menentukan nama aplikasi dan deskripsi yang 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".

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

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

    • Pastikan Anda telah memilih nilai untuk kolom Category. Referensi Akademik atau Alat Pengajar dan Admin mungkin merupakan pilihan yang tepat untuk add-on Classroom.

    • Lihat item yang tercantum dalam Aplikasi Marketplace deskripsi detail untuk mengetahui informasi lebih lanjut.

  • Di bagian Aset Visual:

  • Di bagian Link Dukungan:

    • Pastikan Anda telah memberikan tautan ke Persyaratan Layanan.

  • 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 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 mengizinkan aplikasi Google Workspace Marketplace berintegrasi dengan layanan pemberian lisensi dan penagihan Google kunjungi API Marketplace.

Setelan penginstalan

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

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 dapat melakukan instalasi administrator. Tujuan administrator dapat secara opsional 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 mana yang dapat mengakses {i>add-on<i}.
  • Kompatibilitas dengan pemberian lisensi. Jika aplikasi Anda membutuhkan lisensi, menyalurkan instalasi melalui administrator dapat membantu memastikan bahwa lisensi didistribusikan dan digunakan dengan tepat bersama dengan di institusi pendidikan.
  • Mengurangi beban bagi pengguna akhir. Penginstalan oleh administrator mengurangi rangkaian bagi guru dan siswa. Hal ini dapat menghasilkan pengalaman pengguna yang lebih lancar dengan lebih sedikit klik dan lebih sedikit kesempatan untuk kebingungan.

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

Penginstalan individual

Penginstalan individual akan menambahkan add-on ke akun pengguna. Pengguna diminta untuk menyetujui 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 individual mungkin akan meminta lebih banyak guru untuk diadopsi atau didukung untuk produk Anda.
  • Pengujian administrator. Administrator dapat menginstal satu per satu add-on ini untuk menguji atau mengevaluasinya sebelum menyetujui atau menginstalnya untuk kelompok yang lebih luas.

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

Lihat dokumentasi setelan penginstalan Google Workspace Marketplace untuk informasi selengkapnya.

Integrasi Apl

Anda harus memberikan URL iframe peluncuran di kolom URI Penyiapan Lampiran. Ini URL digunakan sebagai nilai src iframe untuk iframe Lampiran Penemuan. Tujuan iframe Penemuan Lampiran digunakan 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 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 pengguna yang benar add-on pribadi. Dua akun siswa diperlukan untuk menguji peralihan antara siswa dalam iframe Ulasan Tugas Siswa.

Akun pengujian yang disarankan:

  • Tammy Teacher, tammy.lecture@<domain demo Anda>
  • 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.

Klik Tambahkan pengguna baru Gambar 1. Lokasi link Tambahkan pengguna baru 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.

Klik Buat grup Gambar 2. Lokasi link Buat grup di dalam Konsol Admin.