Requests

object (ReplaceAllTextRequest)

Remplace toutes les occurrences du texte spécifié.

object (InsertTextRequest)

Insère du texte à l'emplacement spécifié.

object (UpdateTextStyleRequest)

Met à jour le style de texte dans la plage spécifiée.

object (CreateParagraphBulletsRequest)

Crée des puces pour les paragraphes.

object (DeleteParagraphBulletsRequest)

Supprime les puces des paragraphes.

object (CreateNamedRangeRequest)

Crée une plage nommée.

object (DeleteNamedRangeRequest)

Supprime une plage nommée.

object (UpdateParagraphStyleRequest)

Met à jour le style de paragraphe dans la plage spécifiée.

object (DeleteContentRangeRequest)

Supprime le contenu du document.

object (InsertInlineImageRequest)

Insère une image intégrée à l'emplacement spécifié.

object (InsertTableRequest)

Insère un tableau à l'emplacement spécifié.

object (InsertTableRowRequest)

Insère une ligne vide dans un tableau.

object (InsertTableColumnRequest)

Insère une colonne vide dans un tableau.

object (DeleteTableRowRequest)

Supprime une ligne d'un tableau.

object (DeleteTableColumnRequest)

Supprime une colonne d'une table.

object (InsertPageBreakRequest)

Insère un saut de page à l'emplacement spécifié.

object (DeletePositionedObjectRequest)

Supprime un objet positionné du document.

object (UpdateTableColumnPropertiesRequest)

Met à jour les propriétés des colonnes d'un tableau.

object (UpdateTableCellStyleRequest)

Met à jour le style des cellules du tableau.

object (UpdateTableRowStyleRequest)

Met à jour le style d'une ligne dans un tableau.

object (ReplaceImageRequest)

Remplace une image dans le document.

object (UpdateDocumentStyleRequest)

Met à jour le style du document.

object (MergeTableCellsRequest)

Fusionne les cellules d'un tableau.

object (UnmergeTableCellsRequest)

Annule la fusion de cellules dans un tableau.

object (CreateHeaderRequest)

Crée un en-tête.

object (CreateFooterRequest)

Crée un pied de page.

object (CreateFootnoteRequest)

Crée une note de bas de page.

object (ReplaceNamedRangeContentRequest)

Remplace le contenu d'une plage nommée.

object (UpdateSectionStyleRequest)

Met à jour le style de section de la plage spécifiée.

object (InsertSectionBreakRequest)

Insère un saut de section à l'emplacement spécifié.

object (DeleteHeaderRequest)

Supprime un en-tête du document.

object (DeleteFooterRequest)

Supprime un pied de page du document.

object (PinTableHeaderRowsRequest)

Met à jour le nombre de lignes d'en-tête épinglées dans un tableau.

object (AddDocumentTabRequest)

Ajoute un onglet de document.

object (DeleteTabRequest)

Supprime un onglet du document.

object (UpdateDocumentTabPropertiesRequest)

Met à jour les propriétés d'un onglet de document.

object (InsertPersonRequest)

Insère une mention de personne.

object (UpdateNamedStyleRequest)

Met à jour un style nommé.

object (InsertRichLinkRequest)

Insérez un lien enrichi.

object (InsertDateRequest)

Insère une date.

object (InsertCommentRequest)

Insère un CommentThread dans le document.

object (AddCommentReplyRequest)

Ajoute une réponse à un CommentThread ou un SuggestionThread.

object (UpdateCommentPostRequest)

Met à jour un post existant (post principal ou réponse) d'un CommentThread ou d'un SuggestionThread.

object (DeleteCommentRequest)

Supprime un CommentThread.

object (DeleteCommentReplyRequest)

Supprime une réponse Post d'un CommentThread ou SuggestionThread.

object (AcceptSuggestionRequest)

Accepte une suggestion.

object (RejectSuggestionRequest)

Refuse une suggestion.

object (DeleteSuggestionRequest)

Supprime une suggestion.

string

Texte qui remplacera le texte correspondant.

object (TabsCriteria)

Facultatif. Critères utilisés pour spécifier les onglets dans lesquels le remplacement a lieu.

Si vous omettez cette option, le remplacement s'applique à tous les onglets.

Dans un document contenant un seul onglet :

• S'il est fourni, il doit correspondre à l'ID de l'onglet au singulier.

• Si elle est omise, le remplacement s'applique à l'onglet au singulier.

Dans un document contenant plusieurs onglets :

• Si elle est fournie, la substitution s'applique aux onglets spécifiés.

• Si vous l'omettez, le remplacement s'applique à tous les onglets.

object (SubstringMatchCriteria)

Recherche le texte dans le document qui correspond à cette sous-chaîne.

string

Texte à rechercher dans le document.

boolean

Indique si la recherche doit respecter la casse :

• True  : la recherche est sensible à la casse.
• False : la recherche n'est pas sensible à la casse.

boolean

Facultatif. "True" si la valeur à rechercher doit être traitée comme une expression régulière. Toutes les barres obliques inverses du modèle doivent être échappées.

• True : le texte de recherche est traité comme une expression régulière.
• False : le texte de recherche est traité comme une sous-chaîne pour la correspondance.

string

Liste des ID d'onglets dans lesquels la requête s'exécute.

string

Texte à insérer.

L'insertion d'un caractère de nouvelle ligne crée implicitement un Paragraph à cet index. Le style de paragraphe du nouveau paragraphe sera copié à partir du paragraphe à l'index d'insertion actuel, y compris les listes et les puces.

Les styles de texte pour le texte inséré seront déterminés automatiquement, en conservant généralement le style du texte voisin. Dans la plupart des cas, le style du texte inséré correspond à celui du texte qui précède immédiatement l'index d'insertion.

Certains caractères de contrôle (U+0000-U+0008, U+000C-U+001F) et les caractères de la zone à usage privé du plan multilingue de base Unicode (U+E000-U+F8FF) seront supprimés du texte inséré.

object (Location)

Insère le texte à un index spécifique du document.

Le texte doit être inséré dans les limites d'un Paragraph existant. Par exemple, il est impossible d'insérer du texte à l'index de début d'un tableau (c'est-à-dire entre le tableau et le paragraphe qui le précède). Le texte doit être inséré dans le paragraphe précédent.

object (EndOfSegmentLocation)

Insère le texte à la fin d'un en-tête, d'un pied de page, d'une note de bas de page ou du corps du document.

string

ID de l'en-tête, du pied de page ou de la note de bas de page dans lesquels se trouve l'emplacement. Un ID de segment vide désigne le corps du document.

integer

Index basé sur zéro, en unités de code UTF-16.

L'index est relatif au début du segment spécifié par segmentId.

string

Onglet dans lequel se trouve le lieu. Si elle est omise, la requête est appliquée au premier onglet.

Dans un document contenant un seul onglet :

• S'il est fourni, il doit correspondre à l'ID de l'onglet au singulier.

• En cas d'omission, la requête s'applique à l'onglet au singulier.

Dans un document contenant plusieurs onglets :

• Si elle est fournie, la demande s'applique à l'onglet spécifié.

• Si elle est omise, la requête s'applique au premier onglet du document.

string

ID de l'en-tête, du pied de page ou de la note de bas de page dans lesquels se trouve l'emplacement. Un ID de segment vide désigne le corps du document.

string

Onglet dans lequel se trouve le lieu. Si elle est omise, la requête est appliquée au premier onglet.

Dans un document contenant un seul onglet :

• S'il est fourni, il doit correspondre à l'ID de l'onglet au singulier.

• En cas d'omission, la requête s'applique à l'onglet au singulier.

Dans un document contenant plusieurs onglets :

• Si elle est fournie, la demande s'applique à l'onglet spécifié.

• Si elle est omise, la requête s'applique au premier onglet du document.

object (TextStyle)

Styles à définir sur le texte.

Si la valeur d'un style particulier correspond à celle du style parent, ce style sera défini sur "Hériter".

Certaines modifications de style de texte peuvent entraîner d'autres modifications afin de refléter le comportement de l'éditeur Docs. Pour en savoir plus, consultez la documentation de TextStyle.

string (FieldMask format)

Champs à mettre à jour.

Vous devez spécifier au moins un champ. La racine textStyle est implicite et ne doit pas être spécifiée. Un seul "*" peut être utilisé comme raccourci pour lister tous les champs.

Par exemple, pour mettre à jour le style de texte en gras, définissez fields sur "bold".

Pour rétablir la valeur par défaut d'une propriété, incluez le nom de son champ dans le masque de champ, mais laissez le champ lui-même non défini.

object (Range)

Plage de texte à mettre en forme.

La plage peut être étendue pour inclure les sauts de ligne adjacents.

Si la plage contient entièrement un paragraphe appartenant à une liste, la puce du paragraphe est également mise à jour avec le style de texte correspondant.

Les plages ne peuvent pas être insérées dans une UpdateTextStyleRequest relative.

object (Range)

Plage à laquelle appliquer le préréglage de puce.

enum (BulletGlyphPreset)

Types de glyphes de puces à utiliser.

object (Range)

Plage à partir de laquelle supprimer les puces.

string

Nom de NamedRange. Les noms n'ont pas besoin d'être uniques.

Les noms doivent comporter entre 1 et 256 caractères, mesurés en unités de code UTF-16.

object (Range)

Plage à laquelle appliquer le nom.

object (TabsCriteria)

Facultatif. Critères utilisés pour spécifier le ou les onglets dans lesquels la plage doit être supprimée. Si elle est omise, la suppression de la plage s'applique à tous les onglets.

Dans un document contenant un seul onglet :

• S'il est fourni, il doit correspondre à l'ID de l'onglet au singulier.

• Si elle est omise, la suppression de la plage s'applique à l'onglet unique.

Dans un document contenant plusieurs onglets :

• Si elle est fournie, la suppression de la plage s'applique aux onglets spécifiés.

• Si vous ne l'indiquez pas, la suppression de la plage s'applique à tous les onglets.

string

ID de la plage nommée à supprimer.

string

Nom de la ou des plages à supprimer. Toutes les plages nommées portant le nom spécifié seront supprimées.

object (ParagraphStyle)

Styles à définir sur les paragraphes.

Certaines modifications de style de paragraphe peuvent entraîner d'autres modifications afin de refléter le comportement de l'éditeur Docs. Pour en savoir plus, consultez la documentation de ParagraphStyle.

string (FieldMask format)

Champs à mettre à jour.

Vous devez spécifier au moins un champ. La racine paragraphStyle est implicite et ne doit pas être spécifiée. Un seul "*" peut être utilisé comme raccourci pour lister tous les champs.

Par exemple, pour mettre à jour la propriété d'alignement du style de paragraphe, définissez fields sur "alignment".

Pour rétablir la valeur par défaut d'une propriété, incluez le nom de son champ dans le masque de champ, mais laissez le champ lui-même non défini.

object (Range)

Plage chevauchant les paragraphes à mettre en forme.

object (Range)

Plage de contenu à supprimer.

Si vous supprimez du texte qui chevauche la limite d'un paragraphe, les styles de paragraphe, les listes, les objets positionnés et les signets peuvent être modifiés, car les deux paragraphes sont fusionnés.

Si vous tentez de supprimer certaines plages, la structure du document peut devenir non valide. Dans ce cas, une erreur 400 (requête incorrecte) est renvoyée.

Voici quelques exemples de demandes de suppression non valides :

• Suppression d'une unité de code d'une paire de substituts.
• Suppression du dernier caractère de nouvelle ligne d'un élément Body, Header, Footer, Footnote, TableCell ou TableOfContents.
• Supprimer le début ou la fin d'un élément Table, TableOfContents ou Equation sans supprimer l'intégralité de l'élément.
• Supprimer le caractère de nouvelle ligne avant un élément Table, TableOfContents ou SectionBreak sans supprimer l'élément.
• Supprimer des lignes ou des cellules individuelles d'un tableau La suppression du contenu d'une cellule de tableau est autorisée.

string

URI de l'image.

L'image est récupérée une seule fois au moment de l'insertion et une copie est stockée pour être affichée dans le document. Les images ne doivent pas dépasser 50 Mo ni 25 mégapixels, et doivent être au format PNG, JPEG ou GIF.

L'URI fourni doit être accessible au public et ne pas dépasser 2 Ko. L'URI lui-même est enregistré avec l'image et exposé via le champ ImageProperties.content_uri.

object (Size)

Taille à laquelle l'image doit apparaître dans le document. Cette propriété est facultative. La taille finale de l'image dans le document est déterminée par les règles suivantes : * Si ni la largeur ni la hauteur ne sont spécifiées, une taille par défaut de l'image est calculée en fonction de sa résolution. * Si une dimension est spécifiée, l'autre est calculée pour préserver le format de l'image. * Si la largeur et la hauteur sont spécifiées, l'image est mise à l'échelle pour s'adapter aux dimensions fournies tout en conservant son format.

object (Location)

Insère l'image à un index spécifique du document.

L'image doit être insérée dans les limites d'un Paragraph existant. Par exemple, il ne peut pas être inséré à l'index de début d'un tableau (c'est-à-dire entre le tableau et le paragraphe qui le précède).

Les images intégrées ne peuvent pas être insérées dans une note de bas de page ni dans une équation.

object (EndOfSegmentLocation)

Insère le texte à la fin d'un en-tête, d'un pied de page ou du corps du document.

Il est impossible d'insérer des images intégrées dans une note de bas de page.

integer

Nombre de lignes dans la table.

integer

Nombre de colonnes dans la table.

object (Location)

Insère la table à un index de modèle spécifique.

Un caractère de nouvelle ligne sera inséré avant le tableau inséré. L'index de début du tableau sera donc à l'index d'emplacement spécifié + 1.

La table doit être insérée dans les limites d'un Paragraph existant. Par exemple, il ne peut pas être inséré à l'index de début d'un tableau (c'est-à-dire entre un tableau existant et le paragraphe qui le précède).

Il est impossible d'insérer des tableaux dans une note de bas de page ou une équation.

object (EndOfSegmentLocation)

Insère le tableau à la fin de l'en-tête, du pied de page ou du corps du document spécifié. Un caractère de nouvelle ligne est inséré avant le tableau.

Vous ne pouvez pas insérer de tableaux dans une note de bas de page.

object (TableCellLocation)

Emplacement de la cellule de tableau de référence à partir de laquelle les lignes seront insérées.

Une nouvelle ligne est insérée au-dessus (ou en dessous) de la ligne où se trouve la cellule de référence. Si la cellule de référence est une cellule fusionnée, une nouvelle ligne est insérée au-dessus (ou en dessous) de la cellule fusionnée.

boolean

Indique si une nouvelle ligne doit être insérée sous l'emplacement de la cellule de référence.

• True  : insérer sous la cellule.
• False : insérer au-dessus de la cellule.

object (Location)

Emplacement de début du tableau dans le document.

integer

Index de ligne basé sur zéro. Par exemple, la deuxième ligne du tableau a un index de ligne de 1.

integer

Index de colonne basé sur zéro. Par exemple, la deuxième colonne du tableau a un index de colonne de 1.

object (TableCellLocation)

Emplacement de la cellule de référence à partir de laquelle les colonnes seront insérées.

Une nouvelle colonne est insérée à gauche (ou à droite) de la colonne où se trouve la cellule de référence. Si la cellule de référence est une cellule fusionnée, une nouvelle colonne est insérée à gauche (ou à droite) de la cellule fusionnée.

boolean

Indique s'il faut insérer une colonne à droite de l'emplacement de la cellule de référence.

• True  : insérer à droite.
• False  : insérer à gauche.

object (TableCellLocation)

Emplacement de la cellule de référence à partir de laquelle la ligne sera supprimée.

La ligne sur laquelle cette cellule s'étend sera supprimée. S'il s'agit d'une cellule fusionnée qui s'étend sur plusieurs lignes, toutes les lignes sur lesquelles la cellule s'étend seront supprimées. Si aucune ligne ne reste dans la table après cette suppression, la table entière est supprimée.

object (TableCellLocation)

Emplacement de la cellule de la table de référence à partir de laquelle la colonne sera supprimée.

La colonne sur laquelle cette cellule s'étend sera supprimée. S'il s'agit d'une cellule fusionnée qui s'étend sur plusieurs colonnes, toutes les colonnes sur lesquelles la cellule s'étend seront supprimées. Si aucune colonne ne reste dans le tableau après cette suppression, l'ensemble du tableau est supprimé.

object (Location)

Insère le saut de page à un index spécifique du document.

Le saut de page doit être inséré dans les limites d'un Paragraph existant. Par exemple, il ne peut pas être inséré à l'index de début d'un tableau (c'est-à-dire entre le tableau et le paragraphe qui le précède).

Les sauts de page ne peuvent pas être insérés dans un tableau, une équation, une note de bas de page, un en-tête ou un pied de page. Étant donné que les sauts de page ne peuvent être insérés que dans le corps, le champ segment ID doit être vide.

object (EndOfSegmentLocation)

Insère le saut de page à la fin du corps du document.

Les sauts de page ne peuvent pas être insérés dans une note de bas de page, un en-tête ou un pied de page. Étant donné que les sauts de page ne peuvent être insérés que dans le corps, le champ segment ID doit être vide.

string

ID de l'objet positionné à supprimer.

string

Onglet dans lequel se trouve l'objet positionné à supprimer. Si elle est omise, la requête est appliquée au premier onglet.

Dans un document contenant un seul onglet :

• S'il est fourni, il doit correspondre à l'ID de l'onglet au singulier.

• En cas d'omission, la requête s'applique à l'onglet au singulier.

Dans un document contenant plusieurs onglets :

• Si elle est fournie, la demande s'applique à l'onglet spécifié.

• Si elle est omise, la requête s'applique au premier onglet du document.

object (Location)

Emplacement de début du tableau dans le document.

integer

Liste des index de colonnes (basés sur zéro) dont la propriété doit être mise à jour. Si aucun index n'est spécifié, toutes les colonnes seront mises à jour.

object (TableColumnProperties)

Propriétés de la colonne du tableau à mettre à jour.

Si la valeur de tableColumnProperties#width est inférieure à 5 points (5/72 pouce), une erreur 400 (requête incorrecte) est renvoyée.

string (FieldMask format)

Champs à mettre à jour.

Vous devez spécifier au moins un champ. La racine tableColumnProperties est implicite et ne doit pas être spécifiée. Un seul "*" peut être utilisé comme raccourci pour lister tous les champs.

Par exemple, pour mettre à jour la largeur de la colonne, définissez fields sur "width".

object (TableCellStyle)

Style à définir sur les cellules du tableau.

Lorsque vous modifiez les bordures, si une cellule partage une bordure avec une cellule adjacente, la propriété de bordure correspondante de la cellule adjacente est également modifiée. Les bordures fusionnées et invisibles ne sont pas mises à jour.

Étant donné que la mise à jour d'une bordure partagée par des cellules adjacentes dans la même requête peut entraîner des mises à jour de bordure conflictuelles, les mises à jour de bordure sont appliquées dans l'ordre suivant :

• borderRight
• borderLeft
• borderBottom
• borderTop

string (FieldMask format)

Champs à mettre à jour.

Vous devez spécifier au moins un champ. La racine tableCellStyle est implicite et ne doit pas être spécifiée. Un seul "*" peut être utilisé comme raccourci pour lister tous les champs.

Par exemple, pour mettre à jour la couleur d'arrière-plan de la cellule du tableau, définissez fields sur "backgroundColor".

Pour rétablir la valeur par défaut d'une propriété, incluez le nom de son champ dans le masque de champ, mais laissez le champ lui-même non défini.

object (TableRange)

Plage de tableau représentant le sous-ensemble du tableau auquel les modifications sont appliquées.

object (Location)

Emplacement de début du tableau dans le document. Lorsqu'elles sont spécifiées, les mises à jour sont appliquées à toutes les cellules du tableau.

object (TableCellLocation)

Emplacement de la cellule où commence la plage du tableau.

integer

Étendue de ligne de la plage de tableau.

integer

Étendue de colonne de la plage de tableau.

object (Location)

Emplacement de début du tableau dans le document.

integer

Liste des index de ligne (basés sur zéro) dont le style doit être mis à jour. Si aucun index n'est spécifié, toutes les lignes seront mises à jour.

object (TableRowStyle)

Styles à définir sur les lignes.

string (FieldMask format)

Champs à mettre à jour.

Vous devez spécifier au moins un champ. La racine tableRowStyle est implicite et ne doit pas être spécifiée. Un seul "*" peut être utilisé comme raccourci pour lister tous les champs.

Par exemple, pour mettre à jour la hauteur de ligne minimale, définissez fields sur "minRowHeight".

string

ID de l'image existante qui sera remplacée. L'ID peut être récupéré à partir de la réponse d'une requête GET.

string

URI de la nouvelle image.

L'image est récupérée une seule fois au moment de l'insertion et une copie est stockée pour être affichée dans le document. Les images doivent être au format PNG, JPEG ou GIF, ne pas dépasser 50 Mo et ne pas dépasser 25 mégapixels.

L'URI fourni ne peut pas dépasser 2 Ko. L'URI est enregistré avec l'image et exposé via le champ ImageProperties.source_uri.

enum (ImageReplaceMethod)

Méthode de remplacement.

string

Onglet dans lequel se trouve l'image à remplacer. Si elle est omise, la requête est appliquée au premier onglet.

Dans un document contenant un seul onglet :

• S'il est fourni, il doit correspondre à l'ID de l'onglet au singulier.

• En cas d'omission, la requête s'applique à l'onglet au singulier.

Dans un document contenant plusieurs onglets :

• Si elle est fournie, la demande s'applique à l'onglet spécifié.

• Si elle est omise, la requête s'applique au premier onglet du document.

object (DocumentStyle)

Styles à définir dans le document.

Certaines modifications de style apportées à un document peuvent entraîner d'autres modifications afin de refléter le comportement de l'éditeur Docs. Pour en savoir plus, consultez la documentation de DocumentStyle.

string (FieldMask format)

Champs à mettre à jour.

Vous devez spécifier au moins un champ. La racine documentStyle est implicite et ne doit pas être spécifiée. Un seul "*" peut être utilisé comme raccourci pour lister tous les champs.

Par exemple, pour mettre à jour l'arrière-plan, définissez fields sur "background".

string

Onglet contenant le style à modifier. Si elle est omise, la requête s'applique au premier onglet.

Dans un document contenant un seul onglet :

• S'il est fourni, il doit correspondre à l'ID de l'onglet au singulier.

• En cas d'omission, la requête s'applique à l'onglet au singulier.

Dans un document contenant plusieurs onglets :

• Si elle est fournie, la demande s'applique à l'onglet spécifié.

• Si aucune valeur n'est fournie, la requête s'applique au premier onglet du document.

object (TableRange)

Plage de tableau spécifiant les cellules du tableau à fusionner.

Tout texte contenu dans les cellules fusionnées sera concaténé et stocké dans la cellule "tête" de la plage. Il s'agit de la cellule en haut à gauche de la plage lorsque le contenu est orienté de gauche à droite, et de la cellule en haut à droite de la plage dans le cas contraire.

Si la plage n'est pas rectangulaire (ce qui peut se produire dans certains cas où la plage couvre des cellules déjà fusionnées ou lorsque le tableau n'est pas rectangulaire), une erreur 400 Bad Request est renvoyée.

object (TableRange)

Plage de tableau spécifiant les cellules du tableau à dissocier.

Toutes les cellules fusionnées de cette plage seront séparées, et les cellules déjà séparées ne seront pas affectées. Si la plage ne comporte aucune cellule fusionnée, la requête n'aura aucun effet.

Si l'une des cellules fusionnées contient du texte, celui-ci restera dans la cellule "de tête" du bloc de cellules non fusionnées obtenu. La cellule "head" (tête) est la cellule en haut à gauche lorsque le contenu est orienté de gauche à droite, et en haut à droite dans le cas contraire.

enum (HeaderFooterType)

Type d'en-tête à créer.

object (Location)

Emplacement de la SectionBreak qui commence la section à laquelle cet en-tête doit appartenir. Si "sectionBreakLocation" n'est pas défini ou s'il fait référence au premier saut de section dans le corps du document, l'en-tête s'applique à la DocumentStyle.

enum (HeaderFooterType)

Type de pied de page à créer.

object (Location)

Emplacement de SectionBreak immédiatement avant la section à laquelle SectionStyle de ce pied de page doit appartenir. Si cette option n'est pas définie ou fait référence au premier saut de section du document, le pied de page s'applique au style du document.

object (Location)

Insère la référence de la note de bas de page à un index spécifique dans le document.

La référence de note de bas de page doit être insérée dans les limites d'un Paragraph existant. Par exemple, il ne peut pas être inséré à l'index de début d'un tableau (c'est-à-dire entre le tableau et le paragraphe qui le précède).

Les références à des notes de bas de page ne peuvent pas être insérées dans une équation, un en-tête, un pied de page ni une note de bas de page. Étant donné que les références de notes de bas de page ne peuvent être insérées que dans le corps du texte, le champ segment ID doit être vide.

object (EndOfSegmentLocation)

Insère la référence de la note de bas de page à la fin du corps du document.

Les références à des notes de bas de page ne peuvent pas être insérées dans un en-tête, un pied de page ni une note de bas de page. Étant donné que les références de notes de bas de page ne peuvent être insérées que dans le corps du texte, le champ segment ID doit être vide.

object (TabsCriteria)

Facultatif. Critères utilisés pour spécifier les onglets dans lesquels le remplacement a lieu. Si vous omettez cette option, le remplacement s'applique à tous les onglets.

Dans un document contenant un seul onglet :

• S'il est fourni, il doit correspondre à l'ID de l'onglet au singulier.

• Si elle est omise, le remplacement s'applique à l'onglet au singulier.

Dans un document contenant plusieurs onglets :

• Si elle est fournie, la substitution s'applique aux onglets spécifiés.

• Si vous l'omettez, le remplacement s'applique à tous les onglets.

string

Remplace le contenu de la ou des plages nommées spécifiées par le texte donné.

string

ID de la plage nommée dont le contenu sera remplacé.

Si aucune plage nommée ne correspond à l'ID indiqué, une erreur 400 (requête incorrecte) est renvoyée.

string

Nom du NamedRanges dont le contenu sera remplacé.

S'il existe plusieurs named ranges portant le nom indiqué, le contenu de chacun d'eux sera remplacé. Si aucune plage nommée ne porte le nom indiqué, la requête sera sans effet.

object (Range)

Plage chevauchant les sections à mettre en forme.

Comme les sauts de section ne peuvent être insérés que dans le corps, le champ segment ID doit être vide.

object (SectionStyle)

Styles à définir sur la section.

Certaines modifications de style de section peuvent entraîner d'autres modifications afin de refléter le comportement de l'éditeur Docs. Pour en savoir plus, consultez la documentation de SectionStyle.

string (FieldMask format)

Champs à mettre à jour.

Vous devez spécifier au moins un champ. La racine sectionStyle est implicite et ne doit pas être spécifiée. Un seul "*" peut être utilisé comme raccourci pour lister tous les champs.

Par exemple, pour mettre à jour la marge de gauche, définissez fields sur "marginLeft".

enum (SectionType)

Type de section à insérer.

object (Location)

Insère un saut de ligne et un saut de section à un index spécifique du document.

Le saut de section doit être inséré dans les limites d'un Paragraph existant. Par exemple, il ne peut pas être inséré à l'index de début d'un tableau (c'est-à-dire entre le tableau et le paragraphe qui le précède).

Vous ne pouvez pas insérer de sauts de section dans un tableau, une équation, une note de bas de page, un en-tête ou un pied de page. Étant donné que les sauts de section ne peuvent être insérés que dans le corps, le champ segment ID doit être vide.

object (EndOfSegmentLocation)

Insère un saut de ligne et une section à la fin du corps du document.

Les sauts de section ne peuvent pas être insérés dans une note de bas de page, un en-tête ou un pied de page. Comme les sauts de section ne peuvent être insérés que dans le corps, le champ segment ID doit être vide.

string

ID de l'en-tête à supprimer. Si cet en-tête est défini sur DocumentStyle, la référence à cet en-tête est supprimée, ce qui signifie qu'il n'y aura pas d'en-tête de ce type pour la première section du document. Si cet en-tête est défini sur un SectionStyle, la référence à cet en-tête est supprimée et l'en-tête de ce type est désormais poursuivi à partir de la section précédente.

string

Onglet contenant l'en-tête à supprimer. Si elle est omise, la requête est appliquée au premier onglet.

Dans un document contenant un seul onglet :

• S'il est fourni, il doit correspondre à l'ID de l'onglet au singulier.

• En cas d'omission, la requête s'applique à l'onglet au singulier.

Dans un document contenant plusieurs onglets :

• Si elle est fournie, la demande s'applique à l'onglet spécifié.

• Si elle est omise, la requête s'applique au premier onglet du document.

string

ID du pied de page à supprimer. Si ce pied de page est défini sur DocumentStyle, la référence à ce pied de page est supprimée, ce qui signifie qu'il n'y aura pas de pied de page de ce type pour la première section du document. Si ce pied de page est défini sur un SectionStyle, la référence à ce pied de page est supprimée et le pied de page de ce type est désormais poursuivi à partir de la section précédente.

string

Onglet contenant le pied de page à supprimer. Si elle est omise, la requête est appliquée au premier onglet.

Dans un document contenant un seul onglet :

• S'il est fourni, il doit correspondre à l'ID de l'onglet au singulier.

• En cas d'omission, la requête s'applique à l'onglet au singulier.

Dans un document contenant plusieurs onglets :

• Si elle est fournie, la demande s'applique à l'onglet spécifié.

• Si elle est omise, la requête s'applique au premier onglet du document.

object (Location)

Emplacement de début du tableau dans le document.

integer

Nombre de lignes du tableau à épingler (0 signifie qu'aucune ligne n'est épinglée).

object (TabProperties)

Propriétés de l'onglet à ajouter. Toutes les propriétés sont facultatives.

string

ID de l'onglet à supprimer.

object (TabProperties)

Propriétés de l'onglet à mettre à jour.

string (FieldMask format)

Champs à mettre à jour.

Vous devez spécifier au moins un champ. La racine tabProperties est implicite et ne doit pas être spécifiée. Un seul "*" peut être utilisé comme raccourci pour lister tous les champs.

object (PersonProperties)

Propriétés de la mention de personne à insérer.

object (Location)

Insère la mention de la personne à un index spécifique du document.

La mention de personne doit être insérée dans les limites d'un Paragraph existant. Par exemple, il ne peut pas être inséré à l'index de début d'un tableau (c'est-à-dire entre le tableau et le paragraphe qui le précède).

Il est impossible d'insérer des mentions de personnes dans une équation.

object (EndOfSegmentLocation)

Insère la mention de la personne à la fin d'un en-tête, d'un pied de page, d'une note de bas de page ou du corps du document.

object (NamedStyle)

Style de document à mettre à jour.

string (FieldMask format)

Champs NamedStyle à mettre à jour.

Vous devez spécifier au moins namedStyleType. La racine namedStyle est implicite et ne doit pas être spécifiée. Un seul "*" peut être utilisé comme raccourci pour lister tous les champs.

Par exemple, pour mettre à jour le style de texte en gras, définissez fields pour inclure "textStyle" et "textStyle.bold". Pour mettre à jour la propriété d'alignement du style de paragraphe, définissez fields pour inclure "paragraphStyle" et "paragraphStyle.alignment".

Pour rétablir la valeur par défaut d'une propriété, incluez le nom de son champ dans le masque de champ, mais laissez le champ lui-même non défini. Spécifier "textStyle" ou "paragraphStyle" avec un TextStyle ou un ParagraphStyle vide réinitialisera tous ses champs imbriqués.

string

Onglet du document à mettre à jour. Par défaut, la mise à jour est appliquée au premier onglet.

object (RichLinkProperties)

Propriétés du lien enrichi à insérer.

object (Location)

Insère le lien enrichi à un index spécifique du document.

Le lien enrichi doit être inséré dans les limites d'un Paragraph existant. Par exemple, il ne peut pas être inséré à l'index de début d'un tableau (c'est-à-dire entre le tableau et le paragraphe qui le précède).

Le lien enrichi ne peut pas être inséré dans une équation.

object (EndOfSegmentLocation)

Insère le lien enrichi à la fin d'un en-tête, d'un pied de page, d'une note de bas de page ou du corps du document.

object (DateElementProperties)

Propriétés de la date à insérer.

object (Location)

Insère la date à un index spécifique du document.

La date doit être insérée dans les limites d'un Paragraph existant. Par exemple, il ne peut pas être inséré à l'index de début d'un tableau (c'est-à-dire entre un tableau existant et le paragraphe qui le précède).

object (EndOfSegmentLocation)

Insère la date à la fin de l'en-tête, du pied de page ou du corps du document spécifié.

string

Texte du commentaire, en texte brut.

Ce contenu textuel sera traité de la même manière que les commentaires créés dans l'éditeur Docs. Il aura des comportements similaires pour la mise en forme, les notifications, etc.

Ce champ est obligatoire et ne doit pas dépasser 2 048 unités de code UTF-8.

string

Facultatif. Adresse e-mail de la personne à laquelle le commentaire est attribué.

Laissez ce champ vide pour un commentaire non attribué.

Ne doit pas dépasser 2 048 unités de code UTF-8.

object (Range)

Le Range du document auquel ce commentaire est associé.

object (Post)

Le Post représentant la réponse.

string

ID de la CommentThread à laquelle ajouter la réponse.

string

ID de la SuggestionThread à laquelle ajouter la réponse.

string

ID du post en cours de modification.

string

Nouveau texte du commentaire, en texte brut.

Ce contenu textuel sera traité de la même manière que les commentaires créés dans l'éditeur Docs. Il aura des comportements similaires pour la mise en forme, les notifications, etc.

Ce champ est obligatoire et ne doit pas dépasser 2 048 unités de code UTF-8.

string

ID de la CommentThread à laquelle appartient le post.

string

ID de la SuggestionThread à laquelle appartient le post.

string

ID de l'CommentThread en cours de suppression.

string

ID de la réponse Post à supprimer.

string

ID de la CommentThread à laquelle appartient le post.

string

ID de la SuggestionThread à laquelle appartient le post.

string

ID de la suggestion.

string

ID de la suggestion.

string

ID de la suggestion.