Ativar miniaturas

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

  • Largura de 1.024 px.
  • O URL das miniaturas de arquivo do Google Workspace é protegido pela ACL. O URL de outros tipos de arquivo não sejam protegidos pela ACL
  • Os URLs expiram após cinco minutos.
  • As miniaturas não são geradas para arquivos com mais de 50 MB.
  • Se não for possível gerar uma miniatura, um ícone de marcador de posição será usado. Se uma miniatura para um item do Google Workspace não puder ser gerado, o URL da miniatura retornará "404 Não encontrado." Seu aplicativo precisa lidar com esse comportamento.

Miniaturas são criadas automaticamente para arquivos do Google Drive que naturalmente oferecer suporte a miniaturas, como tipos de documentos do Google Workspace (Documentos, Planilhas, Slides etc). Além disso, o Cloud Search cria miniaturas automaticamente 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 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 origem de dados e apps de pesquisa ativá-los.

Ativar URLs de miniatura para uma fonte de dados

Seu projeto de plataforma do Cloud Search contém as credenciais da conta de serviço. No entanto, para habilitar URLs de miniatura, você deve criar um Chave de API e credenciais de aplicativos da Web e de aplicativos da Web para receber um token de acesso. Por fim, use essas credenciais para receber e atualizar uma fonte de dados.

  1. Caso ainda não tenha feito isso, crie ou selecione um projeto para seu app e ative a API. Para informações sobre essas duas etapas, consulte as etapas 1 e 2 do 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 a chave de API. A "Chave de API criada" é 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. Usar o https://developers.google.com/oauthplayground como o URI de redirecionamento. . Para acessar as etapas de criação dessas credenciais, consulte Crie 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 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 uma 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 para a qual você quer ativar a miniatura. controles de segurança.
  12. Chamar settings.datasources.get para conseguir 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, recebida na etapa 2.
    • YOUR_ACCESS_TOKEN é o token de acesso do OAuth 2.0 para seu projeto (recebido da etapa 10).

    O resultado bem-sucedido desse comando é semelhante a este:

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

    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, recebida na etapa 2.
    • YOUR_ACCESS_TOKEN é o token de acesso do OAuth 2.0 para seu projeto (recebido da etapa 10).
    • DataSource_DisplayName é o nome de exibição retornado da chave anterior. comando cURL.
    • O "returnThumbnailsUrls":true ativa miniaturas.

    O resultado bem-sucedido desse comando é semelhante a este:

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

Ativar URLs de miniatura para um app de pesquisa

Seu projeto de plataforma do Cloud Search contém as credenciais da conta de serviço. No entanto, para habilitar URLs de miniatura, você deve criar um Chave de API e credenciais de aplicativos da Web e de aplicativos da Web para receber um token de acesso. Por fim, use essas credenciais para receber e atualizar um app de pesquisa.

  1. Caso ainda não tenha feito isso, crie ou selecione um projeto para seu app e ative a API. Para informações sobre essas duas etapas, consulte as etapas 1 e 2 do 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 a chave de API. A "Chave de API criada" é 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. Usar o https://developers.google.com/oauthplayground como o URI de redirecionamento. . Para acessar as etapas de criação dessas credenciais, consulte Crie 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 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 uma 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 para o qual você quer ativar os controles de miniatura.
  12. Chamar settings.searchapplications.get para conseguir 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, recebida na etapa 2.
    • YOUR_ACCESS_TOKEN é o token de acesso do OAuth 2.0 para seu projeto (recebido da etapa 10).

    O resultado bem-sucedido desse comando é semelhante a este:

    {
     "name": "searchapplications/search_application_id",
     "displayName": "SearchApp_Display_Name",
     "dataSourceRestrictions": [
       {
         "source": {
           "name": "datasources/datasource_id"
         }
       }
     ]
    }
    
  13. Chamar setting.searchapplications.update com returnResultThumbnailUrls definido como true para ativar URLs de miniatura para o aplicativo 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, recebida na etapa 2.
    • YOUR_ACCESS_TOKEN é o token de acesso do OAuth 2.0 para seu projeto (recebido da etapa 10).
    • SearchApp_DisplayName é o nome de exibição retornado da chave anterior. comando cURL.
    • O "returnResultThumbnailUrls":true ativa miniaturas.

    O resultado bem-sucedido desse comando é semelhante a este:

    {
      "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 deve passar as mesmas credenciais de conta que ele usa para acessar o item no Google Drive.