Habilitar miniaturas

Se muestran miniaturas de los documentos que muestran los resultados de la búsqueda. Las miniaturas permiten al usuario identificar mejor la relevancia de los documentos que se muestran. Las miniaturas tienen las siguientes características:

  • Ancho de 1,024 px.
  • La URL de las miniaturas de archivos de Google Workspace está protegida por ACL. La URL de otros tipos de archivos no está protegida por ACL
  • Las URLs vencen después de 5 minutos.
  • No se generan miniaturas para archivos de más de 50 MB.
  • Si no se puede generar una miniatura, se usa un ícono de marcador de posición. Si no se puede generar una miniatura para un elemento de Google Workspace, la URL de la miniatura muestra el mensaje “404 No se encontró”. Tu aplicación debe controlar este comportamiento.

Las miniaturas se crean automáticamente para los archivos de Google Drive que admiten miniaturas de forma nativa, como los tipos de documentos de Google Workspace (Documentos, Hojas de cálculo, Presentaciones, etcétera). Además, la Búsqueda en la nube crea miniaturas automáticamente para los siguientes tipos de archivos:

  • Microsoft Word (DOC)
  • Microsoft Word (DOCX)
  • Microsoft Excel (XLS)
  • Microsoft Excel (XLSX)
  • Microsoft PowerPoint (PPT)
  • Microsoft PowerPoint (PPTX)
  • Formato de documento portátil de Adobe (PDF)
  • Formato de texto enriquecido (RTF)
  • Formato de texto (TXT)
  • Lenguaje de marcado de hipertexto (HTML)
  • Lenguaje de marcado extensible (XML)

Las miniaturas solo se muestran para los elementos cuya fuente de datos y aplicaciones de búsqueda las tienen habilitadas.

Habilita las URLs de miniaturas para una fuente de datos

Tu proyecto de la plataforma de Cloud Search contiene credenciales de cuenta de servicio. Sin embargo, para habilitar las URLs de miniaturas, debes crear una credencial de aplicación web y una clave de API, y usar las credenciales de la aplicación web para obtener un token de acceso. Por último, usa estas credenciales para obtener y actualizar una fuente de datos.

  1. Si aún no lo hiciste, crea o selecciona un proyecto para tu app y habilita la API. Para obtener información sobre estos dos pasos, consulta los pasos 1 y 2 de Configura el acceso a la API de Google Cloud Search.
  2. Crea una clave de API:
    1. En la consola de Google Cloud, haz clic en la lista desplegable Crear credenciales y selecciona Clave de API. Aparecerá la página "Se creó la clave de API".
    2. Anota la clave de API.
    3. Haga clic en Cerrar. La credencial recién creada aparecerá en "Claves de API".
  3. Crea credenciales de aplicación web. Usa https://developers.google.com/oauthplayground como el URI de redireccionamiento. . Para conocer los pasos para crear estas credenciales, consulta Cómo crear credenciales de aplicación web (JavaScript del cliente).
  4. En OAuth 2.0 Playground, haz clic en Configuración de OAuth 2.0 .
  5. Marca la opción Usar tus propias credenciales.
  6. Ingresa el ID de cliente y el secreto del cliente que se generaron en el paso 3.
  7. En el campo de permisos, escribe https://www.googleapis.com/auth/cloud_search.settings y haz clic en Authorize APIs.
  8. Si se te presenta una pantalla de acceso, selecciona la cuenta que deseas usar (opcional).
  9. (Opcional) Si se te presenta una pantalla de autorización, haz clic en Aceptar.
  10. Haz clic en Intercambiar código de autorización por tokens. Se muestra un token.
  11. Identifica la fuente de datos para la que deseas habilitar los controles de miniaturas.
  12. Llama a settings.datasources.get para obtener el ID de la fuente de datos:

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

    Aquí:

    • datasource_id es el nombre de la fuente de datos que se recuperará.
    • YOUR_API_KEY es la clave de API de tu proyecto (obtenida en el paso 2).
    • YOUR_ACCESS_TOKEN es el token de acceso de OAuth 2.0 de tu proyecto (obtenido del paso 10).

    El resultado correcto de este comando es similar al siguiente:

    {
     "source": {
       "name": "datasources/datasource_id",
       "displayName": "DataSource_Display_Name",
       "itemsVisibility": [
         {
           "gsuiteDomain": true
         }
       ]
     }
    }
    
  13. Llama a setting.datasource.update con returnThumbnailUrls establecido en true para habilitar las URLs de miniaturas de la fuente de datos:

    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
    

    Aquí:

    • datasource_id es el ID de la fuente de datos que se recuperará.
    • YOUR_API_KEY es la clave de API de tu proyecto (obtenida en el paso 2).
    • YOUR_ACCESS_TOKEN es el token de acceso de OAuth 2.0 de tu proyecto (obtenido del paso 10).
    • DataSource_DisplayName es el nombre visible que se muestra del comando cURL anterior.
    • "returnThumbnailsUrls":true habilita las miniaturas.

    El resultado correcto de este comando es similar al siguiente:

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

Habilita las URLs de miniaturas para una aplicación de búsqueda

Tu proyecto de la plataforma de Cloud Search contiene credenciales de cuenta de servicio. Sin embargo, para habilitar las URLs de miniaturas, debes crear una credencial de aplicación web y una clave de API, y usar las credenciales de la aplicación web para obtener un token de acceso. Por último, usarás estas credenciales para obtener y actualizar una aplicación de búsqueda.

  1. Si aún no lo hiciste, crea o selecciona un proyecto para tu app y habilita la API. Para obtener información sobre estos dos pasos, consulta los pasos 1 y 2 de Configura el acceso a la API de Google Cloud Search.
  2. Crea una clave de API:
    1. En la consola de Cloud, haz clic en la lista desplegable Crear credenciales y selecciona Clave de API. Aparecerá la página "Se creó la clave de API".
    2. Anota la clave de API.
    3. Haga clic en Cerrar. La credencial recién creada aparecerá en "Claves de API".
  3. Crea credenciales de aplicación web. Usa https://developers.google.com/oauthplayground como el URI de redireccionamiento. . Para conocer los pasos para crear estas credenciales, consulta Cómo crear credenciales de aplicación web (JavaScript del cliente).
  4. En OAuth 2.0 Playground, haz clic en Configuración de OAuth 2.0 .
  5. Marca la opción Usar tus propias credenciales.
  6. Ingresa el ID de cliente y el secreto del cliente que se generaron en el paso 3.
  7. En el campo de permisos, escribe https://www.googleapis.com/auth/cloud_search.settings y haz clic en Authorize APIs.
  8. Si se te presenta una pantalla de acceso, selecciona la cuenta que deseas usar (opcional).
  9. (Opcional) Si se te presenta una pantalla de autorización, haz clic en Aceptar.
  10. Haz clic en Intercambiar código de autorización por tokens. Se muestra un token.
  11. Identifica la aplicación de búsqueda para la que deseas habilitar los controles de miniaturas.
  12. Llama a settings.searchapplications.get para obtener el ID de la aplicación de búsqueda:

    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
    

    Aquí:

    • es el ID de la aplicación de búsqueda que se recuperará.
    • YOUR_API_KEY es la clave de API de tu proyecto (obtenida en el paso 2).
    • YOUR_ACCESS_TOKEN es el token de acceso de OAuth 2.0 de tu proyecto (obtenido del paso 10).

    El resultado correcto de este comando es similar al siguiente:

    {
     "name": "searchapplications/search_application_id",
     "displayName": "SearchApp_Display_Name",
     "dataSourceRestrictions": [
       {
         "source": {
           "name": "datasources/datasource_id"
         }
       }
     ]
    }
    
  13. Llama a setting.searchapplications.update con returnResultThumbnailUrls establecido en true para habilitar las URLs de miniaturas para la aplicación de búsqueda:

    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
    

    Aquí:

    • es el ID de la aplicación de búsqueda que se recuperará.
    • YOUR_API_KEY es la clave de API de tu proyecto (obtenida en el paso 2).
    • YOUR_ACCESS_TOKEN es el token de acceso de OAuth 2.0 de tu proyecto (obtenido del paso 10).
    • SearchApp_DisplayName es el nombre visible que se muestra del comando cURL anterior.
    • "returnResultThumbnailUrls":true habilita las miniaturas.

    El resultado correcto de este comando es similar al siguiente:

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

Accede a las miniaturas

Para acceder a una miniatura de un archivo de Google Workspace en Drive, el usuario o la aplicación deben pasar las mismas credenciales de la cuenta que usan para acceder al elemento en Google Drive.