Mengonfigurasi integrasi UI Drive

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

  1. Login ke Konsol API Google.
  2. Di bagian atas halaman, di samping logo Google API, pilih project aplikasi Anda. Dasbor APIs & amp; Services akan muncul.
  3. Di bagian bawah dasbor API & amp; Layanan, klik Google Drive API. Jika tidak melihat opsi ini, Anda harus mengaktifkan Google Drive API.
  4. Klik tab Integrasi UI Drive. Halaman konfigurasi akan muncul.
  5. Masukkan nama aplikasi di kolom Application Name. Nama aplikasi ditampilkan kepada pengguna di tab Kelola Aplikasi di setelan Drive.
  6. Masukkan deskripsi singkat di kolom Deskripsi Singkat. Deskripsi singkat ditampilkan kepada pengguna di tab Kelola Aplikasi di setelan Drive.
  7. (opsional) Masukkan deskripsi panjang di kolom Deskripsi Panjang.
  8. Upload satu atau beberapa ikon untuk ditampilkan dalam daftar aplikasi Drive yang terhubung milik pengguna dan di item menu konteks "Buka dengan". Ikon harus dalam format PNG dengan latar belakang transparan. Ikon memerlukan waktu hingga 24 jam untuk ditampilkan di Drive.

  9. Jika Anda ingin pengguna menggunakan item menu konteks "Buka dengan" di UI Drive, masukkan URL ke aplikasi Anda di kolom Open URL. URL ini digunakan oleh item menu konteks "Open With".

    • URL ini harus berisi nama domain yang sepenuhnya memenuhi syarat; localhost tidak berfungsi.
    • Anda harus memverifikasi kepemilikan URL ini sebelum dapat membuat daftar aplikasi 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.
  10. Masukkan jenis mime default dan ekstensi file di kolom Default Mime Types dan Default File Extensions. Jenis mime default dan ekstensi file mewakili file yang dibuat secara unik untuk dibuka oleh aplikasi Anda. Misalnya, aplikasi Anda mungkin membuka format bawaan untuk melapisi dan mengedit gambar. Hanya sertakan jenis media standar dan pastikan tidak ada kesalahan ketik atau kesalahan ejaan. Jika aplikasi Anda hanya membuka pintasan atau file pintasan pihak ketiga, Anda dapat mengosongkan jenis MIME.

  11. Masukkan ekstensi mime sekunder dan ekstensi file di kolom Secondary Mime Types dan Secondary File Extensions. Jenis mime sekunder dan ekstensi file mewakili file yang dapat dibuka oleh aplikasi Anda, tetapi tidak khusus untuk aplikasi Anda. Misalnya, aplikasi mungkin adalah aplikasi pengeditan gambar yang membuka gambar png dan jpg. Hanya sertakan jenis media standar dan pastikan tidak ada kesalahan ketik atau kesalahan ejaan. Jika aplikasi Anda hanya membuka pintasan atau file pintasan pihak ketiga, Anda dapat mengosongkan jenis MIME.

  12. Jika Anda ingin pengguna mengklik tombol Baru UI Drive dan membuat file dengan aplikasi, centang Membuat file. Kolom URL Baru dan 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 membuat daftar aplikasi 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.
  13. Masukkan URL di kolom URL baru. URL ini digunakan oleh tombol "Baru" untuk mengalihkan pengguna ke aplikasi Anda.

  14. (Opsional) Jika Anda ingin aplikasi Anda dapat membuka file yang didukungGoogle Workspace, centang Mengimpor.

  15. (Opsional) Jika aplikasi Anda perlu memanipulasi file di drive bersama, lihat Dukungan drive bersama. Untuk mengetahui informasi selengkapnya tentang cara mendukung drive bersama di aplikasi, lihat Mengimplementasikan dukungan drive bersama

  16. Klik Kirim.

Meminta cakupan drive.install

Meminta cakupan https://www.googleapis.com/auth/drive.install untuk diintegrasikan dengan UI Drive. Saat meminta cakupan ini, pengguna akan menerima dialog yang mirip dengan ini:

Dialog penginstalan

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

Parameter state

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

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

Parameter state dienkode URL, sehingga aplikasi Anda harus menangani karakter escape dan mengurainya sebagai JSON. Aplikasi dapat mendeteksi nilai create dalam parameter state untuk memverifikasi bahwa ini adalah permintaan untuk membuat file.

Contoh informasi status dalam JSON untuk URL Baru

Informasi state untuk URL Baru adalah:

{
  "action":"create",
  "folderId":"0ADK06pfg",
  "folderResourceKey":"kahDue92has-1",
  "userId":"103354693083460731603"
}

Contoh informasi status dalam JSON untuk URL Terbuka

Informasi state untuk URL Terbuka adalah:

{
  "ids": ["0Bz0bd"],
  "resourceKeys":{"0Bz0bd":"AAshj23Ad1"},
  "action":"open",
  "userId":"103354693083460731603"
}

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 dokumentasi referensi untuk files.get.

Langkah berikutnya

Aplikasi terinstal harus dapat mengelola tindakan buat dan buka yang diluncurkan dari UI Drive. Untuk mempelajari lebih lanjut, lihat Menangani URL Baru atau Menangani URL Terbuka.