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. Avec l'API Docs, vous pouvez:

  • 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 couramment 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 du document.

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

La structure qui compose 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 (Google Docs, par exemple). Le format du 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 ont les propriétés startIndex et endIndex. Ceux-ci indiquent le décalage du début et de la fin d'un élément par rapport au début du segment qui les entoure.

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ë. Une NamedRange est un ensemble de plages ayant le même namedRangeId. Les plages nommées permettent aux développeurs d'associer des parties d'un document à un libellé arbitraire défini par l'utilisateur afin que leur contenu puisse être lu ou modifié ultérieurement par programmation. Un document peut contenir plusieurs plages nommées portant le même nom, mais chaque plage nommée possède 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 approuve vos suggestions, elles remplacent le texte d'origine.

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

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

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