Google Picker API 參考資料

本頁面列出 Google Picker API 中提供的類別、方法和列舉類型清單。所有這些元素都屬於命名空間google.picker.* 類別和列舉類型分為 2 種:用於建構及設定 Google 挑選器,以及使用者選取項目後,Google 挑選器會回傳這些元素。

設定類別和類型

下列類別和列舉類型可用來建構及設定 Google 挑選器。

DocsUploadView

使用 DocsUploadView 將文件上傳至 Google 雲端硬碟。

DocsUploadView()建構函式。
DocsUploadView.setIncludeFolders(boolean)允許使用者在 Google 雲端硬碟中選取上傳目的地資料夾。
DocsUploadView.setParent(string)將上傳目的地設為指定資料夾。這會覆寫 setIncludeFolders 為 false。

DocsView

DocsViewView 的子類別,可用於 Google 雲端硬碟檢視畫面。

DocsView(ViewId | undefined)建構函式。ViewId 必須是 Google 雲端硬碟的其中一個檢視畫面。預設值為 ViewId.DOCS
DocsView.setEnableDrives(boolean)顯示共用雲端硬碟和其中所含檔案。啟用前,請參閱「啟用共用雲端硬碟的 Google Drive API 說明文件」。
DocsView.setIncludeFolders(boolean)在檢視項目中顯示資料夾。請勿與 setOwnedByMe 合併。設定 setIncludeFolders(true) 時,系統會忽略 setOwnedByMe
DocsView.setSelectFolderEnabled(boolean)允許使用者選取 Google 雲端硬碟中的資料夾。
DocsView.setMode(DocsViewMode)選取檢視模式顯示文件的模式。
DocsView.setOwnedByMe(boolean | undefined)依使用者擁有或與他人共用的文件篩選文件。請勿將這項設定與 setIncludeFolders 合併使用。設定 setIncludeFolders(true) 時,系統會忽略 setOwnedByMe
DocsView.setParent(string)設定要顯示的初始上層資料夾。
DocsView.setStarred(boolean)根據使用者是否加上星號的文件篩選文件。

DocsViewMode

DocsViewMode 是在 DocumentView 中顯示資料的列舉類型。在呼叫 DocsView.setMode 中使用這些值。

DocsViewMode.GRID以縮圖格狀模式顯示文件。
DocsViewMode.LIST以詳細清單顯示文件。

功能

Feature 是一種列舉類型,用於在不同檢視畫面上開啟/關閉功能。在呼叫 PickerBuilder.enableFeaturePickerBuilder.disableFeature 時使用這些值。

Feature.MINE_ONLY顯示 Google 雲端硬碟中的項目時,僅顯示使用者擁有的文件。
Feature.MULTISELECT_ENABLED可讓使用者選擇多個項目。
Feature.NAV_HIDDEN隱藏導覽窗格。如果導覽窗格處於隱藏狀態,使用者只能從所選的第一個檢視畫面中選擇。
Feature.SIMPLE_UPLOAD_ENABLED上傳相片時,控制是否啟用每張相片的選取功能 (而不是每本相簿)。
Feature.SUPPORT_DRIVES

已淘汰:系統現在預設會納入共用雲端硬碟項目。

是否要在結果中納入共用雲端硬碟項目。

挑選器

Picker 是頂層物件,代表與使用者的 UI 動作。這些物件並非直接建立,而是使用 PickerBuilder 物件。

Picker.isVisible()取得指出目前 Picker 顯示設定的布林值。
Picker.setCallback(function(object))指定使用者選取項目 (或取消) 時,呼叫的回呼方法。
Picker.setRelayUrl(string)指定轉發網址來規避跨網域問題。
Picker.setVisible(boolean)控制 Picker 物件的顯示設定。
Picker.dispose()處置 Picker 物件。

PickerBuilder

PickerBuilder 可用來建立 Picker 物件。除非另有註明,否則下列方法的傳回類型為 PickerBuilder 類型,因此您可以將呼叫鏈結至另一個呼叫鏈結。如需一般用途,請參閱 Google Picker 程式碼範例

PickerBuilder()建構函式。
PickerBuilder.addView(View | ViewId)在導覽窗格中新增 View
PickerBuilder.addViewGroup(ViewGroup)在頂層導覽窗格中新增 ViewGroup
PickerBuilder.build()建構 Picker 物件。系統會傳回 Picker 物件。
PickerBuilder.disableFeature(Feature)停用挑選器功能。
PickerBuilder.enableFeature(Feature)啟用挑選器功能。
PickerBuilder.getRelayUrl()取得小工具.rpc 使用的轉送網址。
PickerBuilder.getTitle()取得對話方塊標題。
PickerBuilder.hideTitleBar()停止顯示標題列。如要重新啟用,請以非空白標題或未定義的標題呼叫 setTitle
PickerBuilder.isFeatureEnabled(Feature)檢查是否已啟用挑選器 Feature
PickerBuilder.setAppId(string)設定所需的 Google 雲端硬碟應用程式 ID,讓應用程式透過 Google Drive API 存取使用者的檔案。
PickerBuilder.setCallback(method)設定回呼方法。使用者選取項目或取消時,系統就會呼叫此方法。回呼方法接收單一回呼物件。有關回呼物件的結構請參閱 JSON 指南
PickerBuilder.setDeveloperKey(string)設定從 Google API 控制台取得的瀏覽器 API 金鑰。如要進一步瞭解如何取得瀏覽器 API 金鑰,請參閱開發人員指南
PickerBuilder.setDocument(document)設定文件。
PickerBuilder.setLocale(string)ISO 639 語言代碼。如未支援的語言,則使用 en-US。這個方法可以替代在 google.load() 時間設定語言代碼。如需支援的地區清單,請參閱開發人員指南
PickerBuilder.setMaxItems(number)設定使用者可選取的項目數量上限。
PickerBuilder.setOAuthToken(string)設定 OAuth 權杖,用來驗證目前使用者。視權杖範圍而定,只有特定檢視畫面會顯示資料。有效範圍為 Google 文件和雲端硬碟。
PickerBuilder.setOrigin(string)設定 Google Picker 對話方塊的來源。如果應用程式在 iframe 中執行,來源應設為頂層頁面的 window.location.protocol + '//' + window.location.host
PickerBuilder.setRelayUrl(string)設定小工具.rpc 使用的轉送網址。
PickerBuilder.setSelectableMimeTypes(string)設定可選取的 MIME 類型清單。如需多個 MIME 類型,請使用半形逗號分隔。
PickerBuilder.setSize()設定偏好的對話方塊大小。對話方塊會自動置中。尺寸下限為 (566,350) 且大小上限為 (1051,650)。
PickerBuilder.setTitle(string)設定對話方塊標題。
PickerBuilder.toUri()傳回此建構工具產生的 URI。

ResourceId

ResourceId 是靜態類別,用來產生適合 Google Documents List API 的資源 ID。

ResourceId.generate(Document)將文件物件對應至資源 ID。

查看

View 是各種 View 類別的抽象基本類別,例如 DocsView

View(ViewId)建構函式。
View.getId()傳回這個檢視畫面的 ViewId。
View.setMimeTypes(string)設定檢視畫面中包含的 MIME 類型。如需多個 MIME 類型,請使用半形逗號分隔。如果您未設定 MIME 類型,則檢視畫面中會顯示所有 MIME 類型的檔案。
View.setQuery(string)如果是涉及搜尋的檢視,請在搜尋查詢中預先填入這些字詞。

ViewGroup

ViewGroup 是視覺化的分組方式。ViewGroup 本身的根項目必須是 View

ViewGroup(View | ViewId)ViewGroup 是導覽窗格中的視覺化分組依據。ViewGroup 本身的根項目必須是 View
ViewGroup.addLabel(string)為「ViewGroup加上標籤。
ViewGroup.addView(ViewId | View)將檢視畫面新增至 ViewGroupView 可以使用 view 衍生的物件表示,或只要用 ViewId 表示。
ViewGroup.addViewGroup(ViewGroup)在目前 ViewGroup 中,建立巢狀 ViewGroup

ViewId

ViewId 是列舉類型,用於建構 ViewViewGroup 物件。

ViewId.DOCS所有 Google 雲端硬碟文件類型。
ViewId.DOCS_IMAGESGoogle 雲端硬碟相片。
ViewId.DOCS_IMAGES_AND_VIDEOSGoogle 雲端硬碟中的相片和影片。
ViewId.DOCS_VIDEOSGoogle 雲端硬碟影片。
ViewId.DOCUMENTSGoogle 雲端硬碟文件。
ViewId.DRAWINGSGoogle 雲端硬碟繪圖。
ViewId.FOLDERSGoogle 雲端硬碟資料夾。
ViewId.FORMSGoogle 雲端硬碟表單。
ViewId.PDFS儲存在 Google 雲端硬碟中的 PDF 檔案。
ViewId.PRESENTATIONSGoogle 雲端硬碟簡報。
ViewId.SPREADSHEETSGoogle 雲端硬碟試算表。

回呼類型

下列列舉類型可在 Google Picker API 傳回的回呼資料中找到。

動作

Action 是一種列舉類型,代表使用者關閉對話方塊的動作。這個值位於回呼資料中的 Response.ACTION 欄位中。

Action.CANCEL使用者已取消 Google Picker 對話方塊。
Action.PICKED使用者已選擇至少一個項目。

文件

Document 是一種列舉類型,用來傳達特定選定項目的相關資訊。系統只會傳回與所選項目相關的欄位。這個值位於回呼資料中的 Response.DOCUMENTS 欄位中。

Document.DESCRIPTION使用者為所選項目提供的說明。
Document.DURATION所選影片的時間長度。
Document.EMBEDDABLE_URL這個項目的網址適合嵌入網頁中。
Document.ICON_URL這個項目圖示的網址。
Document.ID所選項目的 ID。
Document.IS_NEW如果所選項目剛上傳,則傳回 true。
Document.LAST_EDITED_UTC說明此項目上次編輯時間的時間戳記。
Document.MIME_TYPE這個項目的 MIME 類型。
Document.NAME這個項目的名稱。
Document.NUM_CHILDREN這個項目包含的子項數量。例如所選資料夾中的檔案數量。
Document.PARENT_ID這個項目的父項 ID。例如包含這個檔案的資料夾。
Document.SERVICE_IDServiceId,用於說明選取這個項目的來源服務。
Document.THUMBNAILS描述相片或影片屬性的 Thumbnail 陣列。如果所選項目屬於 Google 雲端硬碟,系統就不會傳回縮圖。
Document.TYPE所選項目的 Type
Document.URL這個項目的網址。

回應

Response 是一種列舉類型,用於傳達使用者選取項目的相關資訊。

Response.ACTIONAction 類型,代表使用者關閉對話方塊的動作。
Response.DOCUMENTS使用者選取的 Document 陣列。
Response.PARENTS所選項目的上層資料夾 ID。(例如所選檔案所屬上層資料夾的 ID)。
Response.VIEW使用者選取這些項目的 View

服務 ID

ServiceId 是一種列舉類型,用來說明從項目中選取的服務。這個值位於所選 DocumentDocument.SERVICE_ID 欄位中。

ServiceId.DOCSGoogle 雲端硬碟。

thumbnail

Thumbnail 是一種列舉類型,用於傳達所選相片或影片的相關資訊。您可以在所選 DocumentDocument.THUMBNAILS 欄位中找到這個值。

Thumbnail.HEIGHT相片或影片的高度 (以像素為單位)。
Thumbnail.WIDTH相片或影片的寬度 (以像素為單位)。
Thumbnail.URL所選相片或影片的網址。

類型

Type 是列舉類型,用來將所選項目分類。您可以在所選 DocumentDocument.TYPE 欄位中找到這個值。

Type.DOCUMENT這個項目是文件。
Type.PHOTO該項目是相片。
Type.VIDEO項目為影片。