启用缩略图

搜索结果返回的文档会显示缩略图。缩略图允许 以便更好地识别所返回文档的相关性。缩略图 以下特征:

  • 宽度为 1024 像素。
  • Google Workspace 文件缩略图的网址受 ACL 保护。的网址 其他文件类型不受 ACL 保护
  • 网址会在 5 分钟后过期。
  • 系统不会为大于 50 MB 的文件生成缩略图。
  • 如果无法生成缩略图,则会使用占位图标。如果缩略图 无法生成 Google Workspace 内容的缩略图网址,则返回缩略图网址 “404 未找到。”您的应用必须处理此行为。

系统会自动为 Google 云端硬盘文件创建缩略图, 支持缩略图,例如 Google Workspace 文档类型(文档、表格、 幻灯片等)。此外,Cloud Search 会自动创建缩略图 以下文件类型:

  • Microsoft Word(文档)
  • Microsoft Word (DOCX)
  • Microsoft Excel (XLS)
  • Microsoft Excel (XLSX)
  • Microsoft PowerPoint (PPT)
  • Microsoft PowerPoint (PPTX)
  • Adobe 便携式文档格式 (PDF)
  • 富文本格式 (RTF)
  • 文本格式 (TXT)
  • 超文本标记语言 (HTML)
  • 可扩展标记语言 (XML)

仅返回数据源和搜索应用所对应项的缩略图 启用它们。

为数据源启用缩略图网址

您的 Cloud Search 平台项目包含服务账号凭据。 但是,要启用缩略图网址,您必须创建一个 API 密钥和 Web 应用凭据,以及使用 Web 应用凭据 来获取访问令牌。最后,您将使用这些凭据 数据源

  1. 为您的应用创建或选择项目(如果尚未创建)并启用 API。有关这两个步骤的信息,请参见 配置对 Google Cloud Search API 的访问权限
  2. 创建 API 密钥:
    1. 在 Google Cloud 控制台中,点击“创建凭据”下拉列表,然后 选择 API 密钥“API 密钥已创建”页面。
    2. 记下 API 密钥。
    3. 点击“关闭”。新创建的凭据会显示在“API 密钥”下方。
  3. 创建 Web 应用凭据。使用https://developers.google.com/oauthplayground 作为重定向 URI。如需了解创建这些凭据的步骤,请参阅 创建 Web 应用凭据(客户端 JavaScript)
  4. 在 OAuth 2.0 Playground 中, 点击 OAuth 2.0 Configuration(OAuth 2.0 配置)图标
  5. 选中 Use your own credentials(使用您自己的凭据)。
  6. 输入第 3 步中生成的客户端 ID 和客户端密钥。
  7. 在“范围”字段中,输入 https://www.googleapis.com/auth/cloud_search.settings 然后点击 Authorize APIs(授权 API)。
  8. (可选)如果系统显示登录屏幕,请选择要使用的账号。
  9. (可选)如果看到授权屏幕,请点击接受
  10. 点击交换令牌的授权代码。系统会返回一个令牌。
  11. 确定要为其启用缩略图的数据源 控件。
  12. 调用 settings.datasources.get 以获取数据源的 ID:

    curl
    'https://cloudsearch.googleapis.com/v1/settings/datasource_id?key=[YOUR_API_KEY]' \
    --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]'\
    --header 'Accept: application/json'  \
    --compressed
    

    其中:

    • datasource_id 是要检索的数据源的名称。
    • YOUR_API_KEY 是您项目的 API 密钥(从第 2 步获得)。
    • YOUR_ACCESS_TOKEN 是您的项目的 OAuth 2.0 访问令牌(从 )。

    此命令的成功结果类似于以下内容:

    {
     "source": {
       "name": "datasources/datasource_id",
       "displayName": "DataSource_Display_Name",
       "itemsVisibility": [
         {
           "gsuiteDomain": true
         }
       ]
     }
    }
    
  13. 调用 setting.datasource.updatereturnThumbnailUrls 设置为 true,以启用数据的缩略图网址 资料来源:

    curl --request PUT \  'https://cloudsearch.googleapis.com/v1/settings/datasources/datasource_id?key=[YOUR_API_KEY]' \
      --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
      --header 'Accept: application/json' \
      --header 'Content-Type: application/json' \
      --data '{"source":{"name":"datasources/datasource_id","displayName":"DataSource_Display_Name","itemsVisibility":
        [{"gsuiteDomain":true}],"returnThumbnailUrls":true}}' \
      --compressed
    

    其中:

    • datasource_id 是要检索的数据源的 ID。
    • YOUR_API_KEY 是您项目的 API 密钥(从第 2 步获得)。
    • YOUR_ACCESS_TOKEN 是您的项目的 OAuth 2.0 访问令牌(从 )。
    • DataSource_DisplayName 是从上一个事件返回的显示名称 c网址 命令。
    • 使用 "returnThumbnailsUrls":true 可启用缩略图。

    此命令的成功结果类似于以下内容:

    {
      "source": {
        "name": "datasources/datasource_id",
        "displayName": "DataSource_Display_Name",
        "itemsVisibility": [
          {
            "gsuiteDomain": true
          }
        ],
        "returnThumbnailUrls": true
      }
    }
    

为搜索应用启用缩略图网址

您的 Cloud Search 平台项目包含服务账号凭据。 但是,要启用缩略图网址,您必须创建一个 API 密钥和 Web 应用凭据,以及使用 Web 应用凭据 来获取访问令牌。最后,您将使用这些凭据 搜索应用。

  1. 为您的应用创建或选择项目(如果尚未创建)并启用 API。有关这两个步骤的信息,请参见 配置对 Google Cloud Search API 的访问权限
  2. 创建 API 密钥:
    1. 在 Cloud 控制台中,点击“创建凭据”下拉列表,然后 选择 API 密钥“API 密钥已创建”页面。
    2. 记下 API 密钥。
    3. 点击“关闭”。新创建的凭据会显示在“API 密钥”下方。
  3. 创建 Web 应用凭据。使用https://developers.google.com/oauthplayground 作为重定向 URI。如需了解创建这些凭据的步骤,请参阅 创建 Web 应用凭据(客户端 JavaScript)
  4. 在 OAuth 2.0 Playground 中, 点击 OAuth 2.0 Configuration(OAuth 2.0 配置)图标
  5. 选中 Use your own credentials(使用您自己的凭据)。
  6. 输入第 3 步中生成的客户端 ID 和客户端密钥。
  7. 在“范围”字段中,输入 https://www.googleapis.com/auth/cloud_search.settings 然后点击 Authorize APIs(授权 API)。
  8. (可选)如果系统显示登录屏幕,请选择要使用的账号。
  9. (可选)如果看到授权屏幕,请点击接受
  10. 点击交换令牌的授权代码。系统会返回一个令牌。
  11. 确定您想为其启用缩略图控件的搜索应用。
  12. 调用 settings.searchapplications.get 以获取搜索应用的 ID:

    curl \ 'https://cloudsearch.googleapis.com/v1/settings/searchapplications/search_application_id?key=[YOUR_API_KEY]' \
     --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
     --header 'Accept: application/json' \
     --compressed
    

    其中:

    • 是要检索的搜索应用的 ID。
    • YOUR_API_KEY 是您项目的 API 密钥(从第 2 步获得)。
    • YOUR_ACCESS_TOKEN 是您的项目的 OAuth 2.0 访问令牌(从 )。

    此命令的成功结果类似于以下内容:

    {
     "name": "searchapplications/search_application_id",
     "displayName": "SearchApp_Display_Name",
     "dataSourceRestrictions": [
       {
         "source": {
           "name": "datasources/datasource_id"
         }
       }
     ]
    }
    
  13. 调用 setting.searchapplications.update 并将 returnResultThumbnailUrls 设置为 true,以启用 搜索应用:

    curl --request PUT \  'https://cloudsearch.googleapis.com/v1/settings/searchapplications/search_application_id?key=[YOUR_API_KEY]' \
      --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
      --header 'Accept: application/json' \
      --header 'Content-Type: application/json' \
      --data '{"name":"searchapplications/search_application_id","displayName":"SearchApp_Display_Name","dataSourceRestrictions":[{"source":
        {"name":"datasources/datasource_id"}}],"returnResultThumbnailUrls":true}' \
      --compressed
    

    其中:

    • 是要检索的搜索应用的 ID。
    • YOUR_API_KEY 是您项目的 API 密钥(从第 2 步获得)。
    • YOUR_ACCESS_TOKEN 是您的项目的 OAuth 2.0 访问令牌(从 )。
    • SearchApp_DisplayName 是从上一个事件返回的显示名称 c网址 命令。
    • 使用 "returnResultThumbnailUrls":true 可启用缩略图。

    此命令的成功结果类似于以下内容:

    {
      "name": "searchapplications/search_application_id",
      "displayName": "SearchApp_Display_Name",
      "dataSourceRestrictions": [
        {
          "source": {
            "name": "datasources/datasource_id"
          }
        }
      ],
      "returnResultThumbnailUrls": true
    }
    

访问缩略图

要访问云端硬盘中的 Google Workspace 文件的缩略图,用户或 应用所传递的账号凭据必须与 文件。