Referensi Google Picker API

Halaman ini berisi daftar class, metode, dan jenis terenumerasi yang tersedia di Google Picker API. Semua elemen ini termasuk dalam namespace google.picker.* Ada 2 jenis class dan jenis yang terenumerasi: class yang digunakan untuk membuat dan mengonfigurasi Alat Pilih Google, dan yang ditampilkan oleh Pemilih Google setelah pengguna memilih item.

Class dan Jenis Konfigurasi

Class dan jenis terenumerasi berikut digunakan untuk membuat dan mengonfigurasi Pemilih Google.

DocsUploadView

Gunakan DocsUploadView untuk mengupload dokumen ke Google Drive.

DocsUploadView()Konstruktor.
DocsUploadView.setIncludeFolders(boolean)Mengizinkan pengguna memilih folder di Google Drive untuk diupload.
DocsUploadView.setParent(string)Menetapkan tujuan upload ke folder yang ditentukan. Tindakan ini akan mengganti setIncludeFolders menjadi salah (false).

DocsView

DocsView adalah subclass View yang dapat digunakan untuk tampilan Google Drive.

DocsView(ViewId | undefined)Konstruktor. ViewId harus berupa salah satu tampilan Google Drive. Defaultnya adalah ViewId.DOCS.
DocsView.setEnableDrives(boolean)Menampilkan drive bersama dan file yang ada di dalamnya. Sebelum mengaktifkan, lihat dokumentasi Google Drive API untuk mengaktifkan drive bersama.
DocsView.setIncludeFolders(boolean)Tampilkan folder dalam item tampilan. Jangan gabungkan dengan setOwnedByMe. Jika setIncludeFolders(true) ditetapkan, setOwnedByMe akan diabaikan.
DocsView.setSelectFolderEnabled(boolean)Mengizinkan pengguna memilih folder di Google Drive.
DocsView.setMode(DocsViewMode)Memilih mode mana yang digunakan tampilan untuk menampilkan dokumen.
DocsView.setOwnedByMe(boolean | undefined)Memfilter dokumen berdasarkan apakah dokumen tersebut dimiliki oleh pengguna, atau dibagikan kepada pengguna. Jangan gabungkan setelan ini dengan setIncludeFolders. Jika setIncludeFolders(true) ditetapkan, setOwnedByMe akan diabaikan.
DocsView.setParent(string)Menetapkan folder induk awal untuk ditampilkan.
DocsView.setStarred(boolean)Memfilter dokumen berdasarkan apakah dokumen tersebut diberi bintang oleh pengguna atau tidak.

DocsViewMode

DocsViewMode adalah jenis terenumerasi untuk menampilkan data dalam DocsView. Gunakan nilai ini dalam panggilan ke DocsView.setMode.

DocsViewMode.GRIDMenampilkan dokumen dalam petak thumbnail.
DocsViewMode.LISTMenampilkan dokumen dalam daftar mendetail.

Fitur

Feature adalah jenis terenumerasi, untuk mengaktifkan/menonaktifkan fitur untuk berbagai tampilan. Gunakan nilai ini dalam panggilan ke PickerBuilder.enableFeature dan PickerBuilder.disableFeature.

Feature.MINE_ONLYHanya tampilkan dokumen milik pengguna saat menampilkan item dari Google Drive.
Feature.MULTISELECT_ENABLEDIzinkan pengguna memilih lebih dari satu item.
Feature.NAV_HIDDENMenyembunyikan panel navigasi. Jika panel navigasi disembunyikan, pengguna hanya dapat memilih dari tampilan pertama yang dipilih.
Feature.SIMPLE_UPLOAD_ENABLEDUntuk upload foto, mengontrol apakah pemilihan per foto (bukan per album) diaktifkan.
Feature.SUPPORT_DRIVES

Tidak digunakan lagi: Item drive bersama kini disertakan secara default.

Apakah item drive bersama disertakan dalam hasil.

Alat pilih

Picker adalah objek tingkat teratas yang mewakili tindakan UI bersama pengguna. Objek ini tidak dibuat secara langsung, tetapi menggunakan objek PickerBuilder.

Picker.isVisible()Mendapatkan boolean yang menunjukkan visibilitas Picker saat ini.
Picker.setCallback(function(object))Tentukan metode callback yang dipanggil setiap kali pengguna telah memilih item (atau membatalkan.)
Picker.setRelayUrl(string)Tentukan URL relai untuk mengakali masalah lintas-domain.
Picker.setVisible(boolean)Mengontrol visibilitas objek Picker.
Picker.dispose()Membuang objek Picker.

PickerBuilder

PickerBuilder digunakan untuk membuat objek Picker. Kecuali dinyatakan lain, jenis nilai yang ditampilkan di bawah adalah jenis PickerBuilder, yang memungkinkan Anda merangkai satu panggilan demi panggilan lainnya. Lihat contoh kode Alat Pilih Google untuk penggunaan umum.

PickerBuilder()Konstruktor.
PickerBuilder.addView(View | ViewId)Tambahkan View ke panel navigasi.
PickerBuilder.addViewGroup(ViewGroup)Tambahkan ViewGroup ke panel navigasi tingkat atas.
PickerBuilder.build()Membuat objek Picker. Objek Picker ditampilkan.
PickerBuilder.disableFeature(Feature)Menonaktifkan fitur pemilih.
PickerBuilder.enableFeature(Feature)Mengaktifkan fitur pemilih.
PickerBuilder.getRelayUrl()Dapatkan URL relai, digunakan untuk gadget.rpc.
PickerBuilder.getTitle()Mendapatkan judul dialog.
PickerBuilder.hideTitleBar()Menonaktifkan panel judul agar tidak ditampilkan. Untuk mengaktifkannya kembali, panggil setTitle dengan judul yang tidak kosong atau tidak ditentukan.
PickerBuilder.isFeatureEnabled(Feature)Periksa apakah alat pilih Feature diaktifkan.
PickerBuilder.setAppId(string)Menyetel ID Aplikasi Google Drive yang diperlukan untuk mengizinkan aplikasi mengakses file pengguna melalui Google Drive API.
PickerBuilder.setCallback(method)Tetapkan metode callback. Metode ini dipanggil saat pengguna memilih item atau membatalkan. Metode callback ini akan menerima satu objek callback. Struktur objek callback dijelaskan dalam Panduan JSON.
PickerBuilder.setDeveloperKey(string)Menetapkan kunci API Browser yang diperoleh dari Konsol API Google. Lihat Panduan Developer untuk mengetahui detail cara mendapatkan kunci API Browser.
PickerBuilder.setDocument(document)Tetapkan dokumen.
PickerBuilder.setLocale(string)Kode bahasa ISO 639. Jika bahasa tidak didukung, en-US akan digunakan. Metode ini memberikan alternatif untuk menyetel lokal pada waktu google.load(). Baca Panduan Developer untuk mengetahui daftar lokalitas yang didukung.
PickerBuilder.setMaxItems(number)Menetapkan jumlah maksimum item yang dapat dipilih pengguna.
PickerBuilder.setOAuthToken(string)Menetapkan token OAuth yang akan digunakan untuk mengautentikasi pengguna saat ini. Bergantung pada cakupan token, hanya tampilan tertentu yang menampilkan data. Cakupan yang valid adalah Google Dokumen dan Drive.
PickerBuilder.setOrigin(string)Menetapkan asal dialog Pemilih Google. Asal harus disetel ke window.location.protocol + '//' + window.location.host halaman paling atas, jika aplikasi Anda berjalan di iframe.
PickerBuilder.setRelayUrl(string)Atur URL relai, digunakan untuk gadget.rpc.
PickerBuilder.setSelectableMimeTypes(string)Tetapkan daftar jenis MIME yang dapat dipilih. Gunakan koma untuk memisahkan jenis MIME jika diperlukan lebih dari satu.
PickerBuilder.setSize()Setel ukuran dialog yang diinginkan. Dialog dipusatkan secara otomatis. Ini memiliki ukuran minimum (566.350) dan ukuran maksimum (1051.650).
PickerBuilder.setTitle(string)Setel judul dialog.
PickerBuilder.toUri()Menampilkan URI yang dihasilkan oleh builder ini.

ResourceId

ResourceId adalah class statis yang digunakan untuk menghasilkan ID resource yang sesuai untuk Google Documents List API.

ResourceId.generate(Document)Memetakan objek dokumen ke ID resource.

Lihat

View adalah class dasar abstrak untuk berbagai class View, seperti DocsView.

View(ViewId)Konstruktor.
View.getId()Menampilkan ViewId untuk tampilan ini.
View.setMimeTypes(string)Menetapkan jenis MIME yang disertakan dalam tampilan. Gunakan koma untuk memisahkan jenis MIME jika diperlukan lebih dari satu. Jika Anda tidak menetapkan jenis MIME, file dari semua jenis MIME akan ditampilkan dalam tampilan.
View.setQuery(string)Untuk tampilan yang melibatkan penelusuran, isi kueri penelusuran dengan istilah ini.

ViewGroup

ViewGroup adalah pengelompokan visual dari tampilan. Item root ViewGroup itu sendiri harus berupa View.

ViewGroup(View | ViewId)ViewGroup adalah pengelompokan visual tampilan di panel navigasi. Item root ViewGroup itu sendiri harus View.
ViewGroup.addLabel(string)Tambahkan label ke ViewGroup ini.
ViewGroup.addView(ViewId | View)Tambahkan tampilan ke ViewGroup. View dapat direpresentasikan oleh objek yang berasal dari view, atau cukup dengan ViewId.
ViewGroup.addViewGroup(ViewGroup)Tempatkan ViewGroup dalam ViewGroup saat ini.

ViewId

ViewId adalah jenis terenumerasi, yang digunakan untuk membuat objek View dan ViewGroup.

ViewId.DOCSSemua jenis dokumen Google Drive.
ViewId.DOCS_IMAGESFoto Google Drive.
ViewId.DOCS_IMAGES_AND_VIDEOSFoto dan video Google Drive.
ViewId.DOCS_VIDEOSVideo Google Drive.
ViewId.DOCUMENTSDokumen Google Drive.
ViewId.DRAWINGSGambar Google Drive.
ViewId.FOLDERSFolder Google Drive.
ViewId.FORMSFormulir Google Drive.
ViewId.PDFSFile PDF yang disimpan di Google Drive.
ViewId.PRESENTATIONSPresentasi Google Drive.
ViewId.SPREADSHEETSSpreadsheet Google Drive.

Jenis Callback

Jenis enumerasi berikut ditemukan dalam data callback yang ditampilkan oleh Google Picker API.

Tindakan

Action adalah jenis terenumerasi yang mewakili tindakan yang diambil oleh pengguna untuk menutup dialog. Nilai ini ada di kolom Response.ACTION dalam data callback.

Action.CANCELPengguna membatalkan dialog Pemilih Google.
Action.PICKEDPengguna telah memilih setidaknya satu item.

Dokumen

Document adalah jenis terenumerasi yang digunakan untuk menyampaikan informasi tentang item tertentu yang dipilih. Hanya kolom yang relevan dengan item yang dipilih yang ditampilkan. Nilai ini ada di kolom Response.DOCUMENTS dalam data callback.

Document.DESCRIPTIONDeskripsi kontribusi pengguna untuk item yang dipilih.
Document.DURATIONDurasi video yang dipilih.
Document.EMBEDDABLE_URLURL untuk item ini yang cocok untuk disematkan di halaman web.
Document.ICON_URLURL ke ikon untuk item ini.
Document.IDID untuk item yang dipilih.
Document.IS_NEWMenampilkan true (benar) jika item yang dipilih baru saja diupload.
Document.LAST_EDITED_UTCStempel waktu yang menjelaskan kapan item ini terakhir diedit.
Document.MIME_TYPEJenis MIME item ini.
Document.NAMENama item ini.
Document.NUM_CHILDRENJumlah turunan yang ada dalam item ini. Misalnya, jumlah file dalam folder yang dipilih.
Document.PARENT_IDID induk item ini. Misalnya, folder yang berisi file ini.
Document.SERVICE_IDServiceId yang menjelaskan layanan tempat item ini dipilih.
Document.THUMBNAILSArray Thumbnail yang mendeskripsikan atribut foto atau video. Thumbnail tidak ditampilkan jika item yang dipilih adalah milik Google Drive.
Document.TYPEType dari item yang dipilih.
Document.URLURL untuk item ini.

Respons

Response adalah jenis terenumerasi yang digunakan untuk menyampaikan informasi tentang item yang dipilih pengguna.

Response.ACTIONJenis Action yang mewakili tindakan yang dilakukan oleh pengguna untuk menutup dialog.
Response.DOCUMENTSArray Document yang dipilih oleh pengguna.
Response.PARENTSID folder induk untuk item yang dipilih. (Misalnya, ID folder induk yang filenya dipilih.)
Response.VIEWView pengguna memilih item ini.

id-layanan

ServiceId adalah jenis terenumerasi yang digunakan untuk mendeskripsikan layanan tempat item dipilih. Nilai ini berada di kolom Document.SERVICE_ID dari Document yang dipilih.

ServiceId.DOCSGoogle Drive.

gambar mini

Thumbnail adalah jenis terenumerasi yang digunakan untuk menyampaikan informasi tentang foto atau video yang dipilih. Nilai ini dapat ditemukan di kolom Document.THUMBNAILS dari Document yang dipilih.

Thumbnail.HEIGHTTinggi foto atau video dalam piksel.
Thumbnail.WIDTHLebar foto atau video dalam piksel.
Thumbnail.URLURL ke foto atau video yang dipilih.

tipe

Type adalah jenis terenumerasi yang digunakan untuk mengategorikan item yang dipilih. Nilai ini dapat ditemukan di kolom Document.TYPE dari Document yang dipilih.

Type.DOCUMENTItem adalah dokumen.
Type.PHOTOItem adalah foto.
Type.VIDEOItem adalah video.