配置云端硬盘界面集成

若要在用户创建或打开文件时让您的应用显示在 Google 云端硬盘中，您需要 必须先设置云端硬盘界面 (UI) 集成。 要在 Google Workspace Marketplace。

启用 Drive API

使用 Google API 之前，您必须在 Google Cloud 中将其启用 项目。您可以在单个 Google Cloud 中启用一个或多个 API 项目。

要开始与 Google 云端硬盘界面集成，您必须启用 云端硬盘 API。这样，您就可以访问 API 和界面集成 功能。

  • 在 Google Cloud 控制台中，启用 Google Drive API。

    启用 API

设置云端硬盘界面集成

  1. 在 Google API 控制台中，点击“菜单”图标 > API 和服务 > 已启用的 API 和服务。

    转到“已启用的 API”和服务

  2. 在 API 的底部，服务信息中心，请点击 Google Drive API。通过 系统会显示 Google Drive API 配置页面。
  3. 选择云端硬盘界面集成标签页。
  4. （可选）在应用名称字段中输入一个名称。应用 名称会在云端硬盘的“管理应用”标签页中向用户显示 设置。
  5. （可选）在简短说明中输入一行简短的说明。 字段。简短说明会在 云端硬盘设置。
  6. （可选）在详细说明字段中输入完整说明。

  7. 上传一个或多个应用图标，以显示在用户的 关联的云端硬盘应用，并在“打开方式”上下文菜单 图标应为 PNG 格式，背景透明。图标可能需要 最长 24 小时才会显示在云端硬盘中

  8. 要使用云端硬盘界面的“打开方式”菜单 请在商品说明页面中输入指向您应用的网址 打开网址字段。此网址用于“打开方式”上下文菜单

    • 此网址必须包含完全限定域名；localhost 不可以 工作。
    • 此网址应该可供您应用的目标用户访问。 如果您有多个应用版本，例如一个公开版 一个发布版本和一个面向部分用户的受限发布版本，每个版本 都应该使用唯一的网址然后，您可以创建 每个版本的配置
    • 您必须 验证此网址的所有权 然后才能在 Google Workspace Marketplace 中上架您的应用。
    • 默认情况下，系统会将 state 查询参数附加到此网址，以传递 从云端硬盘界面发送到您的应用如需了解 state 参数的内容，请参阅 state 参数。
    。

  9. （可选）在 默认 MIME 类型和默认文件扩展名字段。默认 MIME 类型和文件扩展名分别表示您的应用 打开。例如，您的应用可能会打开用于分层和 编辑图片。仅添加标准媒体 类型 并确保没有任何错别字和拼写错误如果您的应用仅打开 快捷方式或第三方快捷方式文件，则可以将 MIME 类型留空。

  10. （可选）在次要 MIME 类型和文件扩展名 MIME 类型和次要文件扩展名字段。次要 MIME 类型 和文件扩展名表示应用可以打开的文件，并不局限于特定 应用例如，您的应用可能是 PNG 和 JPG 图片。仅添加标准媒体 类型 并确保没有任何拼写错误如果您的应用仅打开 快捷方式或第三方快捷方式文件，则可以将 MIME 类型留空。

  11. 要使用云端硬盘界面的“新建” 按钮，并让用户使用 您的应用，请勾选创建文件复选框。新网址和可选 文档名称字段。

    • 此网址必须包含完全限定域名；localhost 不可以 工作。
    • 您必须验证对此 网址 然后才能在 Google Workspace Marketplace 中上架您的应用。
    • 默认情况下，系统会将 state 查询参数附加到此网址，以传递 从云端硬盘界面发送到您的应用如需了解 state 参数的内容，请参阅 state 参数。

  12. 在新网址字段中输入一个网址。此网址供“新”标签使用按钮 将用户重定向到您的应用。

  13. （可选）如果您希望应用打开 Google Workspace 支持的文件， 选中导入复选框。

  14. （可选）如果您的应用必须管理共享云端硬盘中的文件，请选中 共享云端硬盘支持复选框。如需详细了解如何使用 共享云端硬盘，请参阅实现共享云端硬盘 支持。

  15. 点击提交。

请求 drive.install 范围

要允许应用在“打开方式”中显示为选项，请执行以下操作：或“新”菜单 请求 https://www.googleapis.com/auth/drive.install 范围进行集成 使用云端硬盘界面请求此范围时，用户会收到 类似于以下内容的对话框：

Google 云端硬盘界面的安装对话框。
图 1. 为云端硬盘界面使用作用域时的安装对话框。

如需详细了解您可以为云端硬盘应用申请的范围， 以及如何请求这些授权，请参阅特定于 API 的授权和身份验证 信息。

state 参数

默认情况下，state 参数会同时附加到打开网址和新网址 将数据从云端硬盘界面传递到应用此参数 包含 JSON 编码的字符串，该字符串带有模板变量和 向您的应用发出请求包含的变量取决于所使用的网址类型（打开 网址或新网址）：

模板变量 说明 网址应用
{ids} 正在打开的文件 ID 列表（以英文逗号分隔）。 打开网址
{exportIds} 以英文逗号分隔的待导出文件 ID 列表（仅限使用） ）。 打开网址
{resourceKeys} 映射到相应资源的文件 ID 的 JSON 字典 键。 打开网址
{folderId} 父级文件夹的 ID。 “新建”网址
{folderResourceKey} 父级文件夹的资源密钥。 “新建”网址
{userId} 用于标识用户的个人资料 ID。 打开网址和新网址
{action} 正在执行的操作。该值为 open（如果使用打开网址）或 create 。 打开网址和新网址

state 参数经过了网址编码，因此您的应用必须处理转义 字符并将其解析为 JSON。应用可以检测到create state 参数，用于验证创建文件的请求。

新网址的 JSON 状态信息示例

新网址的 state 信息如下：

{
  "action":"create",
  "folderId":"FOLDER_ID",
  "folderResourceKey":"FOLDER_RESOURCE_KEY",
  "userId":"USER_ID"
}

开放网址的 JSON 格式状态信息示例

打开网址的 state 信息为：

{
  "ids": ["ID"],
  "resourceKeys":{"RESOURCE_KEYS":"RESOURCE_KEYS"},
  "action":"open",
  "userId":"USER_ID"
}

ID 和资源键用于提取文件元数据和下载文件 内容。您的应用获得文件 ID 和访问令牌后， 权限、提取文件元数据，并按照说明下载文件内容 （位于 files.get 方法中）。

已安装的应用必须能够创建、管理和打开从以下位置启动的操作： 云端硬盘界面中如需了解详情，请参阅集成 云端硬盘界面的“新”按钮或 与云端硬盘界面的“打开方式”集成上下文 菜单。