Mengonfigurasi integrasi UI Drive

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

Mengaktifkan 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 berintegrasi dengan UI Google Drive, Anda harus mengaktifkan Drive API. Hal ini memberi Anda akses ke API dan fitur integrasi UI.

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 APIs & Services, 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 pengguna aplikasi Drive yang terhubung 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.

  8. Untuk menggunakan item menu "Open with" pada UI Drive, masukkan URL ke aplikasi Anda di kolom Open 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 aplikasi yang dimaksud. Jika Anda memiliki beberapa versi aplikasi, seperti satu untuk rilis publik dan satu untuk rilis terbatas untuk pengguna tertentu, setiap versi harus menggunakan URL unik. Selanjutnya, 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.
  9. (Opsional) Masukkan jenis MIME dan ekstensi file default di kolom Jenis MIME default dan Ekstensi file default. Jenis MIME default dan ekstensi file mewakili file yang dibuat secara unik oleh aplikasi Anda untuk dibuka. Misalnya, aplikasi Anda mungkin membuka format bawaan untuk melapisi dan mengedit gambar. Hanya sertakan jenis media standar dan pastikan tidak ada salah 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 dan ekstensi file sekunder mewakili file yang dapat dibuka oleh 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 salah ketik dan salah ejaan. Jika aplikasi Anda hanya membuka file pintasan atau pintasan pihak ketiga, Anda dapat mengosongkan jenis MIME.

  11. Untuk menggunakan tombol "Baru" di UI Drive dan meminta pengguna membuat file dengan aplikasi Anda, centang kotak Membuat file. Kolom New URL dan Document name 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 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.

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

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

  15. Klik Submit.

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 diintegrasikan dengan UI Drive. Saat meminta cakupan ini, pengguna akan menerima dialog yang mirip dengan ini:

Dialog penginstalan UI Google Drive.
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.

Parameter state

Secara default, parameter state ditambahkan ke Open URL 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 (Open URL atau URL Baru):

Variabel template Deskripsi Aplikasi URL
{ids} Daftar ID file yang dipisahkan koma yang dibuka. Buka URL
{exportIds} Daftar yang dipisahkan koma berisi ID file yang diekspor (hanya digunakan saat membuka dokumen bawaan Google). Buka URL
{resourceKeys} Kamus JSON ID file yang dipetakan ke kunci resource masing-masing. 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 dilakukan. Nilainya adalah open jika menggunakan Open URL atau create jika menggunakan URL Baru. Buka URL dan URL Baru

Parameter state dienkode ke URL, sehingga aplikasi Anda harus menangani karakter escape dan mengurainya sebagai JSON. Aplikasi dapat mendeteksi nilai create dalam parameter state untuk memverifikasi permintaan dalam membuat 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 Open 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 memiliki ID file dan token akses, aplikasi Anda dapat memeriksa izin, mengambil metadata file, dan mendownload konten file seperti yang dijelaskan dalam metode files.get.

Aplikasi terinstal 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.