Google 选择器 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 是枚举类型,用于在 Google 文档视图中显示数据。在对 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

Picker 是表示用户进行界面操作的顶级对象。这些对象不是直接创建的,而是使用 PickerBuilder 对象。

Picker.isVisible()获取指示当前 Picker 可见性的布尔值。
Picker.setCallback(function(object))指定每当用户选择某个项(或取消)时调用的回调方法。
Picker.setRelayUrl(string)请指定用于规避跨网域问题的中继网址。
Picker.setVisible(boolean)控制 Picker 对象的可见性。
Picker.dispose()处理 Picker 对象。

PickerBuilder

PickerBuilder 用于创建 Picker 对象。除非另有说明,否则以下方法的返回值类型为 PickerBuilder 类型,允许您将一个调用链接在一起。如需了解典型用途,请参阅 Google 选择器代码示例

PickerBuilder()构造函数。
PickerBuilder.addView(View | ViewId)View 添加到导航窗格。
PickerBuilder.addViewGroup(ViewGroup)ViewGroup 添加到顶级导航窗格。
PickerBuilder.build()构建 Picker 对象。系统会返回 Picker 对象。
PickerBuilder.disableFeature(Feature)停用选择器功能。
PickerBuilder.enableFeature(Feature)启用一项选择器功能。
PickerBuilder.getRelayUrl()获取用于 Dagger.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 选择器对话框的来源。如果您的应用在 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

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 选择器对话框。
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 是一种枚举类型,用于传达所选照片或视频的相关信息。该值可在所选 DocumentDocument.THUMBNAILS 字段中找到。

Thumbnail.HEIGHT照片或视频的高度(以像素为单位)。
Thumbnail.WIDTH照片或视频的宽度(以像素为单位)。
Thumbnail.URL指向所选照片或视频的网址。

类型

Type 是用于对选定项进行分类的枚举类型。该值可在所选 DocumentDocument.TYPE 字段中找到。

Type.DOCUMENT该项是一个文档。
Type.PHOTO该项是照片。
Type.VIDEO该项内容为视频。