Requests

{

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

object (ReplaceAllTextRequest)

Remplace toutes les instances du texte spécifié.

object (InsertTextRequest)

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

object (UpdateTextStyleRequest)

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

object (CreateParagraphBulletsRequest)

Crée des puces pour les paragraphes.

object (DeleteParagraphBulletsRequest)

Supprime les puces des paragraphes.

object (CreateNamedRangeRequest)

Crée une plage nommée.

object (DeleteNamedRangeRequest)

Supprime une plage nommée.

object (UpdateParagraphStyleRequest)

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

object (DeleteContentRangeRequest)

Supprime du contenu du document.

object (InsertInlineImageRequest)

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

object (InsertTableRequest)

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

object (InsertTableRowRequest)

Insère une ligne vide dans un tableau.

object (InsertTableColumnRequest)

Insère une colonne vide dans un tableau.

object (DeleteTableRowRequest)

Supprime une ligne d'une table.

object (DeleteTableColumnRequest)

Supprime une colonne d'une table.

object (InsertPageBreakRequest)

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

object (DeletePositionedObjectRequest)

Supprime un objet positionné du document.

object (UpdateTableColumnPropertiesRequest)

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

object (UpdateTableCellStyleRequest)

Met à jour le style des cellules du tableau.

object (UpdateTableRowStyleRequest)

Met à jour le style des lignes dans une table.

object (ReplaceImageRequest)

Remplace une image dans le document.

object (UpdateDocumentStyleRequest)

Met à jour le style du document.

object (MergeTableCellsRequest)

Fusionne des cellules dans un tableau.

object (UnmergeTableCellsRequest)

Désassemble les cellules d'un tableau.

object (CreateHeaderRequest)

Crée un en-tête.

object (CreateFooterRequest)

Crée un pied de page.

object (CreateFootnoteRequest)

Crée une note de bas de page.

object (ReplaceNamedRangeContentRequest)

Remplace le contenu d'une plage nommée.

object (UpdateSectionStyleRequest)

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

object (InsertSectionBreakRequest)

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

object (DeleteHeaderRequest)

Supprime un en-tête du document.

object (DeleteFooterRequest)

Supprime un pied de page du document.

object (PinTableHeaderRowsRequest)

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

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

string

Texte qui remplacera le texte correspondant.

object (TabsCriteria)

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

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

Dans un document contenant un seul onglet:

• Si fourni, 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.

object (SubstringMatchCriteria)

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

{
  "text": string,
  "matchCase": boolean
}

string

Texte à rechercher dans le document.

boolean

Indique si la recherche doit respecter la casse:

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

{
  "tabIds": [
    string
  ]
}

string

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

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

string

Texte à insérer.

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

Les styles de texte pour le 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 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é.

object (Location)

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

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

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.

{
  "segmentId": string,
  "index": integer,
  "tabId": string
}

string

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

integer

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

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

string

Onglet dans lequel se trouve 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 fourni, la requête s'applique à l'onglet spécifié.

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

{
  "segmentId": string,
  "tabId": string
}

string

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

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 fourni, la requête s'applique à l'onglet spécifié.

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

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

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 afin de refléter le comportement de l'éditeur Docs. Pour en savoir plus, consultez la documentation de TextStyle.

string (FieldMask format)

Champs à mettre à jour.

Vous devez spécifier au moins un champ. Le textStyle 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 mettre en gras le style de texte, définissez fields sur "bold".

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

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.

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

{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}

object (Range)

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

enum (BulletGlyphPreset)

Types de glyphes à utiliser.

{
  "range": {
    object (Range)
  }
}

object (Range)

Plage à partir de laquelle supprimer les puces.

{
  "name": string,
  "range": {
    object (Range)
  }
}

string

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

Les noms doivent comporter au moins un caractère et pas plus de 256 caractères, mesurés en unités de code UTF-16.

object (Range)

Plage à laquelle appliquer le nom.

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

object (TabsCriteria)

Facultatif. Critères utilisés pour spécifier dans quel ou quels onglets la suppression de la plage doit s'effectuer. Si elle est omise, la suppression de la plage s'applique à tous les onglets.

Dans un document contenant un seul onglet:

• Si fourni, 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.

string

Identifiant de la plage nommée à supprimer.

string

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

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

object (ParagraphStyle)

Styles à définir sur les paragraphes.

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

string (FieldMask format)

Champs à mettre à jour.

Vous devez spécifier au moins un champ. 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.

object (Range)

Plage chevauche les paragraphes à mettre en forme.

{
  "range": {
    object (Range)
  }
}

object (Range)

Plage de contenus à supprimer.

Si vous supprimez du texte qui traverse une limite de paragraphe, les styles de paragraphe, les listes, les objets positionnés et les signets peuvent être modifiés lorsque les deux paragraphes sont fusionnés.

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.
• Suppression du dernier caractère de nouvelle ligne d'un Body, Header, Footer, Footnote, TableCell ou TableOfContents.
• Suppression du début ou de la fin d'un élément Table, TableOfContents ou Equation sans supprimer l'élément entier.
• 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.

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

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 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 au public et ne pas dépasser 2 ko. L'URI lui-même est enregistré avec l'image et exposé via le champ ImageProperties.content_uri.

object (Size)

Taille 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 spécifiées, l'image est redimensionnée pour s'adapter aux dimensions fournies tout en conservant son format.

object (Location)

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

L'image doit être insérée dans les limites d'un Paragraph existant. Par exemple, 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.

object (EndOfSegmentLocation)

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

Vous ne pouvez pas insérer d'images intégrées dans une note de bas de page.

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

integer

Nombre de lignes dans la table.

integer

Nombre de colonnes dans la table.

object (Location)

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

Un caractère de nouvelle ligne est inséré avant la table insérée. Par conséquent, l'index de début de la table correspond à l'index d'emplacement spécifié + 1.

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

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

object (EndOfSegmentLocation)

Insère le tableau à la fin de l'en-tête, du pied de page ou du corps du document donné. 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.

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}

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 fusionnée, une nouvelle ligne est insérée au-dessus (ou en dessous) de la cellule fusionnée.

boolean

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

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

{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}

object (Location)

Emplacement du début du tableau dans le document.

integer

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

integer

Indice de colonne en base 0. Par exemple, la deuxième colonne de la table a un indice de colonne de 1.

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}

object (TableCellLocation)

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

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

boolean

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

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

{
  "tableCellLocation": {
    object (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 s'étendant sur plusieurs lignes, toutes les lignes concernées seront supprimées. Si aucune ligne ne reste dans la table après cette suppression, la table entière est supprimée.

{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}

object (TableCellLocation)

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

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

{

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

object (Location)

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

Le saut de page doit être inséré dans les limites d'un Paragraph existant. 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.

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.

{
  "objectId": string,
  "tabId": string
}

string

Identifiant de l'objet positionné à supprimer.

string

Onglet dans lequel se trouve l'objet à 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 fourni, la requête s'applique à l'onglet spécifié.

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

{
  "tableStartLocation": {
    object (Location)
  },
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}

object (Location)

Emplacement du début du tableau dans le document.

integer

Liste des indices 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 sont mises à jour.

object (TableColumnProperties)

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

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

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

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

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

object (TableCellStyle)

Style à appliquer aux cellules du tableau.

Lorsque vous modifiez les bordures, si une cellule partage une bordure avec une cellule adjacente, la propriété de bordure correspondante de la cellule adjacente est également 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 de bordure en conflit, les mises à jour de bordure sont appliquées dans l'ordre suivant:

• borderRight
• borderLeft
• borderBottom
• borderTop

string (FieldMask format)

Champs à mettre à jour.

Vous devez spécifier au moins un champ. Le tableCellStyle 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 couleur d'arrière-plan des cellules de la table, définissez fields sur "backgroundColor".

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

object (TableRange)

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

object (Location)

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

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}

object (TableCellLocation)

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

integer

Nombre de lignes de la plage du tableau.

integer

Nombre de colonnes de la plage du tableau.

{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}

object (Location)

Emplacement du début du tableau dans le document.

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.

object (TableRowStyle)

Styles à définir sur les lignes.

string (FieldMask format)

Champs à mettre à jour.

Vous devez spécifier au moins un champ. Le tableRowStyle 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 mettre à jour la hauteur minimale des lignes, définissez fields sur "minRowHeight".

{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "tabId": string
}

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.

string

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 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 doit pas dépasser 2 ko. L'URI est enregistré avec l'image et exposé via le champ ImageProperties.source_uri.

enum (ImageReplaceMethod)

Méthode de remplacement.

string

Onglet dans lequel se trouve l'image à remplacer. 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 fourni, la requête s'applique à l'onglet spécifié.

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

{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string,
  "tabId": string
}

object (DocumentStyle)

Styles à définir sur le document.

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

string (FieldMask format)

Champs à mettre à jour.

Vous devez spécifier au moins un champ. Le documentStyle 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 mettre à jour l'arrière-plan, définissez fields sur "background".

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

• Si cet élément n'est pas fourni, la requête s'applique au premier onglet du document.

{
  "tableRange": {
    object (TableRange)
  }
}

object (TableRange)

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

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

{
  "tableRange": {
    object (TableRange)
  }
}

object (TableRange)

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

Toutes les cellules fusionnées de cette plage seront dissociées, et les cellules déjà dissociées 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.

{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}

enum (HeaderFooterType)

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

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 à la première section. DocumentStyle

{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}

enum (HeaderFooterType)

Type de pied de page à créer.

object (Location)

Emplacement de l'SectionBreak immédiatement avant la section dont le SectionStyle doit appartenir à ce pied de page. 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.

{

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

object (Location)

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

La référence de la note de bas de page doit être insérée dans les limites d'un Paragraph existant. 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).

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

object (EndOfSegmentLocation)

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

Les références à des notes de bas de page ne peuvent pas être insérées dans un en-tête, un pied de page 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.

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

object (TabsCriteria)

Facultatif. Critères utilisés pour spécifier dans quels onglets le remplacement se produit. Si cette valeur est omise, le remplacement s'applique à tous les onglets.

Dans un document contenant un seul onglet:

• Si fourni, 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.

string

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

string

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

Si aucune plage nommée ne correspond à l'ID donné, une erreur 400 "Mauvaise requête" est renvoyée.

string

Nom de l'NamedRanges dont le contenu sera remplacé.

Si plusieurs named ranges portent le même nom, le contenu de chacune d'elles sera remplacé. Si aucune plage nommée ne porte le nom donné, la requête n'aura aucun effet.

{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}

object (Range)

Plage chevauchant les sections à styliser.

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

object (SectionStyle)

Styles à définir sur la section.

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

string (FieldMask format)

Champs à mettre à jour.

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

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

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

enum (SectionType)

Type de section à insérer.

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é dans les limites d'un Paragraph existant. 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 ou 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.

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 coupure de section dans une note de bas de page, un en-tête ou 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.

{
  "headerId": string,
  "tabId": string
}

string

ID de l'en-tête à supprimer. Si cet en-tête est défini sur DocumentStyle, la référence à cet en-tête est supprimée, ce qui entraîne l'absence d'en-tête de ce type pour la première section du document. Si cet en-tête est défini sur un SectionStyle, la référence à cet en-tête est supprimée et l'en-tête de ce type est désormais repris à partir de la section précédente.

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 fourni, la requête s'applique à l'onglet spécifié.

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

{
  "footerId": string,
  "tabId": string
}

string

ID du pied de page à supprimer. Si ce pied de page est défini sur DocumentStyle, la référence à ce pied de page est supprimée, ce qui 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 sur un SectionStyle, la référence à ce pied de page est supprimée et le pied de page de ce type est désormais repris à partir de la section précédente.

string

Onglet contenant 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 fourni, la requête s'applique à l'onglet spécifié.

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

{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}

object (Location)

Emplacement du début du tableau dans le document.

integer

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