Untuk menampilkan aplikasi 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 Google Cloud proyek. Anda dapat mengaktifkan satu atau beberapa API di satu paket Google Cloud proyek.
Untuk mulai berintegrasi dengan UI Google Drive, Anda harus mengaktifkan API Drive. Hal ini memberi Anda akses ke integrasi API dan UI baru.
Di konsol Google Cloud, aktifkan Google Drive API.
Menyiapkan integrasi UI Drive
- Di Konsol API Google, buka Menu > API & Layanan > API yang diaktifkan & Google Cloud Platform.
- Di bagian bawah API & Dasbor layanan, klik Google Drive API. Tujuan Halaman konfigurasi Google Drive API akan muncul.
- Pilih tab Integrasi UI Drive.
- (Opsional) Masukkan nama di kolom Nama aplikasi. Aplikasi nama ditampilkan kepada pengguna di tab Kelola Aplikasi di Drive setelan.
- (Opsional) Masukkan deskripsi singkat satu baris di Deskripsi singkat kolom tersebut. Deskripsi singkat ditampilkan kepada pengguna di tab Kelola Aplikasi di Setelan Drive.
- (Opsional) Masukkan deskripsi lengkap di kolom Deskripsi panjang.
Unggah satu atau beberapa Ikon aplikasi untuk ditampilkan dalam daftar pengguna aplikasi Drive yang terhubung dan di opsi "Buka dengan" menu konteks. Ikon harus dalam format PNG dengan latar belakang transparan. Ikon dapat mengambil waktu hingga 24 jam untuk muncul di Drive.
Untuk menggunakan "Buka dengan" UI Drive menu item, masukkan URL ke aplikasi Anda di Kolom Buka URL. URL ini digunakan oleh "Open With" menu konteks.
- URL ini harus berisi nama domain yang sepenuhnya memenuhi syarat;
localhosttidak Anda. - URL ini harus dapat diakses oleh pengguna aplikasi yang dituju. Jika Anda memiliki beberapa versi aplikasi, seperti versi untuk publik dan satu lagi untuk rilis terbatas bagi pengguna tertentu, masing-masing versi harus menggunakan URL yang unik. Kemudian, Anda dapat membuat aplikasi lain untuk setiap versi.
- Anda harus verifikasi kepemilikan URL ini sebelum Anda dapat mencantumkan aplikasi di Google Workspace Marketplace.
- Secara default, parameter kueri
stateditambahkan ke URL ini untuk meneruskan dari UI Drive ke aplikasi Anda. Untuk mengetahui informasi tentang isi parameterstate, lihat Thestateparameter.
- URL ini harus berisi nama domain yang sepenuhnya memenuhi syarat;
(Opsional) Masukkan jenis MIME dan ekstensi file default di bagian Kolom Jenis MIME default dan Ekstensi file default. MIME default jenis dan ekstensi file mewakili file yang dibuat oleh aplikasi Anda secara unik terbuka. Misalnya, aplikasi Anda mungkin membuka format bawaan untuk {i>layering<i} dan mengedit gambar. Hanya sertakan media standar jenis dan memastikan bahwa mereka bebas dari salah ketik dan salah eja. Jika aplikasi Anda hanya terbuka atau file pintasan pihak ketiga, Anda dapat mengosongkan jenis MIME.
(Opsional) Masukkan jenis MIME sekunder dan ekstensi file di bagian Sekunder Jenis MIME dan kolom Ekstensi file sekunder. Jenis MIME sekunder dan ekstensi file mewakili file yang dapat dibuka aplikasi Anda, tetapi tidak spesifik ke aplikasi Anda. Misalnya, aplikasi Anda mungkin adalah aplikasi pengeditan gambar yang membuka Gambar PNG dan JPG. Hanya sertakan media standar jenis dan memastikan bahwa mereka bebas dari salah ketik dan salah eja. Jika aplikasi Anda hanya terbuka atau file pintasan pihak ketiga, Anda dapat mengosongkan jenis MIME.
Untuk menggunakan "Baru" UI Drive dan meminta pengguna membuat file dengan aplikasi Anda, centang kotak Membuat file. New URL dan atribut opsional Kolom Nama dokumen akan muncul.
- URL ini harus berisi nama domain yang sepenuhnya memenuhi syarat;
localhosttidak Anda. - Anda harus memverifikasi kepemilikan URL sebelum Anda dapat mencantumkan aplikasi di Google Workspace Marketplace.
- Secara default, parameter kueri
stateditambahkan ke URL ini untuk meneruskan dari UI Drive ke aplikasi Anda. Untuk mengetahui informasi tentang isi parameterstate, lihat Thestateparameter.
- URL ini harus berisi nama domain yang sepenuhnya memenuhi syarat;
Masukkan URL di kolom URL baru. URL ini digunakan oleh "Baru" tombol untuk mengalihkan pengguna ke aplikasi Anda.
(Opsional) Jika Anda ingin aplikasi membuka file yang didukung Google Workspace, centang kotak Mengimpor.
(Opsional) Jika aplikasi Anda harus mengelola file di drive bersama, centang Kotak Dukungan drive bersama. Untuk informasi lebih lanjut tentang cara mendukung drive bersama di aplikasi Anda, lihat Menerapkan drive bersama dukungan.
Klik Kirim.
Meminta cakupan drive.install
Untuk mengizinkan aplikasi muncul sebagai opsi di menu "Buka dengan" atau tombol "Baru" menu,
minta cakupan https://www.googleapis.com/auth/drive.install untuk diintegrasikan
dengan UI Drive. Saat meminta cakupan ini, pengguna akan menerima
dialog yang serupa dengan ini:
Untuk mengetahui informasi selengkapnya tentang cakupan yang dapat Anda minta untuk aplikasi Drive, dan cara memintanya, lihat Otorisasi dan autentikasi khusus API informasi tambahan.
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 berenkode JSON dengan variabel template dan data tentang
permintaan penautan ke aplikasi Anda. Variabel yang disertakan bergantung pada jenis URL yang digunakan (Buka
URL atau URL Baru):
| Variabel template | Deskripsi | Aplikasi URL |
|---|---|---|
{ids} |
Daftar ID file yang dipisahkan koma 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 untuk ID file yang dipetakan ke resource masing-masing tombol. | Buka URL |
{folderId} |
ID folder induk. | URL baru |
{folderResourceKey} |
Kunci resource dari folder induk. | URL baru |
{userId} |
ID profil yang mengidentifikasi pengguna. | Buka URL dan URL Baru |
{action} |
Tindakan yang sedang dilakukan. Nilainya adalah
open jika menggunakan Open URL atau create
saat menggunakan URL Baru.
|
Buka URL dan URL Baru |
Parameter state dienkode ke URL sehingga aplikasi Anda harus menangani escape
karakter dan mengurainya sebagai JSON. Aplikasi dapat mendeteksi nilai create di
Parameter state untuk memverifikasi permintaan membuat file.
Contoh informasi status di 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 di JSON untuk URL Terbuka
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 file
saat ini. Setelah aplikasi Anda memiliki ID file dan token akses, aplikasi bisa memeriksa
izin akses, mengambil metadata file, dan mengunduh isi file seperti yang dijelaskan
dalam metode files.get.
Topik terkait
Aplikasi terinstal harus dapat membuat, mengelola, dan membuka tindakan yang diluncurkan dari UI Drive. Untuk mempelajari lebih lanjut, lihat Mengintegrasikan dengan "Baru" UI Drive tombol atau Mengintegrasikan dengan UI Drive "Open with" konteks menu.