Mengonfigurasi integrasi UI Drive

Untuk menampilkan aplikasi Anda di Google Drive saat pengguna membuat atau membuka file, Anda harus menyiapkan integrasi antarmuka (UI) pengguna Drive terlebih dahulu. Konfigurasi juga diperlukan untuk mencantumkan aplikasi Anda di Google Workspace Marketplace.

Aktifkan Drive API

Sebelum menggunakan Google API, Anda harus mengaktifkannya di project Google Cloud. Anda dapat mengaktifkan satu atau beberapa API dalam satu project Google Cloud.

Untuk mulai melakukan integrasi dengan UI Google Drive, Anda harus mengaktifkan Drive API. Hal ini memberi Anda akses ke API dan fitur integrasi UI.

• Di Konsol Google Cloud, aktifkan Google Drive API.

  Mengaktifkan API

Menyiapkan integrasi UI Drive

1. Di Konsol API Google, buka Menu > APIs & Services > Enabled APIs & services.

   Buka API & layanan yang diaktifkan

2. Di bagian bawah dasbor API & Layanan, klik Google Drive API. Halaman konfigurasi Google Drive API akan muncul.
3. Pilih tab Integrasi UI Drive.
4. (Opsional) Masukkan nama di kolom Nama aplikasi. Nama aplikasi ditampilkan kepada pengguna di tab Kelola Aplikasi di setelan Drive.
5. (Opsional) Masukkan deskripsi singkat satu baris di kolom Deskripsi singkat. Deskripsi singkat ditampilkan kepada pengguna di tab Kelola Aplikasi di setelan Drive.
6. (Opsional) Masukkan deskripsi lengkap di kolom Deskripsi panjang.

7. Upload satu atau beberapa Ikon aplikasi untuk ditampilkan dalam daftar aplikasi Drive yang terhubung milik pengguna dan di menu konteks "Buka dengan". Ikon harus dalam format PNG dengan latar belakang transparan. Ikon dapat memerlukan waktu hingga 24 jam untuk muncul di Drive.

   Catatan: Ikon dokumen tidak digunakan lagi. Ikon aplikasi Anda muncul di samping file pintasan dan pintasan pihak ketiga. Serangkaian ikon standar digunakan untuk jenis file lainnya.

8. Untuk menggunakan item menu "Buka dengan" UI Drive, masukkan URL ke aplikasi Anda di kolom Buka URL. URL ini digunakan oleh menu konteks "Buka Dengan".

   • URL ini harus berisi nama domain yang sepenuhnya memenuhi syarat; localhost tidak berfungsi.
   • URL ini harus dapat diakses oleh pengguna yang dituju dari aplikasi Anda. Jika Anda memiliki beberapa versi aplikasi, seperti satu untuk rilis publik dan satu untuk rilis terbatas kepada pengguna tertentu, setiap versi harus menggunakan URL yang unik. Kemudian, Anda dapat membuat konfigurasi aplikasi yang berbeda untuk setiap versi.
   • Anda harus memverifikasi kepemilikan URL ini sebelum dapat mencantumkan aplikasi Anda di Google Workspace Marketplace.
   • Secara default, parameter kueri state ditambahkan ke URL ini untuk meneruskan data dari UI Drive ke aplikasi Anda. Untuk mengetahui informasi tentang konten parameter state, lihat Parameter state.
   Peringatan: Opsi untuk menampilkan layar izin OAuth 2.0 secara otomatis tidak digunakan lagi. Jangan centang kotak ini. Aplikasi harus memulai semua permintaan otorisasi.

9. (Opsional) Masukkan jenis MIME dan ekstensi file default di kolom Jenis MIME default dan Ekstensi file default. Jenis MIME dan ekstensi file default merepresentasikan file yang dibuat secara unik untuk dibuka oleh aplikasi Anda. Misalnya, aplikasi Anda dapat membuka format bawaan untuk menyusun dan mengedit gambar. Hanya sertakan jenis media standar dan pastikan tidak ada kesalahan ketik dan salah ejaan. Jika aplikasi Anda hanya membuka file pintasan atau pintasan pihak ketiga, Anda dapat mengosongkan jenis MIME.

10. (Opsional) Masukkan jenis MIME sekunder dan ekstensi file di kolom Jenis MIME sekunder dan Ekstensi file sekunder. Jenis MIME sekunder dan ekstensi file merepresentasikan file yang dapat dibuka aplikasi Anda, tetapi tidak spesifik untuk aplikasi Anda. Misalnya, aplikasi Anda mungkin berupa aplikasi pengeditan gambar yang membuka gambar PNG dan JPG. Hanya sertakan jenis media standar dan pastikan tidak ada kesalahan ketik dan salah ejaan. Jika aplikasi Anda hanya membuka file pintasan atau pintasan pihak ketiga, Anda dapat mengosongkan jenis MIME.

    Catatan: Jika pengguna menginstal beberapa aplikasi Drive yang dapat membuka file, aplikasi yang terakhir diinstal akan digunakan hingga pengguna memilih aplikasi lain.

11. Untuk menggunakan tombol "Baru" UI Drive dan meminta pengguna membuat file dengan aplikasi Anda, centang kotak Membuat file. Kolom URL Baru dan kolom Nama dokumen opsional akan muncul.

    • URL ini harus berisi nama domain yang sepenuhnya memenuhi syarat; localhost tidak berfungsi.
    • Anda harus memverifikasi kepemilikan URL ini sebelum dapat mencantumkan aplikasi Anda di Google Workspace Marketplace.
    • Secara default, parameter kueri state ditambahkan ke URL ini untuk meneruskan data dari UI Drive ke aplikasi Anda. Untuk mengetahui informasi tentang konten parameter state, lihat Parameter state.

12. Masukkan URL di kolom URL Baru. URL ini digunakan oleh tombol "Baru" untuk mengalihkan pengguna ke aplikasi Anda.

    Catatan: Biarkan kolom Nama dokumen kosong. Kolom ini tidak digunakan lagi.

13. (Opsional) Jika Anda ingin aplikasi Anda membuka file yang didukung Google Workspace, centang kotak Mengimpor.

14. (Opsional) Jika aplikasi Anda harus mengelola file di drive bersama, centang kotak Dukungan drive bersama. Untuk mengetahui informasi lebih lanjut tentang cara mendukung drive bersama di aplikasi Anda, lihat Menerapkan dukungan drive bersama.

15. Klik Kirim.

Meminta cakupan drive.install

Untuk mengizinkan aplikasi muncul sebagai opsi di menu "Buka dengan" atau "Baru", minta cakupan https://www.googleapis.com/auth/drive.install untuk berintegrasi dengan UI Drive. Saat meminta cakupan ini, pengguna akan menerima dialog yang mirip dengan ini:

Gambar 1. Dialog penginstalan saat menggunakan cakupan untuk UI Drive.

Untuk mengetahui informasi selengkapnya tentang cakupan yang dapat Anda minta untuk aplikasi Drive, dan cara memintanya, lihat Informasi otorisasi dan autentikasi khusus API.

Catatan: Jika Anda memublikasikan aplikasi Drive ke Google Workspace Marketplace, pengguna dan administrator domain dapat menelusuri dan menginstal aplikasi langsung dari Google Workspace Marketplace.

Parameter state

Secara default, parameter state ditambahkan ke URL Buka dan URL Baru untuk meneruskan data dari UI Drive ke aplikasi Anda. Parameter ini berisi string yang dienkode JSON dengan variabel template dan data tentang permintaan ke aplikasi Anda. Variabel yang disertakan bergantung pada jenis URL yang digunakan (URL Buka atau URL Baru):

Variabel template	Deskripsi	Penerapan URL
{ids}	Daftar ID file yang dipisahkan koma yang sedang dibuka.	Buka URL
{exportIds}	Daftar ID file yang dipisahkan koma yang diekspor (hanya digunakan saat membuka dokumen Google bawaan).	Buka URL
{resourceKeys}	Kamus JSON ID file yang dipetakan ke kunci masing-masing resource.	Buka URL
{folderId}	ID folder induk.	URL baru
{folderResourceKey}	Kunci resource folder induk.	URL baru
{userId}	ID profil yang mengidentifikasi pengguna.	Buka URL dan URL Baru
{action}	Tindakan yang sedang dilakukan. Nilainya adalah open saat menggunakan Buka URL atau create saat menggunakan URL Baru.	Buka URL dan URL Baru

Parameter state dienkode URL, sehingga aplikasi Anda harus menangani karakter escape dan menguraikannya sebagai JSON. Aplikasi dapat mendeteksi nilai create dalam parameter state untuk memverifikasi permintaan pembuatan file.

Contoh informasi status dalam JSON untuk URL Baru

Informasi state untuk URL Baru adalah:

{
  "action":"create",
  "folderId":"FOLDER_ID",
  "folderResourceKey":"FOLDER_RESOURCE_KEY",
  "userId":"USER_ID"
}

Contoh informasi status dalam JSON untuk Open URL

Informasi state untuk Buka URL adalah:

{
  "ids": ["ID"],
  "resourceKeys":{"RESOURCE_KEYS":"RESOURCE_KEYS"},
  "action":"open",
  "userId":"USER_ID"
}

ID dan kunci resource digunakan untuk mengambil metadata file dan mendownload konten file. Setelah aplikasi Anda memiliki ID file dan token akses, aplikasi dapat memeriksa izin, mengambil metadata file, dan mendownload konten file seperti yang dijelaskan dalam metode files.get.

Catatan: Semua aplikasi, termasuk aplikasi yang membuka file dari pintasan dan pintasan pihak ketiga, harus memanggil metode files.get untuk memeriksa izin pengguna atas dokumen. Aplikasi harus memperingatkan pengguna hanya baca saat mereka membuka file yang tidak dapat diedit atau disimpan (daripada membiarkan mereka menghabiskan waktu untuk mengedit, lalu menampilkan error saat menyimpan).

Topik terkait

Aplikasi yang diinstal harus dapat membuat, mengelola, dan membuka tindakan yang diluncurkan dari UI Drive. Untuk mempelajari lebih lanjut, lihat Mengintegrasikan dengan tombol "Baru" UI Drive atau Mengintegrasikan dengan menu konteks "Buka dengan" UI Drive.