As miniaturas são mostradas para 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 é protegido por ACL. O URL de outros tipos de arquivo não é protegido por ACL
- Os URLs expiram após 5 minutos.
- Miniaturas não são geradas para arquivos maiores que 50 MB.
- Se uma miniatura não puder ser gerada, 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 aplicativo precisa lidar com esse comportamento.
As miniaturas são criadas automaticamente para arquivos do Google Drive que naturalmente aceitam miniaturas, como tipos de documentos do Google Workspace (Documentos, Planilhas, Apresentações etc.). Além disso, o Cloud Search cria automaticamente miniaturas para os seguintes tipos de arquivos:
- 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)
- 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ó são retornadas para itens cuja fonte de dados e aplicativos de pesquisa as têm ativadas.
Ativar URLs de miniaturas para uma fonte de dados
O projeto da plataforma Cloud Search contém credenciais de conta de serviço. No entanto, para ativar os URLs de miniaturas, é necessário 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.
- Se ainda não tiver 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 de Configurar o acesso à API Google Cloud Search.
- Crie uma chave de API:
- 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.
- Anote a chave de API.
- Clique em "Fechar". A credencial recém-criada aparece em "Chaves de API".
- Crie credenciais de aplicativo da Web. Use
https://developers.google.com/oauthplayground
como o URI de redirecionamento. . Para saber como criar essas credenciais, consulte Criar credenciais de aplicativo da Web (JavaScript do lado do cliente). - No OAuth 2.0 Playground, clique em Configuração do OAuth 2.0 .
- Marque Usar minhas 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 Autorizar APIs. - (Opcional) Se uma tela de login aparecer, selecione a conta que você quer usar.
- (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 desse comando é semelhante a:
{ "source": { "name": "datasources/datasource_id", "displayName": "DataSource_Display_Name", "itemsVisibility": [ { "gsuiteDomain": true } ] } }
Chame
setting.datasource.update
comreturnThumbnailUrls
definido comotrue
para ativar os URLs de miniaturas 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 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 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 aplicativo de pesquisa
O projeto da plataforma Cloud Search contém credenciais de conta de serviço. No entanto, para ativar os URLs de miniaturas, é necessário criar uma chave de API e credenciais de aplicativo da Web e usar essas credenciais para receber um token de acesso. Por fim, você usa essas credenciais para receber e atualizar um aplicativo de pesquisa.
- Se ainda não tiver 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 de Configurar o acesso à API Google Cloud Search.
- Crie uma chave de API:
- No console do Cloud, clique na lista suspensa "Criar credenciais" e selecione "Chave de API". A página "Chave de API criada" vai aparecer.
- Anote a chave de API.
- Clique em "Fechar". A credencial recém-criada aparece em "Chaves de API".
- Crie credenciais de aplicativo da Web. Use
https://developers.google.com/oauthplayground
como o URI de redirecionamento. . Para saber como criar essas credenciais, consulte Criar credenciais de aplicativo da Web (JavaScript do lado do cliente). - No OAuth 2.0 Playground, clique em Configuração do OAuth 2.0 .
- Marque Usar minhas 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 Autorizar APIs. - (Opcional) Se uma tela de login aparecer, selecione a conta que você quer usar.
- (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 aplicativo de pesquisa em que 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 desse comando é semelhante a:
{ "name": "searchapplications/search_application_id", "displayName": "SearchApp_Display_Name", "dataSourceRestrictions": [ { "source": { "name": "datasources/datasource_id" } } ] }
Chame
setting.searchapplications.update
comreturnResultThumbnailUrls
definido comotrue
para ativar os URLs de miniaturas no 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 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.