Des miniatures sont affichées pour les documents renvoyés par les résultats de recherche. Les miniatures permettent à l'utilisateur de mieux identifier la pertinence des documents renvoyés. Les miniatures présentent les caractéristiques suivantes :
- Largeur de 1 024 px.
- L'URL des miniatures de fichiers Google Workspace est protégée par une liste de contrôle d'accès. L'URL des autres types de fichiers n'est pas protégée par une LCA.
- Les URL expirent au bout de cinq minutes.
- Les miniatures ne sont pas générées pour les fichiers de plus de 50 Mo.
- Si une vignette ne peut pas être générée, une icône de remplacement est utilisée. Si une vignette ne peut pas être générée pour un élément Google Workspace, l'URL de la vignette renvoie "404 Not Found". Votre application doit gérer ce comportement.
Des miniatures sont automatiquement créées pour les fichiers Google Drive qui les prennent en charge de manière native, comme les types de documents Google Workspace (Docs, Sheets, Slides, etc.). En outre, Cloud Search crée automatiquement des miniatures pour les types de fichiers suivants :
- Microsoft Word (.doc)
- Microsoft Word (.docx)
- Microsoft Excel (XLS)
- Microsoft Excel (.xlsx)
- Microsoft PowerPoint (.ppt)
- Microsoft PowerPoint (PPTX)
- Adobe Portable Document Format (PDF)
- Format texte enrichi (RTF)
- Format texte (TXT)
- Hypertext Markup Language (HTML)
- Extensible Markup Language (XML)
Les miniatures ne sont renvoyées que pour les éléments dont la source de données et les applications de recherche les ont activées.
Activer les URL de miniatures pour une source de données
Votre projet Cloud Search Platform contient les identifiants du compte de service. Toutefois, pour activer les URL de miniatures, vous devez créer une clé API et des identifiants d'application Web, puis utiliser ces identifiants pour obtenir un jeton d'accès. Enfin, vous utilisez ces identifiants pour obtenir et mettre à jour une source de données.
- Si vous ne l'avez pas déjà fait, créez ou sélectionnez un projet pour votre application, puis activez l'API. Pour en savoir plus sur ces deux étapes, consultez les étapes 1 et 2 de Configurer l'accès à l'API Google Cloud Search.
- Créez une clé API :
- Dans la console Google Cloud, cliquez sur la liste déroulante "Créer des identifiants", puis sélectionnez "Clé API". La page "Clé API créée" s'affiche.
- Notez la clé API.
- Cliquez sur "Fermer". Les identifiants que vous venez de créer s'affichent sous "Clés API".
- Créez des identifiants d'application Web. Utilisez
https://developers.google.com/oauthplayground
comme URI de redirection. . Pour savoir comment créer ces identifiants, consultez Créer des identifiants d'application Web (JavaScript côté client). - Dans OAuth 2.0 Playground, cliquez sur Configuration OAuth 2.0 .
- Cochez la case Utiliser vos propres identifiants.
- Saisissez l'ID client et le code secret client générés à l'étape 3.
- Dans le champ "Champs d'application", saisissez
https://www.googleapis.com/auth/cloud_search.settings
, puis cliquez sur le bouton Authorize APIs (Autoriser les API). - (Facultatif) Si un écran de connexion s'affiche, sélectionnez le compte à utiliser.
- (Facultatif) Si un écran d'autorisation s'affiche, cliquez sur Accepter.
- Cliquez sur Exchange authorization code for tokens (Échanger le code d'autorisation contre des jetons). Un jeton est renvoyé.
- Identifiez la source de données pour laquelle vous souhaitez activer les commandes de miniatures.
Appelez
settings.datasources.get
pour obtenir l'ID de la source de données :curl 'https://cloudsearch.googleapis.com/v1/settings/datasource_id?key=[YOUR_API_KEY]' \ --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]'\ --header 'Accept: application/json' \ --compressed
Où :
- datasource_id est le nom de la source de données à récupérer.
YOUR_API_KEY
correspond à la clé API de votre projet (obtenue à l'étape 2).YOUR_ACCESS_TOKEN
est le jeton d'accès OAuth 2.0 pour votre projet (obtenu à l'étape 10).
Le résultat de cette commande en cas de succès ressemble à ceci :
{ "source": { "name": "datasources/datasource_id", "displayName": "DataSource_Display_Name", "itemsVisibility": [ { "gsuiteDomain": true } ] } }
Appelez
setting.datasource.update
avecreturnThumbnailUrls
défini surtrue
pour activer les URL de miniatures pour la source de données :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
Où :
- datasource_id correspond à l'ID de la source de données à récupérer.
YOUR_API_KEY
correspond à la clé API de votre projet (obtenue à l'étape 2).YOUR_ACCESS_TOKEN
est le jeton d'accès OAuth 2.0 pour votre projet (obtenu à l'étape 10).DataSource_DisplayName
correspond au nom à afficher renvoyé par la commande cURL précédente."returnThumbnailsUrls":true
active les miniatures.
Le résultat de cette commande en cas de succès ressemble à ceci :
{ "source": { "name": "datasources/datasource_id", "displayName": "DataSource_Display_Name", "itemsVisibility": [ { "gsuiteDomain": true } ], "returnThumbnailUrls": true } }
Activer les URL de miniatures pour une application de recherche
Votre projet Cloud Search Platform contient les identifiants du compte de service. Toutefois, pour activer les URL de miniatures, vous devez créer une clé API et des identifiants d'application Web, puis utiliser ces identifiants pour obtenir un jeton d'accès. Enfin, vous utilisez ces identifiants pour obtenir et mettre à jour une application de recherche.
- Si vous ne l'avez pas déjà fait, créez ou sélectionnez un projet pour votre application, puis activez l'API. Pour en savoir plus sur ces deux étapes, consultez les étapes 1 et 2 de Configurer l'accès à l'API Google Cloud Search.
- Créez une clé API :
- Dans la console cloud, cliquez sur la liste déroulante "Créer des identifiants", puis sélectionnez "Clé API". La page "Clé API créée" s'affiche.
- Notez la clé API.
- Cliquez sur "Fermer". Les identifiants que vous venez de créer s'affichent sous "Clés API".
- Créez des identifiants d'application Web. Utilisez
https://developers.google.com/oauthplayground
comme URI de redirection. . Pour savoir comment créer ces identifiants, consultez Créer des identifiants d'application Web (JavaScript côté client). - Dans OAuth 2.0 Playground, cliquez sur Configuration OAuth 2.0 .
- Cochez la case Utiliser vos propres identifiants.
- Saisissez l'ID client et le code secret client générés à l'étape 3.
- Dans le champ "Champs d'application", saisissez
https://www.googleapis.com/auth/cloud_search.settings
, puis cliquez sur le bouton Authorize APIs (Autoriser les API). - (Facultatif) Si un écran de connexion s'affiche, sélectionnez le compte à utiliser.
- (Facultatif) Si un écran d'autorisation s'affiche, cliquez sur Accepter.
- Cliquez sur Exchange authorization code for tokens (Échanger le code d'autorisation contre des jetons). Un jeton est renvoyé.
- Identifiez l'application de recherche pour laquelle vous souhaitez activer les commandes de miniatures.
Appelez
settings.searchapplications.get
pour obtenir l'ID de l'application de recherche :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
Où :
correspond à l'ID de l'application de recherche à récupérer. YOUR_API_KEY
correspond à la clé API de votre projet (obtenue à l'étape 2).YOUR_ACCESS_TOKEN
est le jeton d'accès OAuth 2.0 pour votre projet (obtenu à l'étape 10).
Le résultat de cette commande en cas de succès ressemble à ceci :
{ "name": "searchapplications/search_application_id", "displayName": "SearchApp_Display_Name", "dataSourceRestrictions": [ { "source": { "name": "datasources/datasource_id" } } ] }
Appelez
setting.searchapplications.update
avecreturnResultThumbnailUrls
défini surtrue
pour activer les URL de miniatures pour l'application de recherche :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
Où :
correspond à l'ID de l'application de recherche à récupérer. YOUR_API_KEY
correspond à la clé API de votre projet (obtenue à l'étape 2).YOUR_ACCESS_TOKEN
est le jeton d'accès OAuth 2.0 pour votre projet (obtenu à l'étape 10).SearchApp_DisplayName
correspond au nom à afficher renvoyé par la commande cURL précédente."returnResultThumbnailUrls":true
active les miniatures.
Le résultat de cette commande en cas de succès ressemble à ceci :
{ "name": "searchapplications/search_application_id", "displayName": "SearchApp_Display_Name", "dataSourceRestrictions": [ { "source": { "name": "datasources/datasource_id" } } ], "returnResultThumbnailUrls": true }
Accéder aux miniatures
Pour accéder à la miniature d'un fichier Google Workspace dans Drive, l'utilisateur ou l'application doit transmettre les mêmes identifiants de compte que ceux qu'il utilise pour accéder à l'élément dans Google Drive.