Requests

Requête

Mise à jour unique à appliquer à un document.

Représentation JSON 
{

  // Union field request can be only one of the following:
  "replaceAllText": {
    object (ReplaceAllTextRequest)
  },
  "insertText": {
    object (InsertTextRequest)
  },
  "updateTextStyle": {
    object (UpdateTextStyleRequest)
  },
  "createParagraphBullets": {
    object (CreateParagraphBulletsRequest)
  },
  "deleteParagraphBullets": {
    object (DeleteParagraphBulletsRequest)
  },
  "createNamedRange": {
    object (CreateNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "updateParagraphStyle": {
    object (UpdateParagraphStyleRequest)
  },
  "deleteContentRange": {
    object (DeleteContentRangeRequest)
  },
  "insertInlineImage": {
    object (InsertInlineImageRequest)
  },
  "insertTable": {
    object (InsertTableRequest)
  },
  "insertTableRow": {
    object (InsertTableRowRequest)
  },
  "insertTableColumn": {
    object (InsertTableColumnRequest)
  },
  "deleteTableRow": {
    object (DeleteTableRowRequest)
  },
  "deleteTableColumn": {
    object (DeleteTableColumnRequest)
  },
  "insertPageBreak": {
    object (InsertPageBreakRequest)
  },
  "deletePositionedObject": {
    object (DeletePositionedObjectRequest)
  },
  "updateTableColumnProperties": {
    object (UpdateTableColumnPropertiesRequest)
  },
  "updateTableCellStyle": {
    object (UpdateTableCellStyleRequest)
  },
  "updateTableRowStyle": {
    object (UpdateTableRowStyleRequest)
  },
  "replaceImage": {
    object (ReplaceImageRequest)
  },
  "updateDocumentStyle": {
    object (UpdateDocumentStyleRequest)
  },
  "mergeTableCells": {
    object (MergeTableCellsRequest)
  },
  "unmergeTableCells": {
    object (UnmergeTableCellsRequest)
  },
  "createHeader": {
    object (CreateHeaderRequest)
  },
  "createFooter": {
    object (CreateFooterRequest)
  },
  "createFootnote": {
    object (CreateFootnoteRequest)
  },
  "replaceNamedRangeContent": {
    object (ReplaceNamedRangeContentRequest)
  },
  "updateSectionStyle": {
    object (UpdateSectionStyleRequest)
  },
  "insertSectionBreak": {
    object (InsertSectionBreakRequest)
  },
  "deleteHeader": {
    object (DeleteHeaderRequest)
  },
  "deleteFooter": {
    object (DeleteFooterRequest)
  },
  "pinTableHeaderRows": {
    object (PinTableHeaderRowsRequest)
  },
  "insertPerson": {
    object (InsertPersonRequest)
  }
  // End of list of possible types for union field request.
}
Champs
Champ d'union request. Demande spécifique à appliquer. Un seul champ est requis. request ne peut être qu'un des éléments suivants :
replaceAllText

object (ReplaceAllTextRequest)

Remplace toutes les instances du texte spécifié.

insertText

object (InsertTextRequest)

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

updateTextStyle

object (UpdateTextStyleRequest)

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

createParagraphBullets

object (CreateParagraphBulletsRequest)

Crée des puces pour les paragraphes.

deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

Supprime les puces des paragraphes.

createNamedRange

object (CreateNamedRangeRequest)

Crée une plage nommée.

deleteNamedRange

object (DeleteNamedRangeRequest)

Supprime une plage nommée.

updateParagraphStyle

object (UpdateParagraphStyleRequest)

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

deleteContentRange

object (DeleteContentRangeRequest)

Supprime le contenu du document.

insertInlineImage

object (InsertInlineImageRequest)

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

insertTable

object (InsertTableRequest)

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

insertTableRow

object (InsertTableRowRequest)

Insère une ligne vide dans un tableau.

insertTableColumn

object (InsertTableColumnRequest)

Insère une colonne vide dans un tableau.

deleteTableRow

object (DeleteTableRowRequest)

Supprime une ligne d'une table.

deleteTableColumn

object (DeleteTableColumnRequest)

Supprime une colonne d'une table.

insertPageBreak

object (InsertPageBreakRequest)

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

deletePositionedObject

object (DeletePositionedObjectRequest)

Supprime un objet positionné du document.

updateTableColumnProperties

object (UpdateTableColumnPropertiesRequest)

Met à jour les propriétés des colonnes d'une table.

updateTableCellStyle

object (UpdateTableCellStyleRequest)

Met à jour le style des cellules du tableau.

updateTableRowStyle

object (UpdateTableRowStyleRequest)

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

replaceImage

object (ReplaceImageRequest)

Remplace une image dans le document.

updateDocumentStyle

object (UpdateDocumentStyleRequest)

Met à jour le style du document.

mergeTableCells

object (MergeTableCellsRequest)

Fusionne les cellules d'un tableau.

unmergeTableCells

object (UnmergeTableCellsRequest)

Annule la fusion de cellules dans un tableau.

createHeader

object (CreateHeaderRequest)

Crée un en-tête.

createFootnote

object (CreateFootnoteRequest)

Crée une note de bas de page.

replaceNamedRangeContent

object (ReplaceNamedRangeContentRequest)

Remplace le contenu d'une plage nommée.

updateSectionStyle

object (UpdateSectionStyleRequest)

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

insertSectionBreak

object (InsertSectionBreakRequest)

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

deleteHeader

object (DeleteHeaderRequest)

Supprime un en-tête du document.

pinTableHeaderRows

object (PinTableHeaderRowsRequest)

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

insertPerson

object (InsertPersonRequest)

Insère une mention de personne.

ReplaceAllTextRequest

Remplace toutes les instances de texte correspondant à un critère par replace text.

Représentation JSON 
{
  "replaceText": string,
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field criteria can be only one of the following:
  "containsText": {
    object (SubstringMatchCriteria)
  }
  // End of list of possible types for union field criteria.
}
Champs
replaceText

string

Texte qui remplacera le texte correspondant.

tabsCriteria

object (TabsCriteria)

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

Si elle est omise, le remplacement s'applique à tous les onglets.

Dans un document contenant un seul onglet :

  • Si elle est fournie, elle 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 elle est omise, le remplacement s'applique à tous les onglets.

Champ d'union criteria. Critères utilisés pour faire correspondre le texte à remplacer. criteria ne peut être qu'un des éléments suivants :
containsText

object (SubstringMatchCriteria)

Recherche du texte dans le document correspondant à cette sous-chaîne.

SubstringMatchCriteria

Critère qui correspond à une chaîne de texte spécifique dans le document.

Représentation JSON 
{
  "text": string,
  "matchCase": boolean,
  "searchByRegex": boolean
}
Champs
text

string

Texte à rechercher dans le document.

matchCase

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.
searchByRegex

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 mise en correspondance.

TabsCriteria

Critère qui spécifie les onglets dans lesquels une requête s'exécute.

Représentation JSON 
{
  "tabIds": [
    string
  ]
}
Champs
tabIds[]

string

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

InsertTextRequest

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

Représentation JSON 
{
  "text": string,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Champs
text

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 de texte du texte inséré correspond à celui du texte situé juste avant 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 d'utilisation privée du plan multilingue de base Unicode (U+E000-U+F8FF) seront supprimés du texte inséré.

Champ d'union insertion_location. Emplacement où le texte sera inséré. insertion_location ne peut être qu'un des éléments suivants :
location

object (Location)

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

Le texte doit être inséré dans les limites d'un Paragraph existant. Par exemple, du texte 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 texte doit être inséré dans le paragraphe précédent.

endOfSegmentLocation

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.

Emplacement

Emplacement spécifique dans le document.

Représentation JSON 
{
  "segmentId": string,
  "index": integer,
  "tabId": string
}
Champs
segmentId

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 indique le corps du document.

index

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.

tabId

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 :

  • Si elle est fournie, elle doit correspondre à l'ID de l'onglet au singulier.

  • Si elle est omise, la requête s'applique à l'onglet unique.

Dans un document contenant plusieurs onglets :

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

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

EndOfSegmentLocation

Emplacement à la fin d'un corps, d'un en-tête, d'un pied de page ou d'une note de bas de page. L'emplacement se trouve immédiatement avant le dernier saut de ligne du segment de document.

Représentation JSON 
{
  "segmentId": string,
  "tabId": string
}
Champs
segmentId

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 indique le corps du document.

tabId

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 :

  • Si elle est fournie, elle doit correspondre à l'ID de l'onglet au singulier.

  • Si elle est omise, la requête s'applique à l'onglet unique.

Dans un document contenant plusieurs onglets :

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

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

UpdateTextStyleRequest

Modifiez le style du texte.

Représentation JSON 
{
  "textStyle": {
    object (TextStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}
Champs
textStyle

object (TextStyle)

Styles à appliquer au texte.

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

Certaines modifications du 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.

fields

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 son nom de champ dans le masque de champ, mais laissez le champ lui-même non défini.

Champ d'union insertion_location. Type de plage utilisé pour mettre à jour le style de texte. insertion_location ne peut être qu'un des éléments suivants :
range

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.

CreateParagraphBulletsRequest

Crée des puces pour tous les paragraphes qui chevauchent la plage donnée.

Le niveau d'imbrication de chaque paragraphe est déterminé en comptant les tabulations en début de paragraphe. Pour éviter un espace excessif entre la puce et le paragraphe correspondant, ces tabulations de début sont supprimées par cette demande. Cela peut modifier les index des parties du texte.

Si le paragraphe qui précède immédiatement les paragraphes à mettre à jour se trouve dans une liste avec un préréglage correspondant, les paragraphes à mettre à jour sont ajoutés à cette liste précédente.

Représentation JSON 
{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
Champs
range

object (Range)

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

bulletPreset

enum (BulletGlyphPreset)

Types de glyphes de puces à utiliser.

BulletGlyphPreset

Motifs prédéfinis de glyphes de puces pour les listes.

Ces modèles utilisent les types de puces suivants :

  • ARROW : flèche correspondant à un point de code Unicode U+2794
  • ARROW3D : flèche avec ombrage 3D, correspondant au point de code Unicode U+27a2
  • CHECKBOX : carré vide, correspondant au point de code Unicode U+274f
  • CIRCLE : cercle vide, correspondant au point de code Unicode U+25cb
  • DIAMOND : losange plein, correspondant au point de code Unicode U+25c6
  • DIAMONDX : losange avec un "x", correspondant au point de code Unicode U+2756
  • HOLLOWDIAMOND : losange creux, correspondant à un point de code Unicode U+25c7
  • DISC : cercle plein, correspondant au point de code Unicode U+25cf
  • SQUARE : carré plein, correspondant au point de code Unicode U+25a0
  • STAR : étoile, correspondant au point de code Unicode U+2605
  • ALPHA  : une lettre minuscule, comme "a", "b" ou "c".
  • UPPERALPHA  : une lettre majuscule, comme "A", "B" ou "C".
  • DECIMAL  : un nombre, comme "1", "2" ou "3".
  • ZERODECIMAL : nombre à un chiffre précédé d'un zéro, comme "01", "02" ou "03". Les nombres comportant plusieurs chiffres ne sont pas précédés d'un zéro.
  • ROMAN  : chiffre romain en minuscules, comme "i", "ii" ou "iii".
  • UPPERROMAN  : chiffre romain en majuscules, comme "I", "II" ou "III".
  • LEFTTRIANGLE : triangle pointant vers la gauche, correspondant au point de code Unicode U+25c4
Enums
BULLET_GLYPH_PRESET_UNSPECIFIED Le préréglage du glyphe de puce n'est pas spécifié.
BULLET_DISC_CIRCLE_SQUARE Liste à puces avec des glyphes de puces DISC, CIRCLE et SQUARE pour les trois premiers niveaux d'imbrication de liste.
BULLET_DIAMONDX_ARROW3D_SQUARE Liste à puces avec des glyphes de puces DIAMONDX, ARROW3D et SQUARE pour les trois premiers niveaux d'imbrication de liste.
BULLET_CHECKBOX Liste à puces avec des glyphes de puces CHECKBOX pour tous les niveaux d'imbrication de la liste.
BULLET_ARROW_DIAMOND_DISC Liste à puces avec des glyphes de puces ARROW, DIAMOND et DISC pour les trois premiers niveaux d'imbrication de liste.
BULLET_STAR_CIRCLE_SQUARE Liste à puces avec des glyphes de puces STAR, CIRCLE et SQUARE pour les trois premiers niveaux d'imbrication de liste.
BULLET_ARROW3D_CIRCLE_SQUARE Liste à puces avec des glyphes de puces ARROW3D, CIRCLE et SQUARE pour les trois premiers niveaux d'imbrication de liste.
BULLET_LEFTTRIANGLE_DIAMOND_DISC Liste à puces avec des glyphes de puces LEFTTRIANGLE, DIAMOND et DISC pour les trois premiers niveaux d'imbrication de liste.
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE Liste à puces avec des glyphes de puces DIAMONDX, HOLLOWDIAMOND et SQUARE pour les trois premiers niveaux d'imbrication de liste.
BULLET_DIAMOND_CIRCLE_SQUARE Liste à puces avec des glyphes de puces DIAMOND, CIRCLE et SQUARE pour les trois premiers niveaux d'imbrication de liste.
NUMBERED_DECIMAL_ALPHA_ROMAN Une liste numérotée avec des glyphes numériques DECIMAL, ALPHA et ROMAN pour les trois premiers niveaux d'imbrication de liste, suivis de points.
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS Liste numérotée avec des glyphes numériques DECIMAL, ALPHA et ROMAN pour les trois premiers niveaux d'imbrication de liste, suivis de parenthèses.
NUMBERED_DECIMAL_NESTED Liste numérotée avec des glyphes numériques séparés par des points, où chaque niveau d'imbrication utilise le glyphe du niveau d'imbrication précédent comme préfixe.DECIMAL Par exemple : "1.", '1.1.', '2.', "2.2.".
NUMBERED_UPPERALPHA_ALPHA_ROMAN Une liste numérotée avec des glyphes numériques UPPERALPHA, ALPHA et ROMAN pour les trois premiers niveaux d'imbrication de liste, suivis de points.
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL Une liste numérotée avec des glyphes numériques UPPERROMAN, UPPERALPHA et DECIMAL pour les trois premiers niveaux d'imbrication de liste, suivis de points.
NUMBERED_ZERODECIMAL_ALPHA_ROMAN Une liste numérotée avec des glyphes numériques ZERODECIMAL, ALPHA et ROMAN pour les trois premiers niveaux d'imbrication de liste, suivis de points.

DeleteParagraphBulletsRequest

Supprime les puces de tous les paragraphes qui chevauchent la plage donnée.

Le niveau d'imbrication de chaque paragraphe sera conservé visuellement en ajoutant une indentation au début du paragraphe correspondant.

Représentation JSON 
{
  "range": {
    object (Range)
  }
}
Champs
range

object (Range)

Plage à partir de laquelle supprimer les puces.

CreateNamedRangeRequest

Crée un NamedRange faisant référence à la plage donnée.

Représentation JSON 
{
  "name": string,
  "range": {
    object (Range)
  }
}
Champs
name

string

Nom de NamedRange. Les noms ne doivent pas nécessairement être uniques.

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

range

object (Range)

Plage à laquelle appliquer le nom.

DeleteNamedRangeRequest

Supprime un NamedRange.

Représentation JSON 
{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "name": string
  // End of list of possible types for union field named_range_reference.
}
Champs
tabsCriteria

object (TabsCriteria)

Facultatif. Critères utilisés pour spécifier 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 :

  • Si elle est fournie, elle doit correspondre à l'ID de l'onglet au singulier.

  • En cas d'omission, la suppression de la plage s'applique à l'onglet unique.

Dans un document contenant plusieurs onglets :

  • Si des onglets sont spécifiés, la suppression de la plage s'applique à ceux-ci.

  • Si aucune n'est fournie, la suppression de la plage s'applique à tous les onglets.

Champ d'union named_range_reference. Valeur qui détermine la ou les plages à supprimer. Un seul doit être défini. named_range_reference ne peut être qu'un des éléments suivants :
namedRangeId

string

ID de la plage nommée à supprimer.

name

string

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

UpdateParagraphStyleRequest

Mettez à jour le style de tous les paragraphes qui chevauchent la plage donnée.

Représentation JSON 
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}
Champs
paragraphStyle

object (ParagraphStyle)

Styles à définir pour les paragraphes.

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

fields

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 son nom de champ dans le masque de champ, mais laissez le champ lui-même non défini.

Champ d'union insertion_location. Type de plage utilisé pour la mise à jour du style de paragraphe. insertion_location ne peut être qu'un des éléments suivants :
range

object (Range)

Plage chevauchant les paragraphes à mettre en forme.

DeleteContentRangeRequest

Supprime le contenu du document.

Représentation JSON 
{
  "range": {
    object (Range)
  }
}
Champs
range

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 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.

InsertInlineImageRequest

Insère un InlineObject contenant une image à l'emplacement indiqué.

Représentation JSON 
{
  "uri": string,
  "objectSize": {
    object (Size)
  },

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Champs
uri

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 l'affichage 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.

objectSize

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 les proportions 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 ses proportions.

Champ d'union insertion_location. Emplacement où l'image sera insérée. insertion_location ne peut être qu'un des éléments suivants :
location

object (Location)

Insère l'image à un index spécifique dans le 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.

endOfSegmentLocation

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.

InsertTableRequest

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

Un caractère de nouvelle ligne est inséré avant le tableau inséré.

Représentation JSON 
{
  "rows": integer,
  "columns": integer,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Champs
rows

integer

Nombre de lignes dans la table.

columns

integer

Nombre de colonnes dans le tableau.

Champ d'union insertion_location. Emplacement où le tableau sera inséré. insertion_location ne peut être qu'un des éléments suivants :
location

object (Location)

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

Un caractère de saut de 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.

Le tableau 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 un tableau existant et le paragraphe qui le précède).

Les tableaux ne peuvent pas être insérés dans un bas de page ni dans une équation.

endOfSegmentLocation

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 inséré.

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

InsertTableRowRequest

Insère une ligne vide dans un tableau.

Représentation JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}
Champs
tableCellLocation

object (TableCellLocation)

Emplacement de la cellule du 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.

insertBelow

boolean

Indique s'il faut insérer une ligne sous l'emplacement de la cellule de référence.

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

TableCellLocation

Emplacement d'une seule cellule dans un tableau.

Représentation JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}
Champs
tableStartLocation

object (Location)

Emplacement où le tableau commence dans le document.

rowIndex

integer

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

columnIndex

integer

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

InsertTableColumnRequest

Insère une colonne vide dans un tableau.

Représentation JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}
Champs
tableCellLocation

object (TableCellLocation)

Emplacement de la cellule du tableau 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.

insertRight

boolean

Indique si une colonne doit être insérée à droite de l'emplacement de la cellule de référence.

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

DeleteTableRowRequest

Supprime une ligne d'une table.

Représentation JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
Champs
tableCellLocation

object (TableCellLocation)

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

La ligne sur laquelle s'étend cette cellule 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.

DeleteTableColumnRequest

Supprime une colonne d'une table.

Représentation JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
Champs
tableCellLocation

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 s'étend cette cellule 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 la table après cette suppression, la table entière est supprimée.

InsertPageBreakRequest

Insère un saut de page suivi d'une nouvelle ligne à l'emplacement spécifié.

Représentation JSON 
{

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Champs
Champ d'union insertion_location. Emplacement où le saut de page sera inséré. insertion_location ne peut être qu'un des éléments suivants :
location

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 qu'à l'intérieur du corps, le champ segment ID doit être vide.

endOfSegmentLocation

object (EndOfSegmentLocation)

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

Vous ne pouvez pas insérer de saut de page 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 qu'à l'intérieur du corps, le champ segment ID doit être vide.

DeletePositionedObjectRequest

Supprime un PositionedObject du document.

Représentation JSON 
{
  "objectId": string,
  "tabId": string
}
Champs
objectId

string

ID de l'objet positionné à supprimer.

tabId

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 :

  • Si elle est fournie, elle doit correspondre à l'ID de l'onglet au singulier.

  • Si elle est omise, la requête s'applique à l'onglet unique.

Dans un document contenant plusieurs onglets :

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

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

UpdateTableColumnPropertiesRequest

Met à jour le TableColumnProperties des colonnes d'une table.

Représentation JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}
Champs
tableStartLocation

object (Location)

Emplacement où le tableau commence dans le document.

columnIndices[]

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.

tableColumnProperties

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.

fields

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".

UpdateTableCellStyleRequest

Met à jour le style d'une plage de cellules de tableau.

Représentation JSON 
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "fields": string,

  // Union field cells can be only one of the following:
  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
  // End of list of possible types for union field cells.
}
Champs
tableCellStyle

object (TableCellStyle)

Style à appliquer aux 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
fields

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 son nom de champ dans le masque de champ, mais laissez le champ lui-même non défini.

Champ d'union cells. Cellules à mettre à jour. cells ne peut être qu'un des éléments suivants :
tableRange

object (TableRange)

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

tableStartLocation

object (Location)

Emplacement où le tableau commence dans le document. Si cette option est spécifiée, les modifications sont appliquées à toutes les cellules du tableau.

TableRange

Une plage de table représente une référence à un sous-ensemble d'une table.

Il est important de noter que les cellules spécifiées par une plage de tableau ne forment pas nécessairement un rectangle. Par exemple, imaginons un tableau 3x3 dans lequel toutes les cellules de la dernière ligne sont fusionnées. La table se présente comme suit : 

 [   ][   ][   ]
 [   ][   ][   ]
 [             ]

Une plage de tableau avec l'emplacement de la cellule de tableau = (tableStartLocation, row = 0, column = 0), une étendue de ligne = 3 et une étendue de colonne = 2 spécifie les cellules suivantes : 

 [ x ][ x ][   ]
 [ x ][ x ][   ]
 [ x    x    x ]
Représentation JSON 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}
Champs
tableCellLocation

object (TableCellLocation)

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

rowSpan

integer

Étendue de ligne de la plage de tableau.

columnSpan

integer

Étendue de colonne de la plage de tableau.

UpdateTableRowStyleRequest

Met à jour le TableRowStyle des lignes d'un tableau.

Représentation JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}
Champs
tableStartLocation

object (Location)

Emplacement où le tableau commence dans le document.

rowIndices[]

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.

tableRowStyle

object (TableRowStyle)

Styles à définir sur les lignes.

fields

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".

ReplaceImageRequest

Remplace une image existante par une nouvelle.

Le remplacement d'une image supprime certains image effects de l'image existante afin de refléter le comportement de l'éditeur Docs.

Représentation JSON 
{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "tabId": string
}
Champs
imageObjectId

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.

uri

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 l'affichage 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.

imageReplaceMethod

enum (ImageReplaceMethod)

Méthode de remplacement.

tabId

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 :

  • Si elle est fournie, elle doit correspondre à l'ID de l'onglet au singulier.

  • Si elle est omise, la requête s'applique à l'onglet unique.

Dans un document contenant plusieurs onglets :

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

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

ImageReplaceMethod

Méthode de remplacement de l'image.

Enums
IMAGE_REPLACE_METHOD_UNSPECIFIED Méthode de remplacement d'image non spécifiée. Cette valeur ne doit pas être utilisée.
CENTER_CROP Met l'image à l'échelle et la centre pour qu'elle remplisse les limites de l'image d'origine. L'image peut être recadrée pour remplir les limites de l'image d'origine. La taille de l'image affichée sera identique à celle de l'image d'origine.

UpdateDocumentStyleRequest

Met à jour le DocumentStyle.

Représentation JSON 
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string,
  "tabId": string
}
Champs
documentStyle

object (DocumentStyle)

Styles à définir dans le document.

Certaines modifications apportées au style d'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.

fields

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".

tabId

string

Onglet contenant le style à modifier. En cas d'omission, la requête s'applique au premier onglet.

Dans un document contenant un seul onglet :

  • Si elle est fournie, elle doit correspondre à l'ID de l'onglet au singulier.

  • Si elle est omise, la requête s'applique à l'onglet unique.

Dans un document contenant plusieurs onglets :

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

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

MergeTableCellsRequest

Fusionne les cellules d'un Table.

Représentation JSON 
{
  "tableRange": {
    object (TableRange)
  }
}
Champs
tableRange

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 (mauvaise requête) est renvoyée.

UnmergeTableCellsRequest

Annule la fusion des cellules dans un Table.

Représentation JSON 
{
  "tableRange": {
    object (TableRange)
  }
}
Champs
tableRange

object (TableRange)

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

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

Si du texte figure dans l'une des cellules fusionnées, il restera dans la cellule "d'en-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.

CreateHeaderRequest

Crée un Header. Le nouvel en-tête est appliqué à SectionStyle à l'emplacement de SectionBreak s'il est spécifié. Sinon, il est appliqué à DocumentStyle.

Si un en-tête du type spécifié existe déjà, une erreur 400 (requête incorrecte) est renvoyée.

Représentation JSON 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Champs
type

enum (HeaderFooterType)

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

sectionBreakLocation

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 à DocumentStyle.

HeaderFooterType

Types d'en-têtes et de pieds de page pouvant être créés.

Enums
DEFAULT En-tête/pied de page par défaut.

CreateFooterRequest

Crée un Footer. Le nouveau pied de page est appliqué à SectionStyle à l'emplacement de SectionBreak, s'il est spécifié. Sinon, il est appliqué à DocumentStyle.

Si un pied de page du type spécifié existe déjà, une erreur 400 (requête incorrecte) est renvoyée.

Représentation JSON 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Champs
type

enum (HeaderFooterType)

Type de pied de page à créer.

sectionBreakLocation

object (Location)

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

CreateFootnoteRequest

Crée un segment Footnote et y insère un FootnoteReference à l'emplacement indiqué.

Le nouveau segment Footnote contiendra un espace suivi d'un caractère de nouvelle ligne.

Représentation JSON 
{

  // Union field footnote_reference_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field footnote_reference_location.
}
Champs
Champ d'union footnote_reference_location. Emplacement où insérer la référence de la note de bas de page. footnote_reference_location ne peut être qu'un des éléments suivants :
location

object (Location)

Insère la référence de note de bas de page à un index spécifique du 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 de 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 document, le champ segment ID doit être vide.

endOfSegmentLocation

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 document, le champ segment ID doit être vide.

ReplaceNamedRangeContentRequest

Remplace le contenu de l'élément NamedRange ou NamedRanges spécifié par le contenu de remplacement fourni.

Notez qu'un NamedRange individuel peut comporter plusieurs ranges discontinus. Dans ce cas, seul le contenu de la première plage sera remplacé. Les autres plages et leur contenu seront supprimés.

Dans les cas où le remplacement ou la suppression de plages entraînerait une structure de document non valide, une erreur 400 (requête incorrecte) est renvoyée.

Représentation JSON 
{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field replacement_content can be only one of the following:
  "text": string
  // End of list of possible types for union field replacement_content.

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "namedRangeName": string
  // End of list of possible types for union field named_range_reference.
}
Champs
tabsCriteria

object (TabsCriteria)

Facultatif. Critères utilisés pour spécifier dans quels onglets le remplacement a lieu. Si elle est omise, le remplacement s'applique à tous les onglets.

Dans un document contenant un seul onglet :

  • Si elle est fournie, elle 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 elle est omise, le remplacement s'applique à tous les onglets.

Champ d'union replacement_content. Contenu qui remplacera le contenu existant de la plage nommée. replacement_content ne peut être qu'un des éléments suivants :
text

string

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

Champ d'union named_range_reference. Référence à la ou aux plages nommées dont le contenu sera remplacé. named_range_reference ne peut être qu'un des éléments suivants :
namedRangeId

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 (mauvaise requête) est renvoyée.

namedRangeName

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 ne fera rien.

UpdateSectionStyleRequest

Met à jour le SectionStyle.

Représentation JSON 
{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}
Champs
range

object (Range)

Plage chevauchant les sections à mettre en forme.

Étant donné que les sauts de section ne peuvent être insérés qu'à l'intérieur du corps, le champ segment ID doit être vide.

sectionStyle

object (SectionStyle)

Styles à définir sur la section.

Certaines modifications apportées au style d'une 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.

fields

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".

InsertSectionBreakRequest

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

Un caractère de nouvelle ligne est inséré avant le saut de section.

Représentation JSON 
{
  "sectionType": enum (SectionType),

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Champs
sectionType

enum (SectionType)

Type de section à insérer.

Champ d'union insertion_location. Emplacement où l'insertion sera effectuée. insertion_location ne peut être qu'un des éléments suivants :
location

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.

endOfSegmentLocation

object (EndOfSegmentLocation)

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

Vous ne pouvez pas insérer de sauts de section dans un pied de page, un en-tête ou un pied de page. Étant donné que les sauts de section ne peuvent être insérés qu'à l'intérieur du corps, le champ segment ID doit être vide.

DeleteHeaderRequest

Supprime un Header du document.

Représentation JSON 
{
  "headerId": string,
  "tabId": string
}
Champs
headerId

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.

tabId

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 :

  • Si elle est fournie, elle doit correspondre à l'ID de l'onglet au singulier.

  • Si elle est omise, la requête s'applique à l'onglet unique.

Dans un document contenant plusieurs onglets :

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

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

DeleteFooterRequest

Supprime un Footer du document.

Représentation JSON 
{
  "footerId": string,
  "tabId": string
}
Champs
footerId

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.

tabId

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 :

  • Si elle est fournie, elle doit correspondre à l'ID de l'onglet au singulier.

  • Si elle est omise, la requête s'applique à l'onglet unique.

Dans un document contenant plusieurs onglets :

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

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

PinTableHeaderRowsRequest

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

Représentation JSON 
{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}
Champs
tableStartLocation

object (Location)

Emplacement où le tableau commence dans le document.

pinnedHeaderRowsCount

integer

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

InsertPersonRequest

Insère une mention de personne.

Représentation JSON 
{
  "personProperties": {
    object (PersonProperties)
  },

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Champs
personProperties

object (PersonProperties)

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

Champ d'union insertion_location. Emplacement où la mention de la personne sera insérée. insertion_location ne peut être qu'un des éléments suivants :
location

object (Location)

Insère la mention de personne à un index spécifique dans le 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.

endOfSegmentLocation

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.