本頁提供 Google Picker API 中提供的類別、方法和列舉類型清單。以上所有元素都屬於命名空間google.picker.*
類別和列舉類型分為 2 種，用於建構和設定 Google 挑選器，以及使用者在選取項目後由 Google 挑選器傳回的。
設定類別和類型
下列類別和列舉類型是用來建構及設定 Google 挑選器。
文件上傳檢視畫面
使用 DocsUploadView 將文件上傳到 Google 雲端硬碟。
DocsUploadView() | 建構函式。 |
DocsUploadView.setIncludeFolders(boolean) | 允許使用者在 Google 雲端硬碟中選取要上傳的資料夾。 |
DocsUploadView.setParent(string) | 將上傳目的地設為指定資料夾。這會將 setIncludeFolders 覆寫為 false。 |
文件檢視
DocsView 是 View 的子類別，可用於檢視 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 是一種列舉類型，用於在 DocumentView 中顯示資料。呼叫 DocsView.setMode 時請使用這些值。
DocsViewMode.GRID | 以縮圖格線顯示文件。 |
DocsViewMode.LIST | 在詳細清單中顯示文件。 |
功能
Feature 是一種列舉類型，用於開啟/關閉各種檢視畫面的功能。呼叫 PickerBuilder.enableFeature 和 PickerBuilder.disableFeature 時，請使用這些值。
Feature.MINE_ONLY | 顯示 Google 雲端硬碟項目時，只顯示使用者擁有的文件。 |
Feature.MULTISELECT_ENABLED | 允許使用者選擇多個項目。 |
Feature.NAV_HIDDEN | 隱藏導覽窗格。如果導覽窗格處於隱藏狀態，使用者就只能從所選的第一個資料檢視中選取。 |
Feature.SIMPLE_UPLOAD_ENABLED | 針對相片上傳，控制是否啟用個別相片的選取功能 (而非根據相簿變更)。 |
Feature.SUPPORT_DRIVES |
已淘汰：系統現已預設納入共用雲端硬碟項目。 結果中是否包含共用雲端硬碟項目。 |
挑選器
Picker 是頂層物件，代表了使用者進行 UI 操作。這些物件並不是直接建立，而是使用 PickerBuilder 物件。
Picker.isVisible() | 取得表示目前挑選器瀏覽權限的布林值。 |
Picker.setCallback(function(object)) | 指定在使用者選取項目 (或取消) 時呼叫的回呼方法。 |
Picker.setRelayUrl(string) | 指定轉發網址，以規避跨網域問題。 |
Picker.setVisible(boolean) | 控制挑選器物件的顯示設定。 |
Picker.dispose() | 處理挑選器物件。 |
挑選器
PickerBuilder 是用來建立 Picker 物件。除非另有註明，否則下列方法的傳回類型是 PickerBuilder 類型，可讓您進行另一個呼叫鏈結。如需一般用途資訊，請參閱 Google 選擇器程式碼範例。
PickerBuilder() | 建構函式。 |
PickerBuilder.addView( | 在導覽窗格中新增 View。 |
PickerBuilder.addViewGroup(ViewGroup) | 將 ViewGroup 新增至頂層導覽窗格。 |
PickerBuilder.build() | 建構挑選器。會傳回 Picker 物件。 |
PickerBuilder.disableFeature(Feature) | 停用挑選器功能。 |
PickerBuilder.enableFeature(Feature) | 啟用挑選器功能。 |
PickerBuilder.getRelayUrl() | 取得 Google 用於小工具的轉發網址。 |
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 金鑰。如要進一步瞭解如何取得 Browser API 金鑰，請參閱開發人員指南。 |
PickerBuilder.setDocument(document) | 設定文件。 |
PickerBuilder.setLocale(string) | ISO 639 語言代碼。如果系統不支援語言，系統會使用 en-US。這個方法提供了另一種設定 google.load() 時間設定方法的替代方案。如需支援地區的清單，請參閱開發人員指南。 |
PickerBuilder.setMaxItems(number) | 設定使用者可選取的項目數量上限。 |
PickerBuilder.setOAuthToken(string) | 設定用於驗證目前使用者的 OAuth 憑證。視憑證的範圍而定，只有特定檢視畫面會顯示資料。有效範圍為 Google 文件、雲端硬碟、相簿和 YouTube。 |
PickerBuilder.setOrigin(string) | 設定 Google 挑選器對話方塊的來源。如果您的應用程式是在 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) | 在 ViewGroup 中新增檢視畫面。View 可以由 view 衍生物件表示，也可以僅由 ViewId 表示。 |
ViewGroup.addViewGroup(ViewGroup) | 為目前的 ViewGroup 建立 ViewGroup 的 Nest。 |
觀看 ID
ViewId 是列舉類型，用於建構 View 和 ViewGroup 物件。
ViewId.DOCS | 所有 Google 雲端硬碟文件類型。 |
ViewId.DOCS_IMAGES | Google 雲端硬碟相片。 |
ViewId.DOCS_IMAGES_AND_VIDEOS | Google 雲端硬碟相片和影片。 |
ViewId.DOCS_VIDEOS | Google 雲端硬碟影片。 |
ViewId.DOCUMENTS | Google 雲端硬碟文件。 |
ViewId.DRAWINGS | Google 雲端硬碟繪圖 |
ViewId.FOLDERS | Google 雲端硬碟資料夾 |
ViewId.FORMS | Google 雲端硬碟表單。 |
ViewId.PDFS | 儲存在 Google 雲端硬碟中的 PDF 檔案。 |
ViewId.PRESENTATIONS | Google 雲端硬碟簡報。 |
ViewId.SPREADSHEETS | Google 雲端硬碟試算表。 |
回呼類型
下列列舉類型位於 Google Picker API 傳回的回呼資料中。
動作
Action 是列舉類型，代表使用者關閉對話方塊所執行的動作。這個值位於回呼資料的 Response.ACTION 欄位中。
Action.CANCEL | 使用者已取消 Google 挑選器對話方塊。 |
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_ID | ServiceId，用來說明選取此項目的服務。 |
Document.THUMBNAILS | 用來描述相片或影片屬性的 Thumbnail 陣列。如果選取的項目屬於 Google 雲端硬碟，則不會傳回縮圖。 |
Document.TYPE | 所選項目的Type。 |
Document.URL | 這個項目的網址。 |
回應
Response 是一種列舉類型，用來傳達使用者選取項目的相關資訊。
Response.ACTION | Action 類型代表使用者關閉對話方塊所執行的動作。 |
Response.DOCUMENTS | 使用者選取的 Document 陣列。 |
Response.PARENTS | 所選項目的上層資料夾 ID。(例如所選擇檔案的上層資料夾 ID)。 |
Response.VIEW | 使用者選取這些項目的 View。 |
服務 ID
ServiceId 是列舉類型，用來描述選取項目的服務。這個值位於所選Document的Document.SERVICE_ID欄位中。
ServiceId.DOCS | Google 雲端硬碟。 |
thumbnail
Thumbnail 是一種列舉類型，用來傳達所選相片或影片的相關資訊。這個值會顯示在所選Document的Document.THUMBNAILS欄位中。
Thumbnail.HEIGHT | 相片或影片的高度 (以像素為單位)。 |
Thumbnail.WIDTH | 相片或影片的寬度 (以像素為單位)。 |
Thumbnail.URL | 所選相片或影片的網址。 |
類型
Type 是列舉類型，用於對所選項目進行分類。這個值會顯示在所選Document的Document.TYPE欄位中。
Type.DOCUMENT | 這個項目是文件。 |
Type.PHOTO | 這項商品是相片。 |
Type.VIDEO | 這項商品是影片。 |