Demande
Mise à jour unique à appliquer à un document.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union request . Demande 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 une table à 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
|
Fusionne les 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 une table. |
Remplacer AllTextRequest
Remplace toutes les instances de texte correspondant à un critère par replace text
.
Représentation JSON |
---|
{ "replaceText": string, // Union field |
Champs | |
---|---|
replaceText
|
Texte qui remplacera le texte correspondant. |
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
|
Recherche le texte correspondant à cette sous-chaîne dans le document. |
Sous-chaîne et critères
Critère correspondant à 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:
|
Insérer une requête textuelle
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 de texte du texte inséré sont déterminés automatiquement, en conservant généralement le style du texte voisin. Dans la plupart des cas, le style du texte inséré correspond au 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 Unicode de base multilingue (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 à un index spécifique du document.
Le texte doit être inséré dans les limites d'un objet |
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
Lieu spécifique dans le document.
Représentation JSON |
---|
{ "segmentId": string, "index": integer } |
Champs | |
---|---|
segmentId
|
ID de l'en-tête, du pied de page ou de la note de bas de page Un ID de segment vide correspond au corps du document. |
index
|
Index basé sur zéro, en unités de code UTF-16.
L'index est relatif au début du segment spécifié par |
Emplacement du segment
Emplacement à la fin d'un corps, d'un en-tête, d'un pied de page ou d'une note de bas de page Le lieu se trouve juste avant la dernière ligne dans la section de document.
Représentation JSON |
---|
{ "segmentId": string } |
Champs | |
---|---|
segmentId
|
ID de l'en-tête, du pied de page ou de la note de bas de page Un ID de segment vide correspond au corps du document. |
UpdateTextStyleRequest
Modifiez le style du texte.
Représentation JSON |
---|
{ "textStyle": { object ( |
Champs | |
---|---|
textStyle
|
Styles à définir sur le texte. Si la valeur d'un style particulier correspond à celle du parent, le style hérité sera défini.
Certaines modifications apportées au style du texte peuvent avoir une incidence sur le comportement de l'éditeur Docs. Pour en savoir plus, consultez la documentation sur |
fields
|
Champs à mettre à jour.
Au moins un champ doit être spécifié. La racine
Par exemple, pour mettre le style de texte en gras, définissez Pour rétablir une valeur par défaut d'une propriété, incluez son nom dans le masque de champ, mais ne définissez pas le champ lui-même. |
Champ d'union insertion_location . Type de plage utilisé pour la modification du style de texte.
insertion_location ne peut être que l'un des éléments suivants:
|
|
range
|
Plage de texte à appliquer au style. La plage peut être étendue pour inclure les retours à la 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 requête UpdateTextStyleRequest relative. |
CreateParagraphBulletsRequest
crée des puces pour tous les paragraphes qui se chevauchent dans la plage donnée ;
Le niveau d'imbrication de chaque paragraphe est déterminé en comptabilisant les onglets devant chaque paragraphe. Pour éviter un excès d'espace entre la puce et le paragraphe correspondant, ces onglets sont supprimés. Cela peut avoir un impact sur l'index de parties du texte.
Si le paragraphe situé juste avant la mise à jour d'un paragraphe figure dans une liste avec un préréglage correspondant, il est ajouté à cette liste.
Représentation JSON |
---|
{ "range": { object ( |
Champs | |
---|---|
range
|
Plage à laquelle appliquer le préréglage de puce. |
bulletPreset
|
Types de glyphes à puces. |
Préréglage pour BulletGlyphs
Modèles prédéfinis de glyphes à puces pour les listes.
Ces modèles utilisent les puces suivantes:
-
ARROW
: flèche, correspondant à un point de code Unicode U+2794 -
ARROW3D
: flèche en ombrage 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 fixe correspondant à un point de code Unicode U+25c6 -
DIAMONDX
: losange avec une croix (x) correspondant à un point de code Unicode U+2756 -
HOLLOWDIAMOND
: losange vide 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
: une étoile correspondant à un point de code Unicode U+2605 -
ALPHA
: lettre minuscule, comme "a", "b" ou "c". -
UPPERALPHA
: lettre majuscule, comme "A", "B" ou "C". -
DECIMAL
: nombre, tel que "1", "2" ou "3". -
ZERODECIMAL
: nombre dont les chiffres à un seul préfixe sont précédés 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 minuscule, comme "i", "ii" ou "iii". -
UPPERROMAN
: chiffre romain majuscule, comme "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 de glyphe à puces n'est pas spécifié. |
BULLET_DISC_CIRCLE_SQUARE
|
Une liste à puces contenant un glyphe à puces DISC , CIRCLE et SQUARE pour les trois premiers niveaux d'imbrication de listes.
|
BULLET_DIAMONDX_ARROW3D_SQUARE
|
Une liste à puces contenant un glyphe à puces DIAMONDX , ARROW3D et SQUARE pour les trois premiers niveaux d'imbrication de listes.
|
BULLET_CHECKBOX
|
Liste à puces contenant CHECKBOX glyphes de puce pour tous les niveaux d'imbrication de listes.
|
BULLET_ARROW_DIAMOND_DISC
|
Une liste à puces contenant un glyphe à puces ARROW , DIAMOND et DISC pour les trois premiers niveaux d'imbrication de listes.
|
BULLET_STAR_CIRCLE_SQUARE
|
Une liste à puces contenant un glyphe à puces STAR , CIRCLE et SQUARE pour les trois premiers niveaux d'imbrication de listes.
|
BULLET_ARROW3D_CIRCLE_SQUARE
|
Une liste à puces contenant un glyphe à puces ARROW3D , CIRCLE et SQUARE pour les trois premiers niveaux d'imbrication de listes.
|
BULLET_LEFTTRIANGLE_DIAMOND_DISC
|
Une liste à puces contenant un glyphe à puces LEFTTRIANGLE , DIAMOND et DISC pour les trois premiers niveaux d'imbrication de listes.
|
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE
|
Une liste à puces contenant un glyphe à puces DIAMONDX , HOLLOWDIAMOND et SQUARE pour les trois premiers niveaux d'imbrication de listes.
|
BULLET_DIAMOND_CIRCLE_SQUARE
|
Une liste à puces contenant un glyphe à puces DIAMOND , CIRCLE et SQUARE pour les trois premiers niveaux d'imbrication de listes.
|
NUMBERED_DECIMAL_ALPHA_ROMAN
|
Une liste numérotée avec DECIMAL , ALPHA et ROMAN glyphes numériques pour les trois premiers niveaux d'imbrication de liste, suivis de points.
|
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS
|
Une liste numérotée avec DECIMAL , ALPHA et ROMAN glyphes numériques pour les trois 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, où chaque niveau d'imbrication utilise le glyphe du niveau d'imbrication précédent comme préfixe. Exemple: "1", '1.1.', '2', "2.2."
|
NUMBERED_UPPERALPHA_ALPHA_ROMAN
|
Une liste numérotée avec UPPERALPHA , ALPHA et ROMAN glyphes numériques pour les trois premiers niveaux d'imbrication de liste, suivis de points.
|
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL
|
Une liste numérotée avec UPPERROMAN , UPPERALPHA et DECIMAL glyphes numériques pour les trois premiers niveaux d'imbrication de liste, suivis de points.
|
NUMBERED_ZERODECIMAL_ALPHA_ROMAN
|
Une liste numérotée avec ZERODECIMAL , ALPHA et ROMAN glyphes numériques pour les trois premiers niveaux d'imbrication de liste, suivis de points.
|
DeleteParagraphBulletsRequest
Supprime les puces de tous les paragraphes qui se chevauchent dans la plage donnée.
Le niveau d'imbrication de chaque paragraphe est visuellement conservé en ajoutant un retrait au début du paragraphe correspondant.
Représentation JSON |
---|
{
"range": {
object (
|
Champs | |
---|---|
range
|
Plage pour laquelle supprimer des puces. |
CreateNamedRangeRequest
Crée un NamedRange
faisant référence à la plage donnée.
Représentation JSON |
---|
{
"name": string,
"range": {
object (
|
Champs | |
---|---|
name
|
Nom de la plage nommée. 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
|
Plage à laquelle appliquer le nom. |
DeleteNamedRangeRequest
Supprime une NamedRange
.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
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 que l'un des éléments suivants:
|
|
namedRangeId
|
Identifiant de la plage nommée à supprimer. |
name
|
Nom de la ou des plages à supprimer. Toutes les plages nommées portant le nom donné seront supprimées. |
UpdateParagraphStyleRequest
Modifiez le style de tous les paragraphes qui se chevauchent avec la plage donnée.
Représentation JSON |
---|
{ "paragraphStyle": { object ( |
Champs | |
---|---|
paragraphStyle
|
Styles à définir sur les paragraphes.
Certaines modifications apportées au style des paragraphes peuvent avoir une incidence sur le comportement de l'éditeur Docs. Pour en savoir plus, consultez la documentation sur |
fields
|
Champs à mettre à jour.
Au moins un champ doit être spécifié. La racine
Par exemple, pour mettre à jour la propriété d'alignement du style de paragraphe, définissez Pour rétablir une valeur par défaut d'une propriété, incluez son nom dans le masque de champ, mais ne définissez pas le champ lui-même. |
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 qui chevauche les paragraphes et les applique au style. |
DeleteContentRangeRequest
Supprime le contenu du document.
Représentation JSON |
---|
{
"range": {
object (
|
Champs | |
---|---|
range
|
Plage de contenus à supprimer. La suppression d'un texte qui dépasse une limite de paragraphe peut entraîner la modification des styles de paragraphe, des listes, des objets positionnés et des favoris lorsque les deux paragraphes sont fusionnés. Si vous tentez de supprimer certaines plages, la structure du document risque d'être incorrecte, auquel cas une erreur 400 de requête incorrecte sera renvoyée. Voici quelques exemples de demandes de suppression non valides:
|
InsertInlineImageRequest
Insère un InlineObject
contenant une image à l'emplacement donné.
Représentation JSON |
---|
{ "uri": string, "objectSize": { object ( |
Champs | |
---|---|
uri
|
URI de l'image. L'image est récupérée une fois au moment de l'insertion, et une copie est stocké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.
L'URI fourni doit être accessible publiquement et ne pas dépasser 2 Ko. L'URI proprement dit est enregistré avec l'image et exposé via le champ |
objectSize
|
La taille de l'image doit être affichée dans le document. Cette propriété est facultative, et 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 dimension est calculée pour conserver les proportions de l'image. * Si les valeurs de largeur et de hauteur sont spécifiées, l'image est mise à l'échelle afin qu'elle s'adapte 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 dans un index spécifique du document.
L'image doit être insérée dans les limites d'un élément 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. |
Insérer une table de requête
Insère une table à l'emplacement spécifié.
Un caractère de retour à la 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 dans la table. |
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 indice de modèle spécifique. Un caractère de retour à la ligne est inséré avant la table insérée. Par conséquent, l'index de début de la table correspond à l'indice d'emplacement spécifié + 1.
La table doit être insérée dans les limites d'une Impossible d'insérer des tableaux 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 de document donnés. Un caractère de retour à la ligne est inséré avant le tableau inséré. Impossible d'insérer des tableaux dans une note de bas de page. |
Insérer TableRowRequest
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 sera insérée au-dessus (ou en dessous) de la ligne dans laquelle se trouve la cellule de référence. Si la cellule de référence est une cellule fusionnée, une nouvelle ligne sera insérée au-dessus (ou en dessous) de la cellule fusionnée. |
insertBelow
|
Permet d'insérer une nouvelle ligne sous la cellule de référence.
|
Emplacement de la table
Emplacement d'une seule cellule dans un tableau.
Représentation JSON |
---|
{
"tableStartLocation": {
object (
|
Champs | |
---|---|
tableStartLocation
|
Emplacement où le tableau commence dans le document. |
rowIndex
|
Index de ligne basé sur zéro. Par exemple, la deuxième ligne du tableau a un index de ligne égal à 1. |
columnIndex
|
L'index de colonne basé sur zéro. Par exemple, la deuxième colonne du tableau a un index de colonne de 1. |
Insérer TableTableRequest
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 contenant la cellule de référence. Si la cellule de référence est une cellule fusionnée, une nouvelle colonne sera insérée à gauche (ou à droite) de la cellule fusionnée. |
insertRight
|
Permet d'insérer 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 dans lequel la ligne sera supprimée. La ligne couverte par cette cellule sera supprimée. S'il s'agit d'une cellule fusionnée qui s'étend sur plusieurs lignes, toutes les lignes de la cellule seront supprimées. S'il ne reste aucune ligne dans la table après cette suppression, la table entière sera 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 dans lequel la colonne sera supprimée. La colonne qui couvre cette cellule sera supprimée. S'il s'agit d'une cellule fusionnée qui s'étend sur plusieurs colonnes, toutes les colonnes de la cellule seront supprimées. S'il ne reste aucune colonne dans la table après la suppression, la table entière sera supprimée. |
Insérer une requête de coupure de page
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 d'insertion du saut de page.
insertion_location ne peut être que l'un des éléments suivants:
|
|
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'une balise
Impossible d'insérer des 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 |
endOfSegmentLocation
|
Insère un 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 ni un pied de page. Étant donné que les sauts de page ne peuvent être insérés que dans le corps, le champ |
DeletePositionedObjectRequest
Supprime un PositionedObject
du document.
Représentation JSON |
---|
{ "objectId": string } |
Champs | |
---|---|
objectId
|
ID de l'objet positionné à supprimer. |
UpdateTableColumnPropertiesRequest
Met à jour le TableColumnProperties
des colonnes d'une table.
Représentation JSON |
---|
{ "tableStartLocation": { object ( |
Champs | |
---|---|
tableStartLocation
|
Emplacement où le tableau commence dans le document. |
columnIndices[]
|
Liste des index de colonne basés sur zéro dont la propriété doit être mise à jour. Si aucun indice n'est spécifié, toutes les colonnes seront mises à jour. |
tableColumnProperties
|
Propriétés de la colonne du tableau à mettre à jour.
Si la valeur de |
fields
|
Champs à mettre à jour.
Au moins un champ doit être spécifié. La racine
Par exemple, pour mettre à jour la largeur de la colonne, définissez |
UpdateTableCellStyleRequest
Met à jour le style d'une plage de cellules du tableau.
Représentation JSON |
---|
{ "tableCellStyle": { object ( |
Champs | |
---|---|
tableCellStyle
|
Style à définir dans les 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 des cellules adjacentes dans la même requête peut entraîner des mises à jour des bordures en conflit, les mises à jour des bordures sont appliquées dans l'ordre suivant:
|
fields
|
Champs à mettre à jour.
Au moins un champ doit être spécifié. La racine
Par exemple, pour mettre à jour la couleur d'arrière-plan des cellules du tableau, définissez Pour rétablir une valeur par défaut d'une propriété, incluez son nom dans le masque de champ, mais ne définissez pas le champ lui-même. |
Champ d'union cells . Cellules qui seront mises à jour.
cells ne peut être que l'un des éléments suivants:
|
|
tableRange
|
Plage de tables représentant le sous-ensemble de la table auquel les mises à jour sont appliquées. |
tableStartLocation
|
Emplacement où le tableau commence dans le document. Si elle est spécifiée, les mises à jour sont appliquées à toutes les cellules de la table. |
Plage de tables
Une plage de tables 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, supposons que nous ayons une table trois x trois dans laquelle 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 du tableau = (tableStartLocation, line = 0, column = 0), span span = 3 et column span = 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 de la plage de la table. |
columnSpan
|
L'étendue des colonnes de la plage du tableau. |
UpdateTableRowStyleRequest
Met à jour le TableRowStyle
des lignes d'une table.
Représentation JSON |
---|
{ "tableStartLocation": { object ( |
Champs | |
---|---|
tableStartLocation
|
Emplacement où le tableau commence dans le document. |
rowIndices[]
|
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 sont mises à jour. |
tableRowStyle
|
Styles à définir sur les lignes. |
fields
|
Champs à mettre à jour.
Au moins un champ doit être spécifié. La racine
Par exemple, pour modifier la hauteur minimale des lignes, définissez |
Remplacer ImageRequest
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 (
|
Champs | |
---|---|
imageObjectId
|
ID de l'image existante qui sera remplacée. L'ID peut être récupéré à partir de la réponse à une requête get. |
uri
|
URI de la nouvelle image. L'image est récupérée une fois au moment de l'insertion, et une copie est stocké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 fournie ne peut pas dépasser 2 Ko. L'URI est enregistré avec l'image et exposé via le champ |
imageReplaceMethod
|
Méthode de remplacement. |
ImageReplaceMethod
La 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'échelle et centre le cadre de l'image d'origine. L'image peut être recadrée afin de remplir les contours de l'image d'origine. La taille d'affichage sera identique à celle de l'image d'origine. |
UpdateDocumentStyleRequest
Met à jour 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 changements afin de refléter le comportement de l'éditeur Docs. Pour en savoir plus, consultez la documentation sur |
fields
|
Champs à mettre à jour.
Au moins un champ doit être spécifié. La racine
Par exemple, pour mettre à jour l'arrière-plan, définissez |
Demande MergeTableCells
Fusionne les cellules d'une Table
.
Représentation JSON |
---|
{
"tableRange": {
object (
|
Champs | |
---|---|
tableRange
|
Plage qui spécifie les cellules de la table à fusionner. Le texte des cellules fusionnées sera concaténé et stocké dans la cellule "head" de la plage. Il s'agit de la cellule en haut à gauche de la plage lorsque l'orientation du contenu est de gauche à droite, et de la cellule en haut à droite de la plage dans le cas contraire. Si la plage est non rectangulaire (ce qui peut se produire dans les cas où elle couvre des cellules déjà fusionnées ou dont la table est non rectangulaire), une erreur 400 de requête incorrecte est renvoyée. |
UnmergeTableCellsRequest
Défusionne les cellules d'un Table
.
Représentation JSON |
---|
{
"tableRange": {
object (
|
Champs | |
---|---|
tableRange
|
Plage de tableaux spécifiant les cellules à défusionner. La fusion des cellules de cette plage ne sera pas affectée, et les cellules déjà fusionnées ne seront pas affectées. Si la plage ne comporte aucune cellule fusionnée, la requête n'aura aucun effet. Si l'une des cellules fusionnées contient du texte, il reste dans la cellule "head" du bloc de cellules non fusionné obtenu. La cellule "head" correspond à la cellule supérieure gauche lorsque la direction du contenu se trouve de gauche à droite, et en haut à droite dans le cas contraire. |
CreateHeaderRequest
Permet de créer un Header
. Le nouvel en-tête est appliqué au SectionStyle
à l'emplacement de SectionBreak
s'il est spécifié. Sinon, il est appliqué au DocumentStyle
.
Si un en-tête du type spécifié existe déjà, une erreur 400 de requête incorrecte est renvoyée.
Représentation JSON |
---|
{ "type": enum ( |
Champs | |
---|---|
type
|
Type d'en-tête à créer. |
sectionBreakLocation
|
Emplacement de |
CreateFootnoteRequest
Crée un segment Footnote
et y insère un nouveau FootnoteReference
à l'emplacement donné.
Le nouveau
segment
Footnote
contiendra un espace suivi d'un caractère de nouvelle ligne.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union footnote_reference_location . Emplacement d'insertion de la référence à une 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 à une note de bas de page pour un index spécifique du document.
La référence à la note de bas de page doit être insérée dans les limites d'un objet
Les références à des notes de bas de page ne peuvent pas être insérées dans une équation, un en-tête, un pied de page ou une note de bas de page. Étant donné que les références à une note de bas de page ne peuvent être insérées que dans le corps de la requête, le champ |
endOfSegmentLocation
|
Insère la référence à la note de bas de page à la fin du corps du document.
Vous ne pouvez pas insérer de 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 à une note de bas de page ne peuvent être insérées que dans le corps de la requête, le champ |
RemplacerNameRangeRangeRequest
Remplace le contenu de l'élément NamedRange
ou NamedRanges
spécifié par le contenu de remplacement indiqué.
Notez qu'une NamedRange
individuelle peut être constituée de plusieurs ranges
consécutives. 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 d'une plage entraînerait une structure de document non valide, une erreur 400 de requête incorrecte serait renvoyée.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union replacement_content . Contenu à remplacer par 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 aux plages nommées dont le contenu sera remplacé.
named_range_reference ne peut être que l'un des éléments suivants:
|
|
namedRangeId
|
Identifiant de la plage nommée dont le contenu sera remplacé. Si aucune plage nommée ne correspond à l'ID donné, une erreur 400 de requête incorrecte est renvoyée. |
namedRangeName
|
Nom de l'élément
Si plusieurs |
UpdateSectionStyleRequest
Met à jour SectionStyle
.
Représentation JSON |
---|
{ "range": { object ( |
Champs | |
---|---|
range
|
Plage qui chevauche les sections pour appliquer un style.
Étant donné que les sauts de section ne peuvent être insérés que dans le corps, le champ |
sectionStyle
|
Styles à définir dans la section.
Certaines modifications apportées au style des sections peuvent entraîner d'autres changements afin de refléter le comportement de l'éditeur Docs. Pour en savoir plus, consultez la documentation sur |
fields
|
Champs à mettre à jour.
Au moins un champ doit être spécifié. La racine
Par exemple, pour mettre à jour la marge gauche, définissez |
Insérer une section de demande
Insère un saut de section à l'emplacement indiqué.
Un caractère de retour à la 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 d'insertion de la coupure publicitaire.
insertion_location ne peut être que l'un des éléments suivants:
|
|
location
|
Insère une nouvelle 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
Impossible d'insérer des 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 |
endOfSegmentLocation
|
Insère une nouvelle ligne et un saut de section à la fin du corps du document.
Vous ne pouvez pas insérer de saut 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, le champ |
DeleteHeaderRequest
Supprime un Header
du document.
Représentation JSON |
---|
{ "headerId": string } |
Champs | |
---|---|
headerId
|
Identifiant de l'en-tête à supprimer. Si cet en-tête est défini sur |
Requête PinTableHeaderRows
Met à jour le nombre de lignes d'en-tête épinglées dans une table.
Représentation JSON |
---|
{
"tableStartLocation": {
object (
|
Champs | |
---|---|
tableStartLocation
|
Emplacement où le tableau commence dans le document. |
pinnedHeaderRowsCount
|
Nombre de lignes du tableau à épingler, où 0 signifie que toutes les lignes ont été retirées. |