Cette page a été traduite par l'API Cloud Translation.

Activer les miniatures

Les vignettes sont affichées pour les documents renvoyés par les résultats de recherche. Les vignettes permettent à l'utilisateur de mieux identifier la pertinence des documents renvoyés. Les miniatures présentent les caractéristiques suivantes:

Largeur de 1 024 pixels.
L'URL des vignettes des fichiers Google Workspace est protégée par une LCA. L'URL des autres types de fichiers n'est pas protégée par les LCA
Les URL expirent au bout de cinq minutes.
Les vignettes ne sont pas générées pour les fichiers de plus de 50 Mo.
Si aucune vignette ne peut être générée, une icône d'espace réservé est utilisée. Si aucune vignette ne peut ê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.

Les vignettes sont créées automatiquement pour les fichiers Google Drive qui acceptent naturellement les vignettes, comme les types de documents Google Workspace (Docs, Sheets, Slides, etc.). De plus, Cloud Search crée automatiquement des vignettes 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)
Rich Text Format (RTF)
Format texte (TXT)
Hypertext Markup Language (HTML)
XML (Extensible Markup Language)

Les vignettes ne s'affichent que pour les éléments dont la source de données et les applications de recherche les ont activées.

Activer les URL de vignettes pour une source de données

Votre projet Cloud Search Platform contient des identifiants de compte de service. Toutefois, pour activer les URL de vignettes, 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, reportez-vous aux étapes 1 et 2 de la section Configurer l'accès à l'API Google Cloud Search.
Créez une clé API :
1. 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.
2. Notez la clé API.
3. Cliquez sur "Fermer". Les identifiants nouvellement créés s'affichent sous "Clés API".
Créer des identifiants d'application Web Utilisez https://developers.google.com/oauthplayground comme URI de redirection. . Pour savoir comment créer ces identifiants, consultez la section Créer des identifiants d'application Web (JavaScript côté client).
Dans OAuth 2.0 Playground, cliquez sur OAuth 2.0 Configuration .
Cochez Utiliser vos propres identifiants.
Saisissez l'ID client et le code secret du client générés à l'étape 3.
Dans le champ des champs d'application, saisissez https://www.googleapis.com/auth/cloud_search.settings, puis cliquez sur 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 Accept (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 vignettes.

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 est 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 est semblable à ceci:

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

Appelez setting.datasource.update avec returnThumbnailUrls défini sur true afin d'activer les URL de vignettes 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 est l'ID de la source de données à récupérer.
YOUR_API_KEY est 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 est le nom à afficher renvoyé par la commande cURL précédente.
"returnThumbnailsUrls":true active les miniatures.

Le résultat de cette commande est semblable à ceci:

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

Activer les URL de vignettes pour 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, reportez-vous aux étapes 1 et 2 de la section Configurer l'accès à l'API Google Cloud Search.
Créez une clé API :
1. 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.
2. Notez la clé API.
3. Cliquez sur "Fermer". Les identifiants nouvellement créés s'affichent sous "Clés API".
Créer des identifiants d'application Web Utilisez https://developers.google.com/oauthplayground comme URI de redirection. . Pour savoir comment créer ces identifiants, consultez la section Créer des identifiants d'application Web (JavaScript côté client).
Dans OAuth 2.0 Playground, cliquez sur OAuth 2.0 Configuration .
Cochez Utiliser vos propres identifiants.
Saisissez l'ID client et le code secret du client générés à l'étape 3.
Dans le champ des champs d'application, saisissez https://www.googleapis.com/auth/cloud_search.settings, puis cliquez sur 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 Accept (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 vignettes.

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ù :

est l'ID de l'application de recherche à récupérer.
YOUR_API_KEY est 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 est semblable à ceci:

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

Appelez setting.searchapplications.update avec returnResultThumbnailUrls défini sur true afin d'activer les URL de vignettes 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ù :

est l'ID de l'application de recherche à récupérer.
YOUR_API_KEY est 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 est le nom à afficher renvoyé par la commande cURL précédente.
"returnResultThumbnailUrls":true active les miniatures.

Le résultat de cette commande est semblable à ceci:

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

Accéder aux vignettes

Pour accéder à la vignette d'un fichier Google Workspace dans Drive, l'utilisateur ou l'application doit transmettre les mêmes identifiants de compte que ceux utilisés pour accéder à l'élément dans Google Drive.