此页面由 Cloud Translation API 翻译。

Google Picker API 参考文档

本页面列出了 Google 选择器 API 中提供的类、方法和枚举类型。所有这些元素都属于命名空间 google.picker.* 有两种类型的类和枚举类型：用于构建和配置 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 是一种用于在 DocsView 内显示数据的枚举类型。在对 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

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

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

PickerBuilder

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

`PickerBuilder()`	构造函数。
`PickerBuilder.addView(View \| ViewId)`	将 `View` 添加到导航窗格中。
`PickerBuilder.addViewGroup(ViewGroup)`	将 `ViewGroup` 添加到顶级导航窗格中。
`PickerBuilder.build()`	构造 Picker 对象。系统会返回选择器对象。
`PickerBuilder.disableFeature(Feature)`	停用选择器功能。
`PickerBuilder.enableFeature(Feature)`	启用选择器功能。
`PickerBuilder.getRelayUrl()`	获取用于 Gadgets.rpc 的中继网址。
`PickerBuilder.getTitle()`	获取对话框标题。
`PickerBuilder.hideTitleBar()`	禁止显示标题栏。如需重新启用，请使用非空标题或未定义调用 `setTitle`。
`PickerBuilder.isFeatureEnabled(Feature)`	检查选择器 `Feature` 是否处于启用状态。
`PickerBuilder.setAppId(string)`	设置允许应用通过 Google Drive API 访问用户文件所需的 Google 云端硬盘应用 ID。
`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 文档、云端硬盘、相册、YouTube。
`PickerBuilder.setOrigin(string)`	设置 Google 选择器对话框的源站。如果您的应用在 iframe 中运行，则来源应设置为最顶层的 `window.location.protocol + '//' + window.location.host`。
`PickerBuilder.setRelayUrl(string)`	设置用于 Gadgets.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`。

查看 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 是一个枚举类型，用于传达有关所选照片或视频的信息。此值可在所选 Document 的 Document.THUMBNAILS 字段中找到。

`Thumbnail.HEIGHT`	照片或视频的高度（以像素为单位）。
`Thumbnail.WIDTH`	照片或视频的宽度（以像素为单位）。
`Thumbnail.URL`	所选照片或视频的网址。

类型

Type 是用于对所选内容进行分类的枚举类型。此值可在所选 Document 的 Document.TYPE 字段中找到。

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