Ativar miniaturas

As miniaturas dos documentos retornados pelos resultados da pesquisa são exibidas. As miniaturas permitem que o usuário identifique melhor a relevância dos documentos retornados. As miniaturas têm as seguintes características:

  • Largura de 1.024 pixels.
  • O URL das miniaturas dos arquivos do Google Workspace é protegido por ACL. O URL de outros tipos de arquivo não é protegido pela ACL.
  • Os URLs expiram após 5 minutos.
  • Não são geradas miniaturas para arquivos com mais de 50 MB.
  • Se não for possível gerar uma miniatura, um ícone de marcador será usado. Se não for possível gerar uma miniatura para um item do Google Workspace, o URL da miniatura retornará "404 Not Found". Seu aplicativo deve lidar com esse comportamento.

As miniaturas são criadas automaticamente para arquivos do Google Drive que naturalmente oferecem suporte a miniaturas, como os tipos de documentos do Google Workspace (Documentos, Planilhas, Apresentações e assim por diante). Além disso, o Cloud Search cria automaticamente miniaturas para os seguintes tipos de arquivo:

  • Microsoft Word (DOC)
  • Microsoft Word (DOCX)
  • Microsoft Excel (XLS)
  • Microsoft Excel (XLSX)
  • Microsoft PowerPoint (PPT)
  • Microsoft PowerPoint (PPTX)
  • Formato de documento portátil da Adobe (PDF)
  • Rich Text Format (RTF)
  • Formato de texto (TXT)
  • Linguagem de marcação de hipertexto (HTML)
  • Linguagem de marcação extensível (XML)

As miniaturas só são retornadas para itens com fontes de dados e aplicativos de pesquisa ativados.

Ativar URLs de miniaturas para uma fonte de dados

O projeto da plataforma do Cloud Search contém credenciais da conta de serviço. No entanto, para ativar URLs em miniatura, você precisa criar uma chave de API e credenciais de aplicativo da Web e usar essas credenciais para receber um token de acesso. Por fim, use essas credenciais para receber e atualizar uma fonte de dados.

  1. Crie ou selecione um projeto para o app e ative a API, caso ainda não tenha feito isso. Para informações sobre essas duas etapas, consulte as etapas 1 e 2 de Configurar o acesso à API Google Cloud Search.
  2. Crie uma chave de API:
    1. No console do Google Cloud, clique na lista suspensa "Criar credenciais" e selecione "Chave de API". A página "Chave de API criada" será exibida.
    2. Anote a chave de API.
    3. Clique em "Fechar". A credencial recém-criada aparece em "Chaves de API".
  3. Criar credenciais de aplicativos da Web. Use https://developers.google.com/oauthplayground como o URI de redirecionamento. . Para saber as etapas de criação dessas credenciais, consulte Criar credenciais de aplicativos da Web (JavaScript do lado do cliente).
  4. No OAuth 2.0 Playground, clique em Configuração do OAuth 2.0 .
  5. Marque a opção Usar suas próprias credenciais.
  6. Insira o ID e a chave secreta do cliente gerados na etapa 3.
  7. No campo de escopos, digite https://www.googleapis.com/auth/cloud_search.settings e clique em Autorizar APIs.
  8. (Opcional) Se a tela de login for exibida, selecione a conta a ser usada.
  9. (Opcional) Se uma tela de autorização for exibida, clique em Aceitar.
  10. Clique em Trocar código de autorização dos tokens. Um token é retornado.
  11. Identifique a fonte de dados em que você quer ativar os controles de miniaturas.
  12. Chame settings.datasources.get para receber o ID da fonte de dados:

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

    Em que:

    • datasource_id é o nome da fonte de dados a ser recuperada.
    • YOUR_API_KEY é a chave de API do projeto (disponível na etapa 2).
    • YOUR_ACCESS_TOKEN é o token de acesso do OAuth 2.0 para seu projeto (recebido na etapa 10).

    O resultado bem-sucedido desse comando é semelhante a:

    {
     "source": {
       "name": "datasources/datasource_id",
       "displayName": "DataSource_Display_Name",
       "itemsVisibility": [
         {
           "gsuiteDomain": true
         }
       ]
     }
    }
    
  13. Chame setting.datasource.update com returnThumbnailUrls definido como true para ativar os URLs de miniatura da fonte de dados:

    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
    

    Em que:

    • datasource_id é o ID da fonte de dados a ser recuperada.
    • YOUR_API_KEY é a chave de API do projeto (disponível na etapa 2).
    • YOUR_ACCESS_TOKEN é o token de acesso do OAuth 2.0 para seu projeto (recebido na etapa 10).
    • DataSource_DisplayName é o nome de exibição retornado do comando cURL anterior.
    • "returnThumbnailsUrls":true ativa as miniaturas.

    O resultado bem-sucedido desse comando é semelhante a:

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

Ativar URLs de miniaturas para um app de pesquisa

O projeto da plataforma do Cloud Search contém credenciais da conta de serviço. No entanto, para ativar URLs em miniatura, você precisa criar uma chave de API e credenciais de aplicativo da Web e usar essas credenciais para receber um token de acesso. Por fim, use essas credenciais para receber e atualizar um app de pesquisa.

  1. Crie ou selecione um projeto para o app e ative a API, caso ainda não tenha feito isso. Para informações sobre essas duas etapas, consulte as etapas 1 e 2 de Configurar o acesso à API Google Cloud Search.
  2. Crie uma chave de API:
    1. No Console do Cloud, clique na lista suspensa "Criar credenciais" e selecione "Chave de API". A página "Chave de API criada" será exibida.
    2. Anote a chave de API.
    3. Clique em "Fechar". A credencial recém-criada aparece em "Chaves de API".
  3. Criar credenciais de aplicativos da Web. Use https://developers.google.com/oauthplayground como o URI de redirecionamento. . Para saber as etapas de criação dessas credenciais, consulte Criar credenciais de aplicativos da Web (JavaScript do lado do cliente).
  4. No OAuth 2.0 Playground, clique em Configuração do OAuth 2.0 .
  5. Marque a opção Usar suas próprias credenciais.
  6. Insira o ID e a chave secreta do cliente gerados na etapa 3.
  7. No campo de escopos, digite https://www.googleapis.com/auth/cloud_search.settings e clique em Autorizar APIs.
  8. (Opcional) Se a tela de login for exibida, selecione a conta a ser usada.
  9. (Opcional) Se uma tela de autorização for exibida, clique em Aceitar.
  10. Clique em Trocar código de autorização dos tokens. Um token é retornado.
  11. Identifique o app de pesquisa em que você quer ativar os controles de miniaturas.
  12. Chame settings.searchapplications.get para receber o ID do app de pesquisa:

    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
    

    Em que:

    • é o ID do app de pesquisa a ser recuperado.
    • YOUR_API_KEY é a chave de API do projeto (disponível na etapa 2).
    • YOUR_ACCESS_TOKEN é o token de acesso do OAuth 2.0 para seu projeto (recebido na etapa 10).

    O resultado bem-sucedido desse comando é semelhante a:

    {
     "name": "searchapplications/search_application_id",
     "displayName": "SearchApp_Display_Name",
     "dataSourceRestrictions": [
       {
         "source": {
           "name": "datasources/datasource_id"
         }
       }
     ]
    }
    
  13. Chame setting.searchapplications.update com returnResultThumbnailUrls definido como true para ativar URLs de miniaturas para o app de pesquisa:

    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
    

    Em que:

    • é o ID do app de pesquisa a ser recuperado.
    • YOUR_API_KEY é a chave de API do projeto (disponível na etapa 2).
    • YOUR_ACCESS_TOKEN é o token de acesso do OAuth 2.0 para seu projeto (recebido na etapa 10).
    • SearchApp_DisplayName é o nome de exibição retornado do comando cURL anterior.
    • "returnResultThumbnailUrls":true ativa as miniaturas.

    O resultado bem-sucedido desse comando é semelhante a:

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

Acessar miniaturas

Para acessar uma miniatura de um arquivo do Google Workspace no Drive, o usuário ou aplicativo precisa transmitir as mesmas credenciais de conta usadas para acessar o item no Google Drive.