Ce document couvre des considérations importantes pour
nommer les fichiers et travailler avec
comme le texte indexable et les miniatures. Pour insérer et récupérer des fichiers, consultez
la ressource files
.
Spécifier des noms et des extensions de fichiers
Les applications doivent spécifier une extension de fichier dans la propriété de titre lorsque des fichiers sont insérés
avec l'API Google Drive. Par exemple, une opération visant à insérer un fichier JPEG doit
spécifiez "name": "cat.jpg"
dans les métadonnées.
Les réponses GET
suivantes peuvent inclure la propriété fileExtension
en lecture seule
Renseignée avec l'extension spécifiée à l'origine dans la propriété name
. Lorsqu'un
Un utilisateur de Google Drive demande à télécharger un fichier, ou lorsque le fichier est téléchargé
via le client de synchronisation, Drive crée un nom de fichier complet (avec
l'extension) en fonction du titre. Si l'extension est manquante,
Drive tente de déterminer l'extension à partir de l'extension
Type MIME.
Enregistrer le texte indexable
Drive indexe automatiquement les documents à rechercher lorsqu'ils
reconnaît le type de fichier, y compris les documents texte, les PDF, les images avec du texte et
d'autres types courants. Si votre application enregistre d'autres types de fichiers (des dessins,
vidéo et raccourcis), vous pouvez améliorer leur visibilité en fournissant
du texte indexable dans le champ contentHints.indexableText
du fichier.
Le texte indexable est indexé au format HTML. Si vous enregistrez la chaîne de texte indexable
<section attribute="value1">Here's some text</section>
, puis "Voici quelques
texte" est indexée, mais "valeur1" n'est pas le cas. Pour cette raison, l'enregistrement du code XML
n'est pas aussi utile que l'enregistrement de code HTML.
Lorsque vous spécifiez indexableText
, tenez également compte des points suivants:
- La taille maximale de
contentHints.indexableText
est de 128 Ko. - Indiquez les termes et concepts clés que les utilisateurs sont susceptibles de rechercher.
- N'essayez pas de trier le texte par ordre d'importance, car c'est ce que fait l'indexeur. efficacement pour vous.
- Votre application doit mettre à jour le texte indexable à chaque enregistrement.
- Assurez-vous que le texte est en rapport avec le contenu ou les métadonnées du fichier.
Ce dernier point peut sembler évident, mais il est important. Ce n'est pas une bonne idée de ajouter des termes de recherche courants pour forcer un fichier à apparaître dans les résultats de recherche. Ce peut frustrer les utilisateurs, et peut même les motiver à supprimer le fichier.
Importer des miniatures
Drive génère automatiquement des vignettes pour de nombreux fichiers courants tels que Google Docs, Sheets et Slides. Les vignettes permettent à l'utilisateur de mieux identifier les fichiers Drive.
Pour les types de fichiers pour lesquels Drive ne peut pas générer de vignette standard
vous pouvez fournir une vignette générée par votre application. Pendant
création ou mise à jour de fichier, importez une vignette en définissant
Champ contentHints.thumbnail
de la ressource files
.
Plus spécifiquement :
- Définissez le champ
contentHints.thumbnail.image
sur l'URL et le nom de fichier protégés. Image encodée en base64 (voir la section RFC 4648 5). - Définissez le champ
contentHints.thumbnail.mimeType
sur le type MIME approprié. pour la miniature.
Si Drive peut générer une vignette à partir du fichier, il utilise l'élément généré automatiquement et ignore ceux que vous avez éventuellement mis en ligne. Si ce n'est pas le cas générer une vignette, il utilise celle que vous fournissez.
Les miniatures doivent respecter les règles suivantes:
- Elles peuvent être importées aux formats PNG, GIF ou JPG.
- La largeur recommandée est de 1 600 pixels.
- La largeur minimale est de 220 pixels.
- La taille des fichiers ne doit pas dépasser 2 Mo.
- Ils doivent être mis à jour par votre application à chaque enregistrement.
Pour en savoir plus, consultez la ressource files
.
Récupérer des vignettes
Vous pouvez récupérer les métadonnées des fichiers Drive, y compris les vignettes.
Les informations sur la miniature sont stockées dans le champ thumbnailLink
de la
Ressource files
.
Afficher une miniature spécifique
L'exemple de code suivant montre
Requête de méthode files.get
avec
plusieurs champs en tant que paramètre de requête pour renvoyer les métadonnées thumbnailLink
pour
un fichier spécifique. Pour en savoir plus, consultez la section Renvoyer des champs spécifiques pour une
fichier.
GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=id,name,mimeType,thumbnailLink
Remplacez FILE_ID par l'fileId
du fichier que vous souhaitez
trouver.
Si elle est disponible, la requête renvoie une URL éphémère vers la vignette du fichier.
En général, le lien dure plusieurs heures. Le champ n'est renseigné que si
l'application à l'origine de la demande
peut accéder au contenu du fichier. Si le fichier n'est pas partagé
publiquement, l'URL renvoyée dans thumbnailLink
doit être extraite à l'aide d'un
demande d'identification.
Afficher une liste de vignettes
L'exemple de code suivant montre
Requête de méthode files.list
avec
plusieurs champs en tant que paramètre de requête pour renvoyer les métadonnées thumbnailLink
pour
une liste de fichiers. Pour en savoir plus, consultez la section Rechercher des fichiers et
dossiers.
GET https://www.googleapis.com/drive/v3/files/?fields=files(id,name,mimeType,thumbnailLink)
Pour limiter les résultats de recherche à un type de fichier spécifique, appliquez une chaîne de requête à définissez le type MIME. L'exemple de code suivant montre comment limiter en fichiers Google Sheets. Pour plus d'informations sur les types MIME, consultez la section Google Workspace et Google Drive acceptent le protocole MIME différents types d'appareil.
GET https://www.googleapis.com/drive/v3/files/q=mimeType='application/vnd.google-apps.spreadsheet'&fields=files(id,name,mimeType,thumbnailLink)