Esta página foi traduzida pela API Cloud Translation.

Ativar miniaturas

As miniaturas são mostradas para os documentos retornados pelos resultados da pesquisa. 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 px.
O URL das miniaturas de arquivos do Google Workspace está protegido por ACL. O URL de outros tipos de arquivo não é protegido por ACL.
Os URLs expiram após 5 minutos.
As miniaturas não são geradas para arquivos maiores que 50 MB.
Se não for possível gerar uma miniatura, um ícone de marcador de posição será usado. Se não for possível gerar uma miniatura para um item do Google Workspace, o URL da miniatura vai retornar "404 Not Found". Seu app precisa lidar com esse comportamento.

As miniaturas são criadas automaticamente para arquivos do Google Drive que naturalmente oferecem suporte a miniaturas, como tipos de documentos do Google Workspace (Documentos, Planilhas, Apresentações 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)
Adobe Portable Document Format (PDF)
Formato Rich Text (RTF)
Formato de texto (TXT)
Linguagem de marcação de hipertexto (HTML)
Linguagem de marcação extensível (XML)

As miniaturas são retornadas apenas para itens com a origem de dados e os aplicativos de pesquisa ativados.

Ativar URLs de miniaturas para uma fonte de dados

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

Crie ou selecione um projeto para o app e ative a API. Para informações sobre essas duas etapas, consulte as etapas 1 e 2 de Configurar o acesso à API Google Cloud Search.
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" vai aparecer.
2. Anote a chave de API.
3. Clique em "Fechar". A credencial recém-criada aparece em "Chaves de API".
Crie credenciais de aplicativos da Web. Use https://developers.google.com/oauthplayground como o URI de redirecionamento. . Para saber como criar essas credenciais, consulte Criar credenciais de aplicativos da Web (JavaScript do lado do cliente).
No OAuth 2.0 Playground, clique em Configuração OAuth 2.0 .
Marque a opção Usar suas próprias credenciais.
Insira o ID e a chave secreta do cliente gerados na etapa 3.
No campo de escopos, digite https://www.googleapis.com/auth/cloud_search.settings e clique em Authorize APIs.
(Opcional) Se uma tela de login aparecer, selecione a conta a ser usada.
(Opcional) Se uma tela de autorização aparecer, clique em Aceitar.
Clique em Trocar código de autorização dos tokens. Um token é retornado.
Identifique a fonte de dados para a qual você quer ativar os controles de miniatura.

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 seu projeto (obtida na etapa 2).
YOUR_ACCESS_TOKEN é o token de acesso OAuth 2.0 do seu projeto (obtido na etapa 10).

O resultado bem-sucedido deste comando é semelhante a:

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

Chame setting.datasource.update com returnThumbnailUrls definido como true para ativar URLs de miniaturas para a origem 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 origem de dados a ser recuperada.
YOUR_API_KEY é a chave de API do seu projeto (obtida na etapa 2).
YOUR_ACCESS_TOKEN é o token de acesso OAuth 2.0 do seu projeto (obtido na etapa 10).
DataSource_DisplayName é o nome de exibição retornado pelo comando cURL anterior.
"returnThumbnailsUrls":true ativa as miniaturas.

O resultado bem-sucedido deste comando é semelhante a:

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

Ativar URLs de miniatura para um aplicativo de pesquisa

Seu projeto do Cloud Search Platform contém credenciais da conta de serviço. No entanto, para ativar URLs de miniaturas, você precisa criar uma chave de API e credenciais do aplicativo da Web e usar as credenciais do aplicativo da Web para receber um token de acesso. Por fim, você usa essas credenciais para receber e atualizar um aplicativo de pesquisa.

Crie ou selecione um projeto para o app e ative a API. Para informações sobre essas duas etapas, consulte as etapas 1 e 2 de Configurar o acesso à API Google Cloud Search.
Crie uma chave de API:
1. No console da nuvem, clique na lista suspensa Criar credenciais e selecione Chave de API. A página "Chave de API criada" vai aparecer.
2. Anote a chave de API.
3. Clique em "Fechar". A credencial recém-criada aparece em "Chaves de API".
Crie credenciais de aplicativos da Web. Use https://developers.google.com/oauthplayground como o URI de redirecionamento. . Para saber como criar essas credenciais, consulte Criar credenciais de aplicativos da Web (JavaScript do lado do cliente).
No OAuth 2.0 Playground, clique em Configuração OAuth 2.0 .
Marque a opção Usar suas próprias credenciais.
Insira o ID e a chave secreta do cliente gerados na etapa 3.
No campo de escopos, digite https://www.googleapis.com/auth/cloud_search.settings e clique em Authorize APIs.
(Opcional) Se uma tela de login aparecer, selecione a conta a ser usada.
(Opcional) Se uma tela de autorização aparecer, clique em Aceitar.
Clique em Trocar código de autorização dos tokens. Um token é retornado.
Identifique o app de pesquisa para o qual você quer ativar os controles de miniatura.

Chame settings.searchapplications.get para receber o ID do aplicativo 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 aplicativo de pesquisa a ser recuperado.
YOUR_API_KEY é a chave de API do seu projeto (obtida na etapa 2).
YOUR_ACCESS_TOKEN é o token de acesso OAuth 2.0 do seu projeto (obtido na etapa 10).

O resultado bem-sucedido deste comando é semelhante a:

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

Chame setting.searchapplications.update com returnResultThumbnailUrls definido como true para ativar URLs de miniaturas 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 aplicativo de pesquisa a ser recuperado.
YOUR_API_KEY é a chave de API do seu projeto (obtida na etapa 2).
YOUR_ACCESS_TOKEN é o token de acesso OAuth 2.0 do seu projeto (obtido na etapa 10).
SearchApp_DisplayName é o nome de exibição retornado pelo comando cURL anterior.
"returnResultThumbnailUrls":true ativa as miniaturas.

O resultado bem-sucedido deste 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 o aplicativo precisa transmitir as mesmas credenciais de conta usadas para acessar o item no Google Drive.