Présentation de l'API Google Docs

L'API Google Docs vous permet de créer et de modifier des documents dans Google Docs.

Les applications peuvent s'intégrer à l'API Docs pour créer des documents soignés à partir de données fournies par l'utilisateur et par le système. L'API Docs vous permet de:

  • Automatiser les processus
  • Créer des documents de manière groupée
  • Mettre en forme des documents
  • Générer des factures ou des contrats
  • Récupérer des attributs spécifiques d'objets

Voici une liste des termes courants utilisés dans l'API Docs:

Document ID (ID du document)

Identifiant unique d'un document. Il s'agit d'une chaîne particulière contenant des lettres, des chiffres et certains caractères spéciaux qui font référence à un document. Elle peut être dérivée de l'URL du document. Les ID de document sont stables, même si le nom du document change. Pour savoir comment trouver l'ID, consultez la section ID de document.

https://docs.google.com/document/d/DOCUMENT_ID/edit
Élément

Structure d'un document. Les éléments de niveau supérieur d'un document incluent Body, DocumentStyle et List.

Document Google Workspace

Fichier créé par une application Google Workspace, comme Google Docs. Le format de type MIME pour Docs est application/vnd.google-apps.document. Pour obtenir la liste des types MIME, consultez Types MIME compatibles avec Google Workspace et Google Drive.

Index

La plupart des éléments du corps du contenu comportent les propriétés startIndex et endIndex. Ils indiquent le décalage du début et de la fin d'un élément par rapport au début de son segment englobant.

Image intégrée

Image qui apparaît dans le flux de texte d'un document. Il ne s'agit pas d'une pièce jointe.

Plage nommée

Plage de texte contiguë. Un NamedRange est un ensemble de plages ayant la même namedRangeId. Les plages nommées permettent aux développeurs d'associer des parties d'un document à un libellé défini par l'utilisateur de manière arbitraire afin que leur contenu puisse être lu ou modifié par programmation ultérieurement. Un document peut contenir plusieurs plages nommées portant le même nom, mais chaque plage nommée dispose d'un ID unique.

Segment

Body, Header, Footer ou Footnote contenant des éléments structurels ou de contenu. Les index des éléments d'un segment sont relatifs au début de ce segment.

Suggestion

Modifications apportées à un document sans modifier le texte d'origine. Si le propriétaire les approuve, le texte existant est remplacé par vos suggestions.

  • Pour en savoir plus sur le développement avec les API Google Workspace, y compris sur la gestion de l'authentification et de l'autorisation, consultez Développer sur Google Workspace.

  • Pour obtenir une présentation conceptuelle d'un document, consultez la page Document.

  • Pour découvrir comment configurer et exécuter une application de l'API Docs, consultez le guide de démarrage rapide JavaScript.