Requêtes et réponses

Ce guide présente les principales méthodes de requête et de réponse qui constituent les l'API Google Docs et découvrir comment mettre à jour un document par lots.

Vous pouvez appeler l'API Google Docs à l'aide d'une requête HTTP ou d'une méthode dans une bibliothèque cliente spécifique à la langue. Ils sont globalement équivalents.

L'API Google Docs renvoie une réponse HTTP, qui inclut généralement le résultat de l'appel de la requête. Lorsque vous utilisez une bibliothèque cliente pour effectuer des requêtes, les réponses sont renvoyées de manière spécifique à la langue.

Méthodes de requête

L'API Docs est compatible avec les méthodes suivantes:

  • documents.create: créer un un document Google Docs vierge.
  • documents.get: renvoie un une instance complète du document spécifié. Vous pouvez analyser le fichier JSON renvoyé pour extraire le contenu, la mise en forme et d'autres fonctionnalités du document.
  • documents.batchUpdate: envoyer une liste de demandes de modification à appliquer de manière atomique au document ; renvoyer une liste de résultats.

Les méthodes documents.get et documents.batchUpdate nécessitent un documentId comme paramètre pour spécifier le document cible. La méthode documents.create renvoie une instance du document créé, à partir de laquelle vous pouvez lire documentId Pour plus d'informations sur documentId, consultez Document ID.

Mises à jour groupées

documents.batchUpdate prend une liste de request objets, chacun spécifiant une requête unique à exécuter. Par exemple, mettez en forme un paragraphe, puis ajouter une image intégrée. Chaque demande est validée avant d'être appliquée. sont traitées dans l'ordre dans lequel elles apparaissent dans la requête par lot.

Toutes les requêtes de la mise à jour par lot sont appliquées de manière atomique. Autrement dit, si une demande n'est pas valide, cela signifie que la mise à jour échoue entièrement et qu'aucune des erreurs dépendantes) sont appliquées.

Certaines méthodes documents.batchUpdate fournissent des réponses contenant des informations sur les demandes appliquées. Ces méthodes renvoient une réponse corps qui contient une liste de response d'objets. Les autres requêtes n'ont pas besoin de renvoyer d'informations et d'afficher répondre. Les objets de la liste de réponses occupent le même ordre d'index que le la requête correspondante.

Voici un modèle couramment utilisé pour effectuer des requêtes par lot:

requests = []
requests.append(first request)
requests.append(second request)
...

body = ... & requests & ...

...batchUpdate(body)

Pour en savoir plus, consultez les bonnes pratiques concernant les requêtes par lot. comment traiter vos appels d'API Docs par lot documents.batchUpdate documentation de référence pour les types de requêtes et de réponses.

Opérations de mise à jour par lot

Il existe différents types de requêtes de mise à jour par lot. Voici le détail des types de requêtes, regroupés dans différentes catégories.

Objet AJOUTER / INSÉRER METTRE À JOUR / REMPLACER SUPPRIMER
Texte InsertTextRequest ReplaceAllTextRequest
Styles CreateParagraphBulletsRequest UpdateTextStyleRequest
UpdateParagraphStyleRequest
UpdateTableCellStyleRequest
UpdateTableRowStyleRequest
UpdateDocumentStyleRequest
UpdateSectionStyleRequest
DeleteParagraphBulletsRequest
Plages nommées CreateNamedRangeRequest ReplaceNamedRangeContentRequest DeleteNamedRangeRequest
DeleteContentRangeRequest
Images InsertInlineImageRequest ReplaceImageRequest
Tables InsertTableRequest
InsertTableRowRequest
InsertTableColumnRequest
UpdateTableColumnPropertiesRequest
MergeTableCellsRequest
UnmergeTableCellsRequest
PinTableHeaderRowsRequest
DeleteTableRowRequest
DeleteTableColumnRequest
Objets page (y compris en-têtes et pieds de page) InsertPageBreakRequest
CreateHeaderRequest
CreateFooterRequest
CreateFootnoteRequest
InsertSectionBreakRequest
DeletePositionedObjectRequest
DeleteHeaderRequest
DeleteFooterRequest