启用缩略图

系统会为搜索结果返回的文档显示缩略图。缩略图可让用户更好地识别返回文档的相关性。缩略图具有以下特征:

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

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

  • Microsoft Word (DOC)
  • 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 的访问权限中的第 1 步和第 2 步。
  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 图标
  5. 选中 Use your own credentials(使用您自己的凭据)。
  6. 输入第 3 步中生成的客户端 ID 和客户端密钥。
  7. 在“范围”字段中,输入 https://www.googleapis.com/auth/cloud_search.settings,然后点击 Authorize APIs
  8. (可选)如果系统显示登录屏幕,请选择要使用的帐号。
  9. (可选)如果系统显示授权屏幕,请点击接受
  10. 点击 Exchange Authorization code for tokens。系统会返回一个令牌。
  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 访问令牌(在第 10 步中获取)。

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

    {
     "source": {
       "name": "datasources/datasource_id",
       "displayName": "DataSource_Display_Name",
       "itemsVisibility": [
         {
           "gsuiteDomain": true
         }
       ]
     }
    }
    
  13. 调用 setting.datasource.update 并将 returnThumbnailUrls 设置为 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 访问令牌(在第 10 步中获取)。
    • 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 的访问权限中的第 1 步和第 2 步。
  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 图标
  5. 选中 Use your own credentials(使用您自己的凭据)。
  6. 输入第 3 步中生成的客户端 ID 和客户端密钥。
  7. 在“范围”字段中,输入 https://www.googleapis.com/auth/cloud_search.settings,然后点击 Authorize APIs
  8. (可选)如果系统显示登录屏幕,请选择要使用的帐号。
  9. (可选)如果系统显示授权屏幕,请点击接受
  10. 点击 Exchange Authorization code for tokens。系统会返回一个令牌。
  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 访问令牌(在第 10 步中获取)。

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

    {
     "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 访问令牌(在第 10 步中获取)。
    • SearchApp_DisplayName 是从上一个 c网址 命令返回的显示名称。
    • "returnResultThumbnailUrls":true 可启用缩略图。

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

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

访问缩略图

如需访问云端硬盘中的 Google Workspace 文件的缩略图,用户或应用必须传递其用于访问 Google 云端硬盘中的该项的同一帐号凭据。