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)
  }
  // End of list of possible types for union field request.
}
Champs
Champ d'union request Requête spécifique à appliquer. Un seul champ est obligatoire. 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 selon 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 des lignes dans une table.

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)

Désassemble les cellules d'un tableau.

createHeader

object (CreateHeaderRequest)

Crée un en-tête.

createFootnote

object (CreateFootnoteRequest)

Permet de créer 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.

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 les onglets dans lesquels le remplacement est effectué.

En cas d'omission, 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 unique.

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

Dans un document contenant plusieurs onglets:

  • Si elle est fournie, le remplacement s'applique aux onglets spécifiés.

  • En cas d'omission, 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 dans le document le texte correspondant à cette sous-chaîne.

SubstringMatchCriteria

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

Représentation JSON 
{
  "text": string,
  "matchCase": 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.

TabsCriteria

Critère qui spécifie les onglets dans lesquels une requête est exécutée.

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

string

Liste des ID d'onglet 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 nouveau Paragraph à cet indice. Le style de paragraphe du nouveau paragraphe sera copié à partir du paragraphe à l'indice d'insertion actuel, y compris les listes et les puces.

Les styles du texte inséré sont déterminés automatiquement, ce qui préserve généralement le style du texte voisin. Dans la plupart des cas, le style de texte du texte inséré correspond au texte immédiatement avant l'indice d'insertion.

Certains caractères de contrôle (U+0000-U+0008, U+000C-U+001F) et caractères de la zone à usage privé 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 au niveau d'un index spécifique dans le document.

Le texte doit être inséré à l'intérieur des limites d'un Paragraph Par exemple, vous ne pouvez pas insérer de texte à l'index de début d'un tableau (c'est-à-dire entre le tableau et le paragraphe précédent). 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.

Lieu

Un 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 lequel se trouve l'emplacement. Un ID de segment vide correspond au 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 l'établissement. En cas d'omission, la requête est appliquée au premier onglet.

Dans un document contenant un seul onglet:

  • Si fourni, doit correspondre à l'ID de l'onglet unique.

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

  • En cas d'omission, 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 la dernière nouvelle 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 lequel se trouve l'emplacement. Un ID de segment vide indique le corps du document.

tabId

string

Onglet dans lequel se trouve l'emplacement. En cas d'omission, la requête est appliquée au premier onglet.

Dans un document contenant un seul onglet:

  • Si fourni, doit correspondre à l'ID de l'onglet unique.

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

  • En cas d'omission, 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 à définir sur le texte.

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

Certaines modifications de style de texte peuvent entraîner d'autres modifications, qui reproduisent le comportement de l'éditeur Docs. Consultez la documentation TextStyle pour en savoir plus.

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é. Un seul "*" peut être utilisé comme raccourci pour lister tous les champs.

Par exemple, pour mettre 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 non défini.

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

object (Range)

Plage de texte à styliser.

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.

Impossible d'insérer des plages dans une requête UpdateTextStyleRequest relative.

CreateParagraphBulletsRequests

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

Le niveau d'imbrication de chaque paragraphe sera déterminé en comptant les tabulations avant chaque paragraphe. Pour éviter un espace excessif entre la puce et le paragraphe correspondant, ces tabulations initiales sont supprimées par cette requête. Cela peut modifier les index de certaines parties du texte.

Si le paragraphe qui précède la mise à jour se trouve dans une liste dont le préréglage correspond, les paragraphes mis à jour sont ajoutés à la 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 à utiliser.

BulletGlyphPreset

Modèles prédéfinis de glyphes à puces pour les listes.

Ces modèles utilisent les types de puces suivants:

  • ARROW : une flèche, correspondant à un point de code Unicode U+2794
  • ARROW3D : flèche ombrée en 3D, correspondant à un point de code Unicode U+27a2
  • CHECKBOX : carré vide correspondant à un point de code Unicode U+274f
  • CIRCLE : cercle vide, correspondant à un point de code Unicode U+25cb
  • DIAMOND : Diamant plein, correspondant à un point de code Unicode U+25c6
  • DIAMONDX : losange avec un "x", correspondant à un point de code Unicode U+2756
  • HOLLOWDIAMOND : losange creux correspondant à un point de code Unicode U+25c7
  • DISC : cercle plein, correspondant à un point de code Unicode U+25cf
  • SQUARE : carré plein, correspondant à un point de code Unicode U+25a0
  • STAR : étoile correspondant à un point de code Unicode U+2605
  • ALPHA : une lettre minuscule, telle que "a", "b" ou "c".
  • UPPERALPHA : une lettre majuscule, telle que "A", "B" ou "C".
  • DECIMAL : un nombre, comme "1", "2" ou "3".
  • ZERODECIMAL : nombre où un numéro à un chiffre est précédé d'un zéro, comme "01", "02" ou "03". Les nombres comportant plus d'un chiffre ne sont pas précédés d'un zéro.
  • ROMAN : chiffre romain minuscule, comme "i", "ii" ou "iii".
  • UPPERROMAN : chiffre romain en majuscules, tel que "I", "II" ou "III".
  • LEFTTRIANGLE : triangle pointant vers la gauche, correspondant à un 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 Une liste à puces avec une STAR, CIRCLE et SQUARE une puce pour les 3 premiers niveaux d'imbrication de liste.
BULLET_ARROW3D_CIRCLE_SQUARE Une liste à puces avec une ARROW3D, CIRCLE et SQUARE une puce pour les 3 premiers niveaux d'imbrication de liste.
BULLET_LEFTTRIANGLE_DIAMOND_DISC Une liste à puces avec une LEFTTRIANGLE, DIAMOND et DISC une puce pour les 3 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 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 la liste, suivis de parenthèses.
NUMBERED_DECIMAL_NESTED Liste numérotée avec des glyphes numériques DECIMAL séparés par des points, où chaque niveau d'imbrication utilise le glyphe du niveau d'imbrication précédent comme préfixe. Par exemple : "1.", "1.1.", '2.', "2.2.".
NUMBERED_UPPERALPHA_ALPHA_ROMAN Une liste numérotée avec UPPERALPHA, ALPHA et ROMAN des glyphes numériques pour les 3 premiers niveaux d'imbrication de liste, suivis de points.
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL Une liste numérotée avec UPPERROMAN, UPPERALPHA et DECIMAL des glyphes numériques pour les 3 premiers niveaux d'imbrication de liste, suivis de points.
NUMBERED_ZERODECIMAL_ALPHA_ROMAN Une liste numérotée avec ZERODECIMAL, ALPHA et ROMAN des glyphes numériques pour les 3 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 préservé visuellement en ajoutant un retrait 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 la NamedRange. Les noms n'ont pas besoin d'être uniques.

Les noms doivent comporter au moins 1 caractère et ne pas dépasser 256 caractères, 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 dans quel ou quels onglets la suppression de la plage doit s'effectuer. En cas d'omission, la suppression de la plage est appliquée à tous les onglets.

Dans un document contenant un seul onglet:

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

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

Dans un document contenant plusieurs onglets :

  • Si ce champ est fourni, la suppression de la plage s'applique aux onglets spécifiés.

  • Si aucune valeur 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. Vous ne devez en définir qu'un seul. named_range_reference ne peut être qu'un des éléments suivants :
namedRangeId

string

Identifiant de la plage nommée à supprimer.

name

string

Nom de la ou des plages à supprimer. Toutes les plages nommées portant le nom donné 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 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.

fields

string (FieldMask format)

Champs à mettre à jour.

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

Par exemple, pour modifier 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 chevauche les paragraphes à mettre en forme.

DeleteContentRangeRequest

Supprime du contenu du document.

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

object (Range)

Plage de contenu à supprimer.

La suppression de texte qui dépasse la limite d'un paragraphe peut entraîner des modifications au niveau des styles de paragraphe, des listes, des objets positionnés et des favoris lors de la fusion des deux paragraphes.

La tentative de suppression de certaines plages peut entraîner une structure de document non valide, auquel cas une erreur 400 "Mauvaise requête" est renvoyée.

Voici quelques exemples de requêtes de suppression non valides :

  • Suppression d'une unité de code d'une paire de substitution
  • Supprimer le dernier caractère de retour à la ligne d'un Body, Header, Footer, Footnote, TableCell ou TableOfContents
  • Suppression du début ou de la fin d'une Table, TableOfContents ou Equation sans supprimer l'intégralité de l'élément.
  • Suppression du 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'une table. Il est autorisé de supprimer le contenu d'une cellule de tableau.

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 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, ne doivent pas dépasser 25 mégapixels et doivent être au format PNG, JPEG ou GIF.

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

objectSize

object (Size)

Taille de l'image 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 conserver le format de l'image. * Si la largeur et la hauteur sont toutes les deux 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 que l'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 à l'intérieur des limites d'une Paragraph Par exemple, vous ne pouvez pas l'insérer à l'index de début d'un tableau (c'est-à-dire entre le tableau et le paragraphe précédent).

Vous ne pouvez pas insérer d'images intégrées dans une note de bas de page ou 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.

Les images intégrées ne peuvent pas être inséré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 du tableau.

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

object (Location)

Insère la table au niveau d'un index de modèle spécifique.

Un caractère de nouvelle ligne est inséré avant le tableau inséré. Par conséquent, l'index de début de la table correspondra à 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é au niveau de l'index de début d'une table (c'est-à-dire entre une table existante et le paragraphe qui le précède).

Vous ne pouvez pas insérer de tableaux dans une note de 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 donnés. Un caractère de nouvelle ligne est inséré avant le tableau inséré.

Vous ne pouvez pas insérer de 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 de la table 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

Permet d'insérer ou non une nouvelle 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 cellule dans un tableau.

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

object (Location)

Emplacement de début du tableau dans le document.

rowIndex

integer

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

columnIndex

integer

Index de colonne basé sur zéro Par exemple, la deuxième colonne de la table a un indice 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 duquel les colonnes seront insérées.

Une nouvelle colonne sera 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

Permet d'insérer ou non une nouvelle colonne à 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 la table 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 qu'elle couvre 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 du tableau de référence à partir duquel la colonne sera supprimée.

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

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 que l'un des éléments suivants:
location

object (Location)

Insère la page de rupture à un index spécifique dans le document.

Le saut de page doit être inséré à l'intérieur des limites d'un Paragraph Par exemple, vous ne pouvez pas l'insérer à l'index de début d'un tableau (c'est-à-dire entre le tableau et le paragraphe précédent).

Vous ne pouvez pas insérer de sauts de page 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.

endOfSegmentLocation

object (EndOfSegmentLocation)

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

Vous ne pouvez pas insérer de sauts 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 que dans le corps, le champ segment ID doit être vide.

DeletePositionedObjectRequest

Supprime un PositionedObject du document.

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

string

Identifiant de l'objet positionné à supprimer.

tabId

string

Onglet dans lequel se trouve l'objet positionné à supprimer. En cas d'omission, la requête est appliquée au premier onglet.

Dans un document contenant un seul onglet:

  • Si fourni, doit correspondre à l'ID de l'onglet unique.

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

  • En cas d'omission, la requête s'applique au premier onglet du document.

UpdateTableColumnPropertiesRequest

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

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

object (Location)

Emplacement de début du tableau dans le document.

columnIndices[]

integer

Liste des index de colonne de base zéro dont la propriété doit être mise à jour. Si aucun index n'est spécifié, toutes les colonnes sont mises à jour.

tableColumnProperties

object (TableColumnProperties)

Propriétés des colonnes du tableau à mettre à jour.

Si la valeur de tableColumnProperties#width inférieur à cinq points, une erreur de requête incorrecte 400 est renvoyée.

fields

string (FieldMask format)

Champs à mettre à jour.

Vous devez spécifier au moins un champ. Le tableColumnProperties racine est implicite et ne doit pas être spécifié. Une seule "*" peut servir de raccourci pour répertorier chaque champ.

Par exemple, pour mettre à jour la largeur de colonne, définissez fields à "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.

Lors de la mise à jour des bordures, si une cellule partage une bordure avec une cellule adjacente, la propriété de bordure correspondante de la cellule adjacente est également mise à jour. Les bordures fusionnées et invisibles ne sont pas mises à jour.

Étant donné que la mise à jour d'une bordure partagée par les cellules adjacentes d'une même demande peut entraîner des conflits de mise à jour des bordures, ces mises à jour 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é. Une seule "*" peut servir de raccourci pour répertorier chaque champ.

Par exemple, pour modifier la couleur d'arrière-plan des cellules du tableau, définissez fields à "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 que l'un des éléments suivants:
tableRange

object (TableRange)

Plage de la table représentant le sous-ensemble de la table auquel les mises à jour sont appliquées.

tableStartLocation

object (Location)

Emplacement du début du tableau dans le document. Si ce paramètre est spécifié, les mises à jour sont appliquées à toutes les cellules du tableau.

TableRange

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

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, supposons que nous ayons un tableau 3 x 3 dans lequel toutes les cellules de la dernière ligne sont fusionnées. Le tableau se présente comme suit: 

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

Une plage de tableau avec l'emplacement de la cellule de tableau = (tableStartLocation, ligne = 0, colonne = 0), la plage de lignes = 3 et la plage de colonnes = 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 du tableau.

rowSpan

integer

Étendue des lignes de la plage du tableau.

columnSpan

integer

Nombre de colonnes de la plage du tableau.

UpdateTableRowStyleRequest

Met à jour les TableRowStyle des lignes d'une table.

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

object (Location)

Emplacement du début du tableau dans le document.

rowIndices[]

integer

Liste des indices de ligne basés sur zéro dont le style doit être mis à jour. Si aucun indice n'est spécifié, toutes les lignes sont 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é. Une seule "*" peut servir de raccourci pour répertorier chaque champ.

Par exemple, pour mettre à jour la hauteur minimale des lignes, 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é dans la réponse d'une requête GET.

uri

string

URI de la nouvelle image.

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

La longueur de 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. En cas d'omission, la requête est appliquée au premier onglet.

Dans un document contenant un seul onglet:

  • Si fourni, doit correspondre à l'ID de l'onglet unique.

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

  • En cas d'omission, la requête s'applique au premier onglet du document.

ImageReplaceMethod

Méthode de remplacement d'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 Échelle et centre l'image 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 rendu de l'image est 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 sur le document.

Certaines modifications de style de document peuvent entraîner d'autres modifications, qui reflètent 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é. Une seule "*" peut servir de raccourci pour répertorier chaque champ.

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

tabId

string

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

Dans un document contenant un seul onglet:

  • Si fourni, doit correspondre à l'ID de l'onglet unique.

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

Dans un document contenant plusieurs onglets :

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

  • S'il n'est pas fourni, la demande 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 du tableau spécifiant les cellules à fusionner.

Tout texte des cellules fusionnées sera concaténé et stocké dans la cellule "en-tête" de la plage. Il s'agit de la cellule en haut à gauche de la plage lorsque la direction du contenu est 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 où le tableau n'est pas rectangulaire), une erreur 400 "Mauvaise requête" est renvoyée.

UnmergeTableCellsRequest

Défusionne les cellules d'une Table.

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

object (TableRange)

Plage de la table spécifiant les cellules de la table à dissocier.

Toutes les cellules fusionnées de cette plage seront annulées, et les cellules dont la fusion a déjà été annulée ne seront pas affectées. Si la plage ne contient aucune cellule fusionnée, la requête ne sera pas exécutée.

Si du texte figure dans l'une des cellules fusionnées, il reste dans la cellule "en-tête" du bloc de cellules non fusionnées qui en résulte. La cellule "head" est celle située en haut à gauche lorsque le sens du contenu est de gauche à droite, et celle située en haut à droite dans le cas contraire.

CreateHeaderRequest

Crée un objet Header. Le nouvel en-tête est appliqué à l'SectionStyle à l'emplacement de l'SectionBreak, le cas échéant. Sinon, il est appliqué à l'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 l'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 que vous pouvez créer

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

CreateFooterRequest

Crée un objet Footer. Le nouveau pied de page est appliqué au SectionStyle à l'emplacement du SectionBreak, le cas échéant. Sinon, il est appliqué au DocumentStyle.

Si un pied de page du type spécifié existe déjà, une erreur 400 "Mauvaise requête" 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)

L'emplacement SectionBreak qui précède immédiatement la section dont SectionStyle auquel 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 Footnote segment et insère un nouveau segment FootnoteReference à l'emplacement indiqué.

Les nouvelles Footnote contient un espace suivi d'un caractère de retour à la 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 à la note de bas de page. footnote_reference_location ne peut être que l'un des éléments suivants:
location

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 à la note de bas de page doit être insérée à l'intérieur des limites d'un Paragraph Par exemple, elle ne peut pas être insérée au niveau de l'index de début d'une table (c'est-à-dire entre la table et le paragraphe qui le précède).

Les références de note 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 à des notes de bas de page ne peuvent être insérées que dans le corps, segment ID le champ doit être vide.

endOfSegmentLocation

object (EndOfSegmentLocation)

Insère la référence à 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 ou 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, le champ segment ID doit être vide.

ReplaceNamedRangeContentRequest

Remplace le contenu de la requête NamedRange ou NamedRanges avec le contenu de remplacement donné.

Notez qu'une personne NamedRange peut être constitué de plusieurs ranges Dans ce cas, seul le contenu de la première plage sera remplacé. Les autres plages et leur contenu seront supprimés.

Si le remplacement ou la suppression de plages entraîne une structure de document non valide, une erreur de requête incorrecte 400 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 se produit. En cas d'omission, 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 unique.

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

Dans un document contenant plusieurs onglets:

  • Si elle est fournie, le remplacement s'applique aux onglets spécifiés.

  • En cas d'omission, le remplacement s'applique à tous les onglets.

Champ d'union replacement_content Contenu par lequel remplacer 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 donné, une erreur 400 "Mauvaise requête" est renvoyée.

namedRangeName

string

Le nom de la NamedRanges dont le contenu sera remplacé.

S'il existe plusieurs named ranges par le nom donné, le contenu de chacun d'eux sera remplacé. Si aucune plage nommée ne porte le nom donné, la requête n'aura aucun effet.

UpdateSectionStyleRequest

Met à jour l'objet SectionStyle.

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

object (Range)

Plage chevauchant les sections à styliser.

Étant donné que les sauts de section ne peuvent être insérés que dans le corps du texte, le segment ID le champ doit être vide.

sectionStyle

object (SectionStyle)

Styles à définir sur la section.

Certaines modifications de style de section peuvent entraîner d'autres modifications, qui reflètent le comportement de l'éditeur Docs. Consultez la documentation SectionStyle pour en savoir plus.

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é. 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ù la coupure sera insérée. insertion_location ne peut être que l'un des éléments suivants:
location

object (Location)

Insère une nouvelle ligne et un saut de section à un indice spécifique dans le document.

Le saut de section doit être inséré à l'intérieur des limites d'un Paragraph Par exemple, vous ne pouvez pas l'insérer à l'index de début d'un tableau (c'est-à-dire entre le tableau et le paragraphe précédent).

Vous ne pouvez pas insérer de coupures de section dans un tableau, une équation, une note de bas de page, un en-tête ni un pied de page. Étant donné que les sauts de section ne peuvent être insérés que dans le corps du texte, le segment ID le champ 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 une note de bas de page, un en-tête ni un pied de page. Étant donné que les coupures de section ne peuvent être insérées que dans le 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. Il n'existe donc aucun en-tête de ce type pour la première section du document. Si cet en-tête est défini sur SectionStyle, la référence à cet en-tête est supprimée, et l'en-tête de ce type a été repris à partir de la section précédente.

tabId

string

Onglet contenant l'en-tête à supprimer. En cas d'omission, la requête est appliquée au premier onglet.

Dans un document contenant un seul onglet:

  • Si fourni, doit correspondre à l'ID de l'onglet unique.

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

  • En cas d'omission, 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

Identifiant 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 entraîne l'absence de pied de page de ce type pour la première section du document. Si ce pied de page est défini SectionStyle, la référence à ce pied de page est supprimée. Le pied de page de ce type a été repris à partir de la section précédente.

tabId

string

Onglet qui contient le pied de page à supprimer. En cas d'omission, la requête est appliquée au premier onglet.

Dans un document contenant un seul onglet:

  • Si fourni, doit correspondre à l'ID de l'onglet unique.

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

  • En cas d'omission, la requête s'applique au premier onglet du document.

PinTableHeaderRowsRequest

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

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

object (Location)

Emplacement du début du tableau dans le document.

pinnedHeaderRowsCount

integer

Nombre de lignes de la table à épingler, où 0 signifie que toutes les lignes sont désépinglées.