Requête
Une seule mise à jour à appliquer à un document.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union
request Requête spécifique à appliquer. Un seul champ est obligatoire.
request
ne peut être que l'un des éléments suivants:
|
|
replaceAllText
|
Remplace toutes les instances du texte spécifié. |
insertText
|
Insère du texte à l'emplacement spécifié. |
updateTextStyle
|
Met à jour le style de texte selon la plage spécifiée. |
createParagraphBullets
|
Crée des puces pour les paragraphes. |
deleteParagraphBullets
|
Supprime les puces des paragraphes. |
createNamedRange
|
Crée une plage nommée. |
deleteNamedRange
|
Supprime une plage nommée. |
updateParagraphStyle
|
Met à jour le style de paragraphe à la plage spécifiée. |
deleteContentRange
|
Supprime le contenu du document. |
insertInlineImage
|
Insère une image intégrée à l'emplacement spécifié. |
insertTable
|
Insère un tableau à l'emplacement spécifié. |
insertTableRow
|
Insère une ligne vide dans un tableau. |
insertTableColumn
|
Insère une colonne vide dans un tableau. |
deleteTableRow
|
Supprime une ligne d'une table. |
deleteTableColumn
|
Supprime une colonne d'une table. |
insertPageBreak
|
Insère un saut de page à l'emplacement spécifié. |
deletePositionedObject
|
Supprime un objet positionné du document. |
updateTableColumnProperties
|
Met à jour les propriétés des colonnes d'une table. |
updateTableCellStyle
|
Met à jour le style des cellules du tableau. |
updateTableRowStyle
|
Met à jour le style des lignes d'un tableau. |
replaceImage
|
Remplace une image du document. |
updateDocumentStyle
|
Met à jour le style du document. |
mergeTableCells
|
Fusionne les cellules d'un tableau. |
unmergeTableCells
|
Annule la fusion des cellules d'un tableau. |
createHeader
|
Crée un en-tête. |
createFooter
|
Crée un pied de page. |
createFootnote
|
Crée une note de bas de page. |
replaceNamedRangeContent
|
Remplace le contenu d'une plage nommée. |
updateSectionStyle
|
Met à jour le style de section de la plage spécifiée. |
insertSectionBreak
|
Insère un saut de section à l'emplacement spécifié. |
deleteHeader
|
Supprime un en-tête du document. |
deleteFooter
|
Supprime un pied de page du document. |
pinTableHeaderRows
|
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 ( |
Champs | |
---|---|
replaceText
|
Texte qui remplacera le texte correspondant. |
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:
Dans un document contenant plusieurs onglets:
|
Champ d'union
criteria Critères utilisés pour faire correspondre le texte à remplacer.
criteria
ne peut être que l'un des éléments suivants:
|
|
containsText
|
Trouve 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
|
Texte à rechercher dans le document. |
matchCase
|
Indique si la recherche doit respecter 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[]
|
Liste des ID d'onglet dans lesquels la requête est exécutée. |
InsertTextRequest
Insère du texte à l'emplacement spécifié.
Représentation JSON |
---|
{ "text": string, // Union field |
Champs | |
---|---|
text
|
Texte à insérer.
L'insertion d'un caractère de nouvelle ligne crée implicitement un nouveau
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 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 certains 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 que l'un des éléments suivants:
|
|
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
|
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
|
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
|
L'index basé sur zéro, en unités de code UTF-16.
L'indice est relatif au début du segment spécifié par
|
tabId
|
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:
Dans un document contenant plusieurs onglets:
|
EndOfSegmentLocation
Emplacement à la fin du corps, d'un en-tête, d'un pied de page ou d'une note de bas de page. La position est située juste avant la dernière nouvelle ligne dans le segment de document.
Représentation JSON |
---|
{ "segmentId": string, "tabId": string } |
Champs | |
---|---|
segmentId
|
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. |
tabId
|
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:
Dans un document contenant plusieurs onglets:
|
UpdateTextStyleRequest
Modifiez le style du texte.
Représentation JSON |
---|
{ "textStyle": { object ( |
Champs | |
---|---|
textStyle
|
Styles à appliquer au 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
|
fields
|
Champs à mettre à jour.
Vous devez spécifier au moins un champ. La racine
Par exemple, pour mettre le style du texte en gras, définissez
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é pour la mise à jour du style de texte.
insertion_location
ne peut être que l'un des éléments suivants:
|
|
range
|
Plage de texte auquel appliquer un style. 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. |
CreateParagraphBulletsRequest
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 du début devant chaque paragraphe. Pour éviter un espace excessif entre la puce et le paragraphe correspondant, cette requête supprime ces tabulations de début. 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 ( |
Champs | |
---|---|
range
|
Plage à laquelle appliquer le préréglage de puce. |
bulletPreset
|
Types de glyphes de puces à utiliser. |
BulletGlyphPreset
Modèles de glyphes à puces prédéfinis 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 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
: losange plein, correspondant à un point de code Unicode U+25c6 -
DIAMONDX
: losange suivi d'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, tel que "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, tel que "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
|
Une liste à puces avec une
DISC ,
CIRCLE
et
SQUARE
une puce pour les 3 premiers niveaux d'imbrication de liste.
|
BULLET_DIAMONDX_ARROW3D_SQUARE
|
Une liste à puces avec une
DIAMONDX ,
ARROW3D
et
SQUARE
une puce pour les 3 premiers niveaux d'imbrication de liste.
|
BULLET_CHECKBOX
|
Une liste à puces avec
CHECKBOX
des puces pour tous les niveaux d'imbrication de liste.
|
BULLET_ARROW_DIAMOND_DISC
|
Une liste à puces avec une
ARROW ,
DIAMOND
et
DISC
une puce pour les 3 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
|
Une liste à puces avec une
DIAMONDX ,
HOLLOWDIAMOND
et
SQUARE
une puce pour les 3 premiers niveaux d'imbrication de liste.
|
BULLET_DIAMOND_CIRCLE_SQUARE
|
Une liste à puces avec une
DIAMOND ,
CIRCLE
et
SQUARE
une puce pour les 3 premiers niveaux d'imbrication de liste.
|
NUMBERED_DECIMAL_ALPHA_ROMAN
|
Une liste numérotée avec
DECIMAL ,
ALPHA
et
ROMAN
des glyphes numériques pour les 3 premiers niveaux d'imbrication de liste, suivis de points.
|
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS
|
Une liste numérotée avec
DECIMAL ,
ALPHA
et
ROMAN
des glyphes numériques pour les 3 premiers niveaux d'imbrication de liste, suivis de parenthèses.
|
NUMBERED_DECIMAL_NESTED
|
Une liste numérotée avec
DECIMAL
glyphes numériques séparés par un point, chaque niveau d'imbrication utilisant 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 (
|
Champs | |
---|---|
range
|
Plage dans laquelle supprimer les puces. |
CreateNamedRangeRequest
Crée un
NamedRange
en faisant référence à la plage donnée.
Représentation JSON |
---|
{
"name": string,
"range": {
object (
|
Champs | |
---|---|
name
|
Nom de la plage 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
|
Plage à laquelle appliquer le nom. |
DeleteNamedRangeRequest
Supprime un
NamedRange
Représentation JSON |
---|
{ "tabsCriteria": { object ( |
Champs | |
---|---|
tabsCriteria
|
Facultatif. Critères utilisés pour spécifier le ou les onglets dans lesquels la suppression de la plage doit être effectuée. En cas d'omission, la suppression de la plage est appliquée à tous les onglets. Dans un document contenant un seul onglet:
Dans un document contenant plusieurs 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 que l'un des éléments suivants:
|
|
namedRangeId
|
Identifiant de la plage nommée à supprimer. |
name
|
Nom 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 ( |
Champs | |
---|---|
paragraphStyle
|
Styles à définir sur les paragraphes.
Certaines modifications de style de paragraphe peuvent entraîner d'autres modifications, qui reflètent le comportement de l'éditeur Docs. Consultez la documentation
|
fields
|
Champs à mettre à jour.
Vous devez spécifier au moins un champ. La racine
Par exemple, pour mettre à jour la propriété d'alignement du style de paragraphe, définissez
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é pour la mise à jour du style de paragraphe.
insertion_location
ne peut être que l'un des éléments suivants:
|
|
range
|
Plage chevauchant les paragraphes auxquels appliquer un style. |
DeleteContentRangeRequest
Supprime le contenu du document.
Représentation JSON |
---|
{
"range": {
object (
|
Champs | |
---|---|
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. Toute tentative de suppression de certaines plages peut entraîner une structure de document non valide, auquel cas une erreur "400" est renvoyée. Voici quelques exemples de demandes de suppression non valides:
|
InsertInlineImageRequest
Insère un
InlineObject
contenant une image à l'emplacement indiqué.
Représentation JSON |
---|
{ "uri": string, "objectSize": { object ( |
Champs | |
---|---|
uri
|
URI de l'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 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
|
objectSize
|
Taille à laquelle l'image doit s'afficher 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 de manière à 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 que l'un des éléments suivants:
|
|
location
|
Insère l'image à un indice spécifique du document.
L'image doit être insérée à l'intérieur des limites d'une
Les images intégrées ne peuvent pas être insérées dans une note de bas de page ou une équation. |
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 |
Champs | |
---|---|
rows
|
Nombre de lignes dans la table. |
columns
|
Nombre de colonnes du tableau. |
Champ d'union
insertion_location Emplacement où la table sera insérée.
insertion_location
ne peut être que l'un des éléments suivants:
|
|
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é à l'intérieur des limites d'un objet existant
Il n'est pas possible d'insérer un tableau dans une note de bas de page ou une équation. |
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é. Les tableaux ne peuvent pas être insérés dans une note de bas de page. |
InsertTableRowRequest
Insère une ligne vide dans un tableau.
Représentation JSON |
---|
{
"tableCellLocation": {
object (
|
Champs | |
---|---|
tableCellLocation
|
Emplacement de la cellule du tableau de référence à partir duquel 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
|
Permet d'insérer ou non une nouvelle ligne sous l'emplacement de la cellule de référence.
|
TableCellLocation
Emplacement d'une cellule unique dans un tableau.
Représentation JSON |
---|
{
"tableStartLocation": {
object (
|
Champs | |
---|---|
tableStartLocation
|
Emplacement de début du tableau dans le document. |
rowIndex
|
Index de ligne basé sur zéro Par exemple, l'index de ligne de la deuxième ligne du tableau est 1. |
columnIndex
|
Index de colonne basé sur zéro Par exemple, l'index de colonne de la deuxième colonne de la table est 1. |
InsertTableColumnRequest
Insère une colonne vide dans un tableau.
Représentation JSON |
---|
{
"tableCellLocation": {
object (
|
Champs | |
---|---|
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
|
Permet d'insérer ou non une nouvelle colonne à droite de l'emplacement de la cellule de référence.
|
DeleteTableRowRequest
Supprime une ligne d'une table.
Représentation JSON |
---|
{
"tableCellLocation": {
object (
|
Champs | |
---|---|
tableCellLocation
|
Emplacement de la cellule du tableau de référence à partir duquel 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. S'il ne reste aucune ligne dans la table après cette suppression, l'intégralité de la table est supprimée. |
DeleteTableColumnRequest
Supprime une colonne d'une table.
Représentation JSON |
---|
{
"tableCellLocation": {
object (
|
Champs | |
---|---|
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 incluses dans cette cellule 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 |
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
|
Insère le saut de page au niveau d'un index spécifique du document.
Le saut de page doit être inséré à l'intérieur des limites d'un
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 ni un pied de page. Étant donné que les sauts de page ne peuvent être insérés que dans le corps, le
|
endOfSegmentLocation
|
Insère un 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 ni un pied de page. Étant donné que les sauts de page ne peuvent être insérés que dans le corps, le
|
DeletePositionedObjectRequest
Supprime un
PositionedObject
du document.
Représentation JSON |
---|
{ "objectId": string, "tabId": string } |
Champs | |
---|---|
objectId
|
ID de l'objet positionné à supprimer. |
tabId
|
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:
Dans un document contenant plusieurs onglets:
|
UpdateTableColumnPropertiesRequest
Met à jour le
TableColumnProperties
de colonnes dans un tableau.
Représentation JSON |
---|
{ "tableStartLocation": { object ( |
Champs | |
---|---|
tableStartLocation
|
Emplacement de début du tableau dans le document. |
columnIndices[]
|
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
|
Propriétés de la colonne du tableau à mettre à jour.
Si la valeur de
|
fields
|
Champs à mettre à jour.
Vous devez spécifier au moins un champ. La racine
Par exemple, pour mettre à jour la largeur de colonne, définissez
|
UpdateTableCellStyleRequest
Met à jour le style d'une plage de cellules du tableau.
Représentation JSON |
---|
{ "tableCellStyle": { object ( |
Champs | |
---|---|
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, celles-ci sont appliquées dans l'ordre suivant:
|
fields
|
Champs à mettre à jour.
Vous devez spécifier au moins un champ. La racine
Par exemple, pour modifier la couleur d'arrière-plan des cellules du tableau, définissez
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
cells Cellules qui seront mises à jour.
cells
ne peut être que l'un des éléments suivants:
|
|
tableRange
|
Plage de la table représentant le sous-ensemble de la table auquel les mises à jour sont appliquées. |
tableStartLocation
|
Emplacement de 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 dans laquelle l'emplacement des cellules du tableau est égal à (tableStartLocation, line = 0, column = 0), l'intervalle de ligne = 3 et l'intervalle de colonnes = 2 spécifie les cellules suivantes:
[ x ][ x ][ ]
[ x ][ x ][ ]
[ x x x ]
Représentation JSON |
---|
{
"tableCellLocation": {
object (
|
Champs | |
---|---|
tableCellLocation
|
Emplacement de la cellule où commence la plage du tableau. |
rowSpan
|
Étendue des lignes de la plage du tableau. |
columnSpan
|
Étendue de colonne de la plage du tableau. |
UpdateTableRowStyleRequest
Met à jour le
TableRowStyle
de lignes dans une table.
Représentation JSON |
---|
{ "tableStartLocation": { object ( |
Champs | |
---|---|
tableStartLocation
|
Emplacement de début du tableau dans le document. |
rowIndices[]
|
Liste des index de ligne de base zéro dont le style doit être mis à jour. Si aucun index n'est spécifié, toutes les lignes sont mises à jour. |
tableRowStyle
|
Styles à définir sur les lignes. |
fields
|
Champs à mettre à jour.
Vous devez spécifier au moins un champ. La racine
Par exemple, pour mettre à jour la hauteur de ligne minimale, définissez
|
ReplaceImageRequest
Remplace une image existante par une nouvelle image.
Le remplacement d'une image supprime
image effects
à partir de l'image existante pour reproduire le comportement de l'éditeur Docs.
Représentation JSON |
---|
{
"imageObjectId": string,
"uri": string,
"imageReplaceMethod": enum (
|
Champs | |
---|---|
imageObjectId
|
ID de l'image existante qui sera remplacée. L'identifiant peut être récupéré à partir de la réponse d'une requête get. |
uri
|
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 ne doivent pas dépasser 50 Mo, ne doivent pas dépasser 25 mégapixels et doivent ê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 la
|
imageReplaceMethod
|
Méthode de remplacement. |
tabId
|
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:
Dans un document contenant plusieurs onglets:
|
ImageReplaceMethod
La 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
|
Redimensionne et centre l'image pour remplir les contours de l'image d'origine. L'image peut être recadrée afin de 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 (
|
Champs | |
---|---|
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. Consultez la documentation
|
fields
|
Champs à mettre à jour.
Vous devez spécifier au moins un champ. La racine
Par exemple, pour mettre à jour l'arrière-plan, définissez
|
tabId
|
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:
Dans un document contenant plusieurs onglets:
|
MergeTableCellsRequest
Fusionne les cellules d'une
Table
Représentation JSON |
---|
{
"tableRange": {
object (
|
Champs | |
---|---|
tableRange
|
Plage du tableau spécifiant les cellules à fusionner. Tout texte des cellules fusionnées sera concaténé et stocké dans la section "head" cellule de la plage. Il s'agit de la cellule supérieure gauche de la plage lorsque l'orientation du contenu est de gauche à droite et de la cellule supérieure droite de la plage dans le cas contraire. Si la plage est non rectangulaire (ce qui peut se produire dans certains cas lorsque la plage couvre des cellules déjà fusionnées ou lorsque le tableau est non rectangulaire), une erreur de requête incorrecte 400 est renvoyée. |
UnmergeTableCellsRequest
Annule la fusion des cellules d'une
Table
Représentation JSON |
---|
{
"tableRange": {
object (
|
Champs | |
---|---|
tableRange
|
Plage du tableau spécifiant les cellules du tableau dont la fusion doit être annulée. 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 pas de cellules fusionnées, la requête n'a aucun effet. S'il y a du texte dans l'une des cellules fusionnées, il restera dans la section "En-tête". cellule du bloc de cellules non fusionnées obtenu. La "tête" correspond à la cellule située 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
SectionBreak
s'il est spécifié, il s'applique
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 ( |
Champs | |
---|---|
type
|
Type d'en-tête à créer. |
sectionBreakLocation
|
L'emplacement
|
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 |
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
|
Insère la référence à la note de bas de page à un index spécifique du document.
La référence à la note de bas de page doit être insérée à l'intérieur des limites d'un
Il n'est pas possible d'insérer des références à des notes de bas de page dans une équation, un en-tête, un pied de page ou 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, le
|
endOfSegmentLocation
|
Insère la référence à la note de bas de page à la fin du corps du document.
Il n'est pas possible d'insérer des références à des notes de bas de page dans un en-tête, un pied de page ou 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, le
|
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 ( |
Champs | |
---|---|
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:
Dans un document contenant plusieurs onglets:
|
Champ d'union
replacement_content Contenu par lequel remplacer le contenu existant de la plage nommée.
replacement_content
ne peut être que l'un des éléments suivants:
|
|
text
|
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 que l'un des éléments suivants:
|
|
namedRangeId
|
ID de la plage nommée dont le contenu sera remplacé. Si aucune plage nommée ne correspond à l'ID donné, une erreur 400 "Requête incorrecte" est renvoyée. |
namedRangeName
|
Le nom du
S'il existe plusieurs
|
UpdateSectionStyleRequest
Met à jour le
SectionStyle
Représentation JSON |
---|
{ "range": { object ( |
Champs | |
---|---|
range
|
Plage chevauchant les sections auxquelles appliquer un style.
Étant donné que les sauts de section ne peuvent être insérés que dans le corps du texte, le
|
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
|
fields
|
Champs à mettre à jour.
Vous devez spécifier au moins un champ. La racine
Par exemple, pour modifier la marge gauche, définissez
|
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 ( |
Champs | |
---|---|
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
|
Insère un saut de ligne et un saut de section au niveau d'un index spécifique du document.
Le saut de section doit être inséré à l'intérieur des limites d'un
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 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
|
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 sauts de section ne peuvent être insérés que dans le corps du texte, le
|
DeleteHeaderRequest
Supprime un
Header
du document.
Représentation JSON |
---|
{ "headerId": string, "tabId": string } |
Champs | |
---|---|
headerId
|
Identifiant de l'en-tête à supprimer. Si cet en-tête est défini sur
|
tabId
|
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:
Dans un document contenant plusieurs onglets:
|
PinTableHeaderRowsRequest
Met à jour le nombre de lignes d'en-tête épinglées dans un tableau.
Représentation JSON |
---|
{
"tableStartLocation": {
object (
|
Champs | |
---|---|
tableStartLocation
|
Emplacement de début du tableau dans le document. |
pinnedHeaderRowsCount
|
Nombre de lignes du tableau à épingler (0 signifie que toutes les lignes sont retirées). |