- Ressource : Document
- Tabulation
- TabProperties
- DocumentTab
- Body
- StructuralElement
- Paragraphe
- ParagraphElement
- TextRun
- TextStyle
- OptionalColor
- Couleur
- RgbColor
- Dimension
- Unité
- WeightedFontFamily
- BaselineOffset
- Lien
- BookmarkLink
- HeadingLink
- SuggestedTextStyle
- TextStyleSuggestionState
- AutoText
- Type
- PageBreak
- ColumnBreak
- FootnoteReference
- HorizontalRule
- Équation
- InlineObjectElement
- Personne
- PersonProperties
- RichLink
- RichLinkProperties
- ParagraphStyle
- NamedStyleType
- Alignement
- ContentDirection
- SpacingMode
- ParagraphBorder
- DashStyle
- TabStop
- TabStopAlignment
- Ombre
- SuggestedParagraphStyle
- ParagraphStyleSuggestionState
- ShadingSuggestionState
- Puce
- SuggestedBullet
- BulletSuggestionState
- ObjectReferences
- SectionBreak
- SectionStyle
- SectionColumnProperties
- ColumnSeparatorStyle
- SectionType
- Table
- TableRow
- TableCell
- TableCellStyle
- TableCellBorder
- Alignement du contenu
- SuggestedTableCellStyle
- TableCellStyleSuggestionState
- TableRowStyle
- SuggestedTableRowStyle
- TableRowStyleSuggestionState
- TableStyle
- TableColumnProperties
- WidthType
- TableOfContents
- En-tête
- Pied de page
- Note
- DocumentStyle
- Contexte
- Taille
- SuggestedDocumentStyle
- DocumentStyleSuggestionState
- BackgroundSuggestionState
- SizeSuggestionState
- NamedStyles
- NamedStyle
- SuggestedNamedStyles
- NamedStylesSuggestionState
- NamedStyleSuggestionState
- Liste
- ListProperties
- NestingLevel
- Alignement des puces
- GlyphType
- SuggestedListProperties
- ListPropertiesSuggestionState
- NestingLevelSuggestionState
- NamedRanges
- NamedRange
- Plage
- InlineObject
- InlineObjectProperties
- EmbeddedObject
- EmbeddedDrawingProperties
- ImageProperties
- CropProperties
- EmbeddedObjectBorder
- PropertyState
- LinkedContentReference
- SheetsChartReference
- SuggestedInlineObjectProperties
- InlineObjectPropertiesSuggestionState
- EmbeddedObjectSuggestionState
- EmbeddedDrawingPropertiesSuggestionState
- ImagePropertiesSuggestionState
- CropPropertiesSuggestionState
- EmbeddedObjectBorderSuggestionState
- LinkedContentReferenceSuggestionState
- SheetsChartReferenceSuggestionState
- PositionedObject
- PositionedObjectProperties
- PositionedObjectPositioning
- PositionedObjectLayout
- SuggestedPositionedObjectProperties
- PositionedObjectPropertiesSuggestionState
- PositionedObjectPositioningSuggestionState
- SuggestionsViewMode
- Méthodes
Ressource : Document
Un document Google Docs.
Représentation JSON |
---|
{ "documentId": string, "title": string, "tabs": [ { object ( |
Champs | |
---|---|
documentId |
Uniquement en sortie. ID du document. |
title |
Titre du document. |
tabs[] |
Onglets faisant partie d'un document Les onglets peuvent contenir des onglets enfants, c'est-à-dire des onglets imbriqués dans un autre onglet. Les onglets enfants sont représentés par le champ |
revisionId |
Uniquement en sortie. ID de la révision du document. Peut être utilisée dans les requêtes de mise à jour pour spécifier la révision d'un document à laquelle appliquer les mises à jour et le comportement de la requête si le document a été modifié depuis cette révision. Ce champ n'est renseigné que si l'utilisateur est autorisé à modifier le document. L'ID de révision n'est pas un numéro séquentiel, mais une chaîne opaque. Le format de l'ID de révision peut changer au fil du temps. Un ID de révision renvoyé n'est valide que pendant 24 heures. Il ne peut pas être partagé entre les utilisateurs. Si l'ID de révision reste inchangé entre les appels, cela signifie que le document n'a pas changé. À l'inverse, un ID modifié (pour le même document et l'utilisateur) signifie généralement que le document a été mis à jour. Toutefois, un ID modifié peut également être dû à des facteurs internes, tels que des modifications de format. |
suggestionsViewMode |
Uniquement en sortie. Mode d'affichage des suggestions appliqué au document. Remarque : Lorsque vous modifiez un document, les modifications doivent être basées sur un document avec |
body |
Uniquement en sortie. Corps principal du document. Ancien champ: utilisez plutôt |
headers |
Uniquement en sortie. En-têtes du document, associés par ID d'en-tête. Ancien champ: utilisez plutôt |
footers |
Uniquement en sortie. Pieds de page du document, associés à un ID de pied de page. Ancien champ : utilisez plutôt |
footnotes |
Uniquement en sortie. Notes de bas de page du document, triées par ID de note de bas de page. Ancien champ : utilisez plutôt |
documentStyle |
Uniquement en sortie. Style du document. Ancien champ : utilisez plutôt |
suggestedDocumentStyleChanges |
Uniquement en sortie. Modifications suggérées pour le style du document, associées à l'ID de suggestion. Ancien champ : utilisez plutôt |
namedStyles |
Uniquement en sortie. Styles nommés du document. Ancien champ: utilisez plutôt |
suggestedNamedStylesChanges |
Uniquement en sortie. Modifications suggérées apportées aux styles nommés du document, triées par ID de suggestion. Ancien champ: utilisez plutôt |
lists |
Uniquement en sortie. Listes du document, classées par ID de liste. Ancien champ : utilisez plutôt |
namedRanges |
Uniquement en sortie. Plages nommées du document, regroupées par nom. Ancien champ : utilisez plutôt |
inlineObjects |
Uniquement en sortie. Objets intégrés au document, associés par ID d'objet Ancien champ: utilisez plutôt |
positionedObjects |
Uniquement en sortie. Objets positionnés dans le document, avec clé correspondant à l'ID de l'objet. Ancien champ: utilisez plutôt |
Tabulation
Onglet dans un document.
Représentation JSON |
---|
{ "tabProperties": { object ( |
Champs | |
---|---|
tabProperties |
Propriétés de l'onglet, comme l'ID et le titre. |
childTabs[] |
Onglets enfants imbriqués dans cet onglet |
Champ d'union content . Contenu de l'onglet. content ne peut être qu'un des éléments suivants : |
|
documentTab |
Onglet contenant le contenu du document, comme du texte et des images. |
TabProperties
Propriétés d'un onglet.
Représentation JSON |
---|
{ "tabId": string, "title": string, "parentTabId": string, "index": integer, "nestingLevel": integer } |
Champs | |
---|---|
tabId |
Uniquement en sortie. ID de l'onglet. Ce champ ne peut pas être modifié. |
title |
Nom visible par l'utilisateur de l'onglet. |
parentTabId |
Facultatif. ID de l'onglet parent. Ce champ est vide lorsque l'onglet actuel est un onglet racine, ce qui signifie qu'il n'a pas de parents. |
index |
Index basé sur zéro de l'onglet dans le parent. |
nestingLevel |
Uniquement en sortie. Profondeur de l'onglet dans le document. Les onglets de niveau racine commencent à 0. |
DocumentTab
Onglet contenant le contenu du document.
Représentation JSON |
---|
{ "body": { object ( |
Champs | |
---|---|
body |
Corps principal de l'onglet du document. |
headers |
En-têtes de l'onglet du document, triés par ID d'en-tête. |
footers |
Pieds de page de l'onglet du document, associés à un ID de pied de page. |
footnotes |
Les notes de bas de page de l'onglet du document, triées par ID de note de bas de page. |
documentStyle |
Style de l'onglet du document. |
suggestedDocumentStyleChanges |
Modifications suggérées pour le style de l'onglet du document, associées à l'ID de suggestion. |
namedStyles |
Styles nommés de l'onglet du document. |
suggestedNamedStylesChanges |
Modifications suggérées pour les styles nommés de l'onglet du document, associés par ID de suggestion. |
lists |
Listes de l'onglet des documents, associées par ID de liste. |
namedRanges |
Plages nommées dans l'onglet du document, regroupées par nom. |
inlineObjects |
Objets intégrés dans l'onglet du document, triés par ID d'objet. |
positionedObjects |
Objets positionnés dans l'onglet du document, triés par ID d'objet. |
Corps
Corps du document.
Le corps contient généralement l'intégralité du contenu du document, à l'exception de headers
, footers
et footnotes
.
Représentation JSON |
---|
{
"content": [
{
object ( |
Champs | |
---|---|
content[] |
Contenu du corps. Les index du contenu du corps commencent à zéro. |
StructuralElement
Un élément structurel décrit le contenu qui structure le document.
Représentation JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
Champs | |
---|---|
startIndex |
Indice de départ basé sur zéro de cet élément de structure, exprimé en unités de code UTF-16. |
endIndex |
Indice de fin de cet élément structurel, à partir de zéro, en unités de code UTF-16. |
Champ d'union content . Contenu de l'élément de structure. content ne peut être qu'un des éléments suivants : |
|
paragraph |
Type de paragraphe d'un élément de structure. |
sectionBreak |
Type de saut de section d'un élément de structure. |
table |
Type de tableau d'élément structurel. |
tableOfContents |
Type de table des matières d'un élément structurel. |
Paragraphe
Un élément StructuralElement
représentant un paragraphe. Un paragraphe est une plage de contenu se terminant par un caractère de nouvelle ligne.
Représentation JSON |
---|
{ "elements": [ { object ( |
Champs | |
---|---|
elements[] |
Contenu du paragraphe, décomposé en parties. |
paragraphStyle |
Style de ce paragraphe. |
suggestedParagraphStyleChanges |
Le style de paragraphe suggéré est appliqué à ce paragraphe, identifié par l'ID de suggestion. |
bullet |
Puce de ce paragraphe. En l'absence de cette balise, le paragraphe n'appartient à aucune liste. |
suggestedBulletChanges |
Modifications suggérées pour la puce de ce paragraphe. |
positionedObjectIds[] |
ID des objets positionnés associés à ce paragraphe. |
suggestedPositionedObjectIds |
ID des objets positionnés suggérés pour être joints à ce paragraphe, associés à l'ID de suggestion. |
ParagraphElement
Un ParagraphElement décrit le contenu d'un Paragraph
.
Représentation JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
Champs | |
---|---|
startIndex |
Index de départ basé sur zéro de cet élément de paragraphe, exprimé en unités de code UTF-16. |
endIndex |
Index de fin de base zéro de cet élément de paragraphe (exclusif), exprimé en unités de code UTF-16. |
Champ d'union content . Contenu de l'élément de paragraphe. content ne peut être qu'un des éléments suivants : |
|
textRun |
Élément de paragraphe d'exécution de texte. |
autoText |
Élément de paragraphe de texte automatique. |
pageBreak |
Élément de paragraphe de saut de page. |
columnBreak |
Élément de paragraphe de saut de colonne. |
footnoteReference |
Élément de paragraphe de référence à une note de bas de page. |
horizontalRule |
Élément de paragraphe avec ligne horizontale. |
equation |
Élément de paragraphe d'équation. |
inlineObjectElement |
Élément de paragraphe d'objet intégré. |
person |
Élément de paragraphe qui renvoie à une personne ou à une adresse e-mail. |
richLink |
Élément de paragraphe qui renvoie vers une ressource Google (fichier dans Google Drive, vidéo YouTube ou événement d'agenda, par exemple). |
TextRun
ParagraphElement
qui représente une séquence de texte ayant tous le même style.
Représentation JSON |
---|
{ "content": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Champs | |
---|---|
content |
Texte de cette exécution. Tous les éléments autres que textuels de l'exécution sont remplacés par le caractère Unicode U+E907. |
suggestedInsertionIds[] |
ID d'insertion suggérés. Un |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée. |
textStyle |
Style de texte de cette exécution. |
suggestedTextStyleChanges |
Le style de texte suggéré change pour cette exécution, associé à l'ID de suggestion. |
TextStyle
Représente le style pouvant être appliqué au texte.
Les styles de texte hérités sont représentés par des champs non définis dans ce message. Le parent d'un style de texte dépend de l'endroit où le style de texte est défini:
- Le style de texte d'un
Paragraph
hérite dunamed style type
correspondant au paragraphe. - Le TextStyle d'une
named style
hérite du style nomménormal text
. - Le style de texte du style nommé
normal text
hérite du style de texte par défaut de l'éditeur Docs. - Le style de texte d'un élément
Paragraph
contenu dans un tableau peut hériter du style de texte de celui du tableau.
Si le style de texte n'hérite pas d'un parent, la désactivation des champs rétablira le style sur une valeur correspondant aux valeurs par défaut dans l'éditeur Docs.
Représentation JSON |
---|
{ "bold": boolean, "italic": boolean, "underline": boolean, "strikethrough": boolean, "smallCaps": boolean, "backgroundColor": { object ( |
Champs | |
---|---|
bold |
Indique si le texte est affiché en gras ou non. |
italic |
Indique si le texte est en italique ou non. |
underline |
Indique si le texte est souligné ou non. |
strikethrough |
Indique si le texte est barré ou non. |
smallCaps |
Indique si le texte est en petites majuscules. |
backgroundColor |
Couleur d'arrière-plan du texte. Si elle est définie, la couleur est une couleur RVB ou transparente, en fonction du champ |
foregroundColor |
Couleur de premier plan du texte. S'il est défini, la couleur est soit une couleur RVB, soit transparente, en fonction du champ |
fontSize |
Taille de la police du texte. |
weightedFontFamily |
Famille de polices et épaisseur du texte. Si une requête de mise à jour spécifie des valeurs pour Si Si |
baselineOffset |
Décalage vertical du texte par rapport à sa position normale. Le texte avec des décalages de référence de |
link |
Destination du lien hypertexte du texte. Si cette règle n'est pas configurée, aucun lien n'est affiché. Les liens ne sont pas hérités du texte parent. Modifier le lien dans une requête de mise à jour entraîne d'autres modifications du style de texte de la plage :
|
OptionalColor
Couleur qui peut être soit totalement opaque, soit totalement transparente.
Représentation JSON |
---|
{
"color": {
object ( |
Champs | |
---|---|
color |
Si cette valeur est définie, elle sera utilisée comme couleur opaque. Si cette valeur n'est pas définie, il s'agit d'une couleur transparente. |
Couleur
Couleur unie.
Représentation JSON |
---|
{
"rgbColor": {
object ( |
Champs | |
---|---|
rgbColor |
Valeur de la couleur RVB. |
RgbColor
Couleur RVB.
Représentation JSON |
---|
{ "red": number, "green": number, "blue": number } |
Champs | |
---|---|
red |
Composant rouge de la couleur, de 0,0 à 1,0. |
green |
Composant vert de la couleur, compris entre 0,0 et 1,0. |
blue |
Composant bleu de la couleur, compris entre 0,0 et 1,0. |
Dimension
Magnitude dans une seule direction dans les unités spécifiées.
Représentation JSON |
---|
{
"magnitude": number,
"unit": enum ( |
Champs | |
---|---|
magnitude |
Amplitude. |
unit |
Unités de l'ampleur. |
Unité
Unités de mesure.
Enums | |
---|---|
UNIT_UNSPECIFIED |
Les unités sont inconnues. |
PT |
Un point, soit 1/72 pouce. |
WeightedFontFamily
Représente une famille de polices et l'épaisseur du texte.
Représentation JSON |
---|
{ "fontFamily": string, "weight": integer } |
Champs | |
---|---|
fontFamily |
Famille de polices du texte La famille de polices peut être n'importe quelle police du menu "Police" de Docs ou de Google Fonts. Si le nom de la police n'est pas reconnu, le texte s'affiche dans |
weight |
Épaisseur de la police. Ce champ peut prendre n'importe quelle valeur multiple de La valeur par défaut est L'épaisseur de la police ne constitue qu'un seul composant de l'épaisseur de la police affichée. Une combinaison de la valeur
|
BaselineOffset
Méthodes permettant de décaler verticalement le texte par rapport à sa position normale.
Enums | |
---|---|
BASELINE_OFFSET_UNSPECIFIED |
Le décalage de la ligne de base du texte est hérité du parent. |
NONE |
Le texte n'est pas décalé verticalement. |
SUPERSCRIPT |
Le texte est décalé verticalement vers le haut (exposant). |
SUBSCRIPT |
Le texte est décalé verticalement vers le bas (indice). |
Lien
Référence à une autre partie d'un document ou à une ressource d'URL externe.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union destination . Destination du lien. destination ne peut être qu'un des éléments suivants : |
|
url |
URL externe. |
tabId |
ID d'un onglet de ce document. |
bookmark |
Un signet dans ce document. Dans les documents contenant un seul onglet, les liens vers les signets de l'onglet unique continuent de renvoyer |
heading |
Un titre dans ce document. Dans les documents contenant un seul onglet, les liens vers les en-têtes d'un onglet singulier continuent de renvoyer |
bookmarkId |
ID d'un favori dans ce document. Ancien champ : définissez Si ce champ est utilisé dans une requête d'écriture, le favori est considéré comme provenant de l'ID d'onglet spécifié dans la requête. Si aucun ID d'onglet n'est spécifié dans la demande, il est considéré comme provenant du premier onglet du document. |
headingId |
ID d'un titre de ce document. Ancien champ : définissez Si ce champ est utilisé dans une requête d'écriture, l'en-tête est considéré comme provenant de l'ID de l'onglet spécifié dans la requête. Si aucun ID d'onglet n'est spécifié dans la requête, il est considéré comme provenant du premier onglet du document. |
BookmarkLink
Référence à un signet dans ce document.
Représentation JSON |
---|
{ "id": string, "tabId": string } |
Champs | |
---|---|
id |
ID d'un favori dans ce document. |
tabId |
ID de l'onglet contenant ce favori. |
HeadingLink
Référence à un titre de ce document.
Représentation JSON |
---|
{ "id": string, "tabId": string } |
Champs | |
---|---|
id |
ID d'un titre dans ce document. |
tabId |
ID de l'onglet contenant cet en-tête. |
SuggestedTextStyle
Suggestion de modification de TextStyle
.
Représentation JSON |
---|
{ "textStyle": { object ( |
Champs | |
---|---|
textStyle |
|
textStyleSuggestionState |
Masque indiquant les champs de l' |
TextStyleSuggestionState
Masque qui indique quels champs de la base TextStyle
ont été modifiés dans cette suggestion. Pour tout champ défini sur "true", une nouvelle valeur suggérée est proposée.
Représentation JSON |
---|
{ "boldSuggested": boolean, "italicSuggested": boolean, "underlineSuggested": boolean, "strikethroughSuggested": boolean, "smallCapsSuggested": boolean, "backgroundColorSuggested": boolean, "foregroundColorSuggested": boolean, "fontSizeSuggested": boolean, "weightedFontFamilySuggested": boolean, "baselineOffsetSuggested": boolean, "linkSuggested": boolean } |
Champs | |
---|---|
boldSuggested |
Indique si une modification a été suggérée pour |
italicSuggested |
Indique si une modification a été suggérée pour |
underlineSuggested |
Indique si une modification a été suggérée pour |
strikethroughSuggested |
Indique si une modification a été suggérée pour |
smallCapsSuggested |
Indique si une modification a été suggérée pour |
backgroundColorSuggested |
Indique si une modification a été suggérée pour |
foregroundColorSuggested |
Indique si une modification a été suggérée pour |
fontSizeSuggested |
Indique si une modification a été suggérée pour |
weightedFontFamilySuggested |
Indique si une modification a été suggérée pour |
baselineOffsetSuggested |
Indique si une modification a été suggérée pour |
linkSuggested |
Indique si une modification a été suggérée pour |
AutoText
ParagraphElement
représentant un point dans le texte qui est remplacé de manière dynamique par du contenu susceptible de changer au fil du temps, comme un numéro de page.
Représentation JSON |
---|
{ "type": enum ( |
Champs | |
---|---|
type |
Type de ce texte automatique. |
suggestedInsertionIds[] |
ID d'insertion suggérés. Un élément |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée. |
textStyle |
Style de texte de cet AutoText. |
suggestedTextStyleChanges |
Le style de texte suggéré est modifié pour ce texte automatique, associé à l'ID de suggestion. |
Type
Types de texte automatique.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Type de texte automatique non spécifié. |
PAGE_NUMBER |
Type de texte automatique représentant le numéro de page actuel. |
PAGE_COUNT |
Type de texte automatique représentant le nombre total de pages du document. |
PageBreak
ParagraphElement
représentant un saut de page. Avec un saut de page, le texte suivant s'affiche en haut de la page suivante.
Représentation JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Champs | |
---|---|
suggestedInsertionIds[] |
ID d'insertion suggérés. Un élément |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée. |
textStyle |
Style de texte de ce saut de page. Comme pour le contenu textuel, comme les passages de texte et les références à des notes de bas de page, le style de texte d'un saut de page peut avoir une incidence sur la mise en page du contenu, ainsi que sur le style du texte inséré à côté. |
suggestedTextStyleChanges |
Le style de texte suggéré est remplacé par ce saut de page, associé à l'ID de suggestion. |
ColumnBreak
Un ParagraphElement
représentant un saut de colonne. Un saut de colonne fait démarrer le texte suivant en haut de la colonne suivante.
Représentation JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Champs | |
---|---|
suggestedInsertionIds[] |
ID d'insertion suggérés. Un élément |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée. |
textStyle |
Style de texte de ce ColumnBreak. Comme pour le contenu textuel, comme les passages de texte et les références de note de bas de page, le style de texte d'un saut de colonne peut affecter la mise en page du contenu, ainsi que le style du texte inséré à côté. |
suggestedTextStyleChanges |
Le style de texte suggéré est remplacé par ce saut de colonne, associé à l'ID de suggestion. |
Référence à une note de bas de page
ParagraphElement
représentant une référence à une note de bas de page. Une référence de note de bas de page est le contenu intégré affiché avec un numéro et utilisé pour identifier la note de bas de page.
Représentation JSON |
---|
{ "footnoteId": string, "footnoteNumber": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Champs | |
---|---|
footnoteId |
ID de l'élément |
footnoteNumber |
Numéro affiché pour cette note de bas de page. |
suggestedInsertionIds[] |
ID d'insertion suggérés. Un |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée. |
textStyle |
Style de texte de cette référence de note de bas de page. |
suggestedTextStyleChanges |
Le style de texte suggéré est remplacé par cette référence de note de bas de page, référencée par l'ID de suggestion. |
HorizontalRule
ParagraphElement
représentant une ligne horizontale.
Représentation JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Champs | |
---|---|
suggestedInsertionIds[] |
ID d'insertion suggérés. Un |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée. |
textStyle |
Style de texte de cette HorizontalRule. Comme pour le contenu textuel, comme les passages de texte et les références de note de bas de page, le style de texte d'une ligne horizontale peut affecter la mise en page du contenu ainsi que le style du texte inséré à côté. |
suggestedTextStyleChanges |
Le style de texte suggéré est remplacé par cette règle HorizontalRule, associée à l'ID de suggestion. |
Équation
ParagraphElement
représentant une équation.
Représentation JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ] } |
Champs | |
---|---|
suggestedInsertionIds[] |
ID d'insertion suggérés. Un élément |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée. |
InlineObjectElement
Un ParagraphElement
contenant un InlineObject
.
Représentation JSON |
---|
{ "inlineObjectId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Champs | |
---|---|
inlineObjectId |
ID de l'élément |
suggestedInsertionIds[] |
ID d'insertion suggérés. Un élément |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée. |
textStyle |
Style de texte de cet élément InlineObject. Comme pour le contenu textuel, comme les lignes de texte et les références de note de bas de page, le style de texte d'un élément d'objet intégré peut affecter la mise en page du contenu ainsi que le style du texte inséré à côté. |
suggestedTextStyleChanges |
Le style de texte suggéré est remplacé par cet InlineObject, associé par l'ID de suggestion. |
Personne
Une personne ou une adresse e-mail mentionnée dans un document. Ces mentions se comportent comme un seul élément immuable contenant le nom ou l'adresse e-mail de la personne.
Représentation JSON |
---|
{ "personId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Champs | |
---|---|
personId |
Uniquement en sortie. Identifiant unique de cette association. |
suggestedInsertionIds[] |
ID des suggestions qui insèrent le lien de cette personne dans le document. Un élément |
suggestedDeletionIds[] |
ID des suggestions qui suppriment le lien vers cette personne du document. Un |
textStyle |
Style de texte de cet objet |
suggestedTextStyleChanges |
Le style de texte suggéré est remplacé par |
personProperties |
Uniquement en sortie. Propriétés de cet objet |
PersonProperties
Propriétés spécifiques à un Person
associé.
Représentation JSON |
---|
{ "name": string, "email": string } |
Champs | |
---|---|
name |
Uniquement en sortie. Nom de la personne si celui-ci s'affiche dans le texte du lien au lieu de son adresse e-mail. |
email |
Uniquement en sortie. Adresse e-mail associée à ce |
RichLink
Lien vers une ressource Google (par exemple, un fichier dans Drive, une vidéo YouTube ou un événement Agenda)
Représentation JSON |
---|
{ "richLinkId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Champs | |
---|---|
richLinkId |
Uniquement en sortie. ID de cette association. |
suggestedInsertionIds[] |
ID des suggestions qui insèrent ce lien dans le document. Un |
suggestedDeletionIds[] |
ID des suggestions de suppression de ce lien du document. Un élément |
textStyle |
Style de texte de cet objet |
suggestedTextStyleChanges |
Le style de texte suggéré est remplacé par |
richLinkProperties |
Uniquement en sortie. Propriétés de ce |
RichLinkProperties
Propriétés spécifiques à un RichLink
.
Représentation JSON |
---|
{ "title": string, "uri": string, "mimeType": string } |
Champs | |
---|---|
title |
Uniquement en sortie. Titre de l'élément |
uri |
Uniquement en sortie. URI de l' |
mimeType |
Uniquement en sortie. Le type MIME de l'élément |
ParagraphStyle
Styles qui s'appliquent à un paragraphe entier.
Les styles de paragraphe hérités sont représentés par des champs non définis dans ce message. Le parent d'un style de paragraphe dépend de l'emplacement où il est défini :
- Le ParagraphStyle d'un
Paragraph
hérite dunamed style type
correspondant au paragraphe. - Le ParagraphStyle sur un
named style
hérite du style nomménormal text
. - Le ParagraphStyle du style nommé
normal text
hérite du style de paragraphe par défaut dans l'éditeur Docs. - Le style de paragraphe d'un élément
Paragraph
contenu dans un tableau peut hériter du style de tableau.
Si le style de paragraphe n'hérite pas d'un parent, la valeur par défaut de l'éditeur Docs sera rétablie.
Représentation JSON |
---|
{ "headingId": string, "namedStyleType": enum ( |
Champs | |
---|---|
headingId |
ID de l'en-tête du paragraphe. Si ce champ est vide, ce paragraphe n'est pas un titre. Cette propriété est en lecture seule. |
namedStyleType |
Type de style nommé du paragraphe. Étant donné que la modification du type de style nommé affecte d'autres propriétés de ParagraphStyle, le type de style nommé est appliqué avant que les autres propriétés ne soient mises à jour. |
alignment |
Alignement du texte de ce paragraphe. |
lineSpacing |
Espace entre les lignes, exprimé en pourcentage de la valeur normale (100,0). Si cette règle n'est pas configurée, la valeur est héritée du parent. |
direction |
Sens du texte de ce paragraphe. Si cette règle n'est pas configurée, la valeur par défaut est |
spacingMode |
Mode d'espacement du paragraphe. |
spaceAbove |
La quantité d'espace supplémentaire au-dessus du paragraphe. Si cette valeur n'est pas définie, elle est héritée du parent. |
spaceBelow |
La quantité d'espace supplémentaire sous le paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent. |
borderBetween |
Bordure entre ce paragraphe et les paragraphes suivants et précédents. Si cette règle n'est pas configurée, la valeur est héritée du parent. La bordure située entre les deux s'affiche lorsque le paragraphe adjacent possède les mêmes propriétés de bordure et de retrait. Vous ne pouvez pas mettre à jour partiellement les bordures de paragraphe. Lorsque vous modifiez la bordure d'un paragraphe, la nouvelle bordure doit être spécifiée dans son intégralité. |
borderTop |
Bordure en haut de ce paragraphe. Si cette valeur n'est pas définie, elle est héritée du parent. La bordure supérieure est affichée lorsque le paragraphe ci-dessus présente des propriétés de bordure et de retrait différentes. Impossible de mettre à jour partiellement les bordures de paragraphe. Lorsque vous modifiez la bordure d'un paragraphe, vous devez spécifier la nouvelle bordure dans son intégralité. |
borderBottom |
Bordure au bas de ce paragraphe. Si cette valeur n'est pas définie, elle est héritée du parent. La bordure inférieure est affichée lorsque le paragraphe ci-dessous a des propriétés de bordure et de retrait différentes. Impossible de mettre à jour partiellement les bordures de paragraphe. Lorsque vous modifiez la bordure d'un paragraphe, vous devez spécifier la nouvelle bordure dans son intégralité. |
borderLeft |
Bordure à gauche de ce paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent. Impossible de mettre à jour partiellement les bordures de paragraphe. Lorsque vous modifiez la bordure d'un paragraphe, la nouvelle bordure doit être spécifiée dans son intégralité. |
borderRight |
Bordure à droite de ce paragraphe. Si cette valeur n'est pas définie, elle est héritée du parent. Vous ne pouvez pas mettre à jour partiellement les bordures de paragraphe. Lorsque vous modifiez la bordure d'un paragraphe, vous devez spécifier la nouvelle bordure dans son intégralité. |
indentFirstLine |
Nombre de retraits pour la première ligne du paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent. |
indentStart |
Nombre de retraits du paragraphe sur le côté qui correspond au début du texte, en fonction de l'orientation actuelle du paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent. |
indentEnd |
Indentation du paragraphe sur le côté correspondant à la fin du texte, en fonction du sens du paragraphe actuel. Si cette règle n'est pas configurée, la valeur est héritée du parent. |
tabStops[] |
Liste des taquets de tabulation pour ce paragraphe. La liste des taquets de tabulation n'est pas héritée. Cette propriété est en lecture seule. |
keepLinesTogether |
Indique si toutes les lignes du paragraphe doivent être disposées sur la même page ou dans la même colonne, si possible. Si cette règle n'est pas configurée, la valeur est héritée du parent. |
keepWithNext |
Indique si au moins une partie de ce paragraphe doit être disposée sur la même page ou colonne que le paragraphe suivant, si possible. Si cette règle n'est pas configurée, la valeur est héritée du parent. |
avoidWidowAndOrphan |
Indique si les orphelins et les veuves doivent être évités pour le paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent. |
shading |
Ombre du paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent. |
pageBreakBefore |
Indique si le paragraphe actuel doit toujours commencer au début d'une page. Si cette règle n'est pas configurée, la valeur est héritée du parent. Toute tentative de mise à jour de |
NamedStyleType
Types de styles nommés.
Enums | |
---|---|
NAMED_STYLE_TYPE_UNSPECIFIED |
Le type du style nommé n'est pas spécifié. |
NORMAL_TEXT |
Texte normal. |
TITLE |
et le titre. |
SUBTITLE |
Sous-titre. |
HEADING_1 |
Titre 1. |
HEADING_2 |
Titre 2. |
HEADING_3 |
Titre 3. |
HEADING_4 |
Titre 4. |
HEADING_5 |
Titre 5. |
HEADING_6 |
Titre 6. |
Alignement
Types d'alignement du texte pour un paragraphe.
Enums | |
---|---|
ALIGNMENT_UNSPECIFIED |
L'alignement du paragraphe est hérité du parent. |
START |
Le paragraphe est aligné sur le début de la ligne. Aligné à gauche pour le texte de gauche à droite, aligné à droite dans le cas contraire. |
CENTER |
Le paragraphe est centré. |
END |
Le paragraphe est aligné à la fin de la ligne. Aligné à droite pour le texte de gauche à droite, aligné à gauche dans le cas contraire. |
JUSTIFIED |
Le paragraphe est justifié. |
ContentDirection
Le contenu des itinéraires peut s'afficher.
Enums | |
---|---|
CONTENT_DIRECTION_UNSPECIFIED |
L'orientation du contenu n'est pas spécifiée. |
LEFT_TO_RIGHT |
Le contenu va de gauche à droite. |
RIGHT_TO_LEFT |
Le contenu se déplace de droite à gauche. |
SpacingMode
Les différents modes d'espacement des paragraphes.
Enums | |
---|---|
SPACING_MODE_UNSPECIFIED |
Le mode d'espacement est hérité du parent. |
NEVER_COLLAPSE |
L'espacement entre les paragraphes est toujours affiché. |
COLLAPSE_LISTS |
L'espacement des paragraphes est ignoré entre les éléments de liste. |
ParagraphBorder
Bordure autour d'un paragraphe.
Représentation JSON |
---|
{ "color": { object ( |
Champs | |
---|---|
color |
Couleur de la bordure. |
width |
Largeur de la bordure. |
padding |
Marge intérieure de la bordure. |
dashStyle |
Style de tiret de la bordure. |
DashStyle
Types de tirets avec lesquels la géométrie linéaire peut être affichée. Ces valeurs sont basées sur la valeur "ST_PresetLineDashVal" type simple décrit dans la section 20.1.10.48 de l'ouvrage "Office Open XML File Formats - Fundamentals and Markup Language Reference" (Formats de fichiers XML ouverts d'Office – Principes de base et référence du langage de balisage), partie 1 de la 4e édition d'ECMA-376.
Enums | |
---|---|
DASH_STYLE_UNSPECIFIED |
Style de tiret non spécifié. |
SOLID |
Ligne continue. Correspond à la valeur ECMA-376 ST_PresetLineDashVal "solid". Il s'agit du style de trait par défaut. |
DOT |
Ligne en pointillés. Correspond à la valeur "dot" de la fonction ECMA-376 ST_PresetLineDashVal. |
DASH |
Ligne en pointillés. Correspond à la valeur "dash" de ST_PresetLineDashVal dans la norme ECMA-376. |
TabStop
Une tabulation dans un paragraphe.
Représentation JSON |
---|
{ "offset": { object ( |
Champs | |
---|---|
offset |
Décalage entre la tabulation et la marge de début. |
alignment |
Alignement de cette tabulation. Si cette règle n'est pas configurée, la valeur par défaut est |
TabStopAlignment
Alignement du taquet de tabulation.
Enums | |
---|---|
TAB_STOP_ALIGNMENT_UNSPECIFIED |
L'alignement des tabulations n'est pas spécifié. |
START |
La tabulation est alignée sur le début de la ligne. Il s'agit de la valeur par défaut. |
CENTER |
La tabulation est alignée au centre de la ligne. |
END |
La tabulation est alignée à la fin de la ligne. |
Ombrage
Ombrage d'un paragraphe.
Représentation JSON |
---|
{
"backgroundColor": {
object ( |
Champs | |
---|---|
backgroundColor |
Couleur d'arrière-plan de l'ombre de ce paragraphe. |
SuggestedParagraphStyle
Modification suggérée pour un ParagraphStyle
.
Représentation JSON |
---|
{ "paragraphStyle": { object ( |
Champs | |
---|---|
paragraphStyle |
|
paragraphStyleSuggestionState |
Masque indiquant les champs de l' |
ParagraphStyleSuggestionState
Masque indiquant les champs de l'ParagraphStyle
de base qui ont été modifiés dans cette suggestion. Pour tout champ défini sur "true", une nouvelle valeur suggérée est proposée.
Représentation JSON |
---|
{
"headingIdSuggested": boolean,
"namedStyleTypeSuggested": boolean,
"alignmentSuggested": boolean,
"lineSpacingSuggested": boolean,
"directionSuggested": boolean,
"spacingModeSuggested": boolean,
"spaceAboveSuggested": boolean,
"spaceBelowSuggested": boolean,
"borderBetweenSuggested": boolean,
"borderTopSuggested": boolean,
"borderBottomSuggested": boolean,
"borderLeftSuggested": boolean,
"borderRightSuggested": boolean,
"indentFirstLineSuggested": boolean,
"indentStartSuggested": boolean,
"indentEndSuggested": boolean,
"keepLinesTogetherSuggested": boolean,
"keepWithNextSuggested": boolean,
"avoidWidowAndOrphanSuggested": boolean,
"shadingSuggestionState": {
object ( |
Champs | |
---|---|
headingIdSuggested |
Indique si une modification a été suggérée pour |
namedStyleTypeSuggested |
Indique si une modification a été suggérée pour |
alignmentSuggested |
Indique si une modification a été suggérée pour |
lineSpacingSuggested |
Indique si une modification a été suggérée pour |
directionSuggested |
Indique si une modification a été suggérée pour |
spacingModeSuggested |
Indique si une modification a été suggérée pour |
spaceAboveSuggested |
Indique si une modification a été suggérée pour |
spaceBelowSuggested |
Indique si une modification a été suggérée pour |
borderBetweenSuggested |
Indique si une modification a été suggérée pour |
borderTopSuggested |
Indique si une modification a été suggérée pour |
borderBottomSuggested |
Indique si une modification a été suggérée pour |
borderLeftSuggested |
Indique si une modification a été suggérée pour |
borderRightSuggested |
Indique si une modification a été suggérée pour |
indentFirstLineSuggested |
Indique si une modification a été suggérée pour |
indentStartSuggested |
Indique si une modification a été suggérée pour |
indentEndSuggested |
Indique si une modification a été suggérée pour |
keepLinesTogetherSuggested |
Indique si une modification a été suggérée pour |
keepWithNextSuggested |
Indique si une modification a été suggérée pour |
avoidWidowAndOrphanSuggested |
Indique si une modification a été suggérée pour |
shadingSuggestionState |
Masque indiquant les champs de |
pageBreakBeforeSuggested |
Indique si une modification a été suggérée pour |
ShadingSuggestionState
Masque qui indique quels champs de la base Shading
ont été modifiés dans cette modification suggérée. Une nouvelle valeur est suggérée pour chaque champ défini sur "true".
Représentation JSON |
---|
{ "backgroundColorSuggested": boolean } |
Champs | |
---|---|
backgroundColorSuggested |
Indique si une modification a été suggérée pour le |
Puces
Décrit le point de liste d'un paragraphe.
Représentation JSON |
---|
{
"listId": string,
"nestingLevel": integer,
"textStyle": {
object ( |
Champs | |
---|---|
listId |
ID de la liste à laquelle ce paragraphe appartient. |
nestingLevel |
Niveau d'imbrication de ce paragraphe dans la liste. |
textStyle |
Style de texte spécifique au paragraphe appliqué à cette puce. |
SuggestedBullet
Modification suggérée pour un Bullet
.
Représentation JSON |
---|
{ "bullet": { object ( |
Champs | |
---|---|
bullet |
|
bulletSuggestionState |
Masque qui indique quels champs de la base |
BulletSuggestionState
Masque qui indique quels champs de la base Bullet
ont été modifiés dans cette suggestion. Une nouvelle valeur est suggérée pour chaque champ défini sur "true".
Représentation JSON |
---|
{
"listIdSuggested": boolean,
"nestingLevelSuggested": boolean,
"textStyleSuggestionState": {
object ( |
Champs | |
---|---|
listIdSuggested |
Indique si une modification a été suggérée pour le |
nestingLevelSuggested |
Indique si une modification a été suggérée pour |
textStyleSuggestionState |
Masque indiquant les champs de |
ObjectReferences
Ensemble d'ID d'objets.
Représentation JSON |
---|
{ "objectIds": [ string ] } |
Champs | |
---|---|
objectIds[] |
ID des objets. |
SectionBreak
StructuralElement
représentant un saut de section. Une section est une plage de contenu ayant le même SectionStyle
. Un saut de section représente le début d'une nouvelle section, et le style de la section s'applique à la section après le saut de section.
Le corps du document commence toujours par un saut de section.
Représentation JSON |
---|
{
"suggestedInsertionIds": [
string
],
"suggestedDeletionIds": [
string
],
"sectionStyle": {
object ( |
Champs | |
---|---|
suggestedInsertionIds[] |
ID d'insertion suggérés. Un élément |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée. |
sectionStyle |
Style de la section après ce saut de section. |
SectionStyle
Style appliqué à une section.
Représentation JSON |
---|
{ "columnProperties": [ { object ( |
Champs | |
---|---|
columnProperties[] |
Propriétés des colonnes de la section. Si ce champ est vide, la section contient une colonne avec les propriétés par défaut de l'éditeur Docs. Une section ne peut pas comporter plus de trois colonnes. Lors de la mise à jour de cette propriété, vous devez définir une valeur concrète. La réinitialisation de cette propriété entraînera une erreur 400 de requête incorrecte. |
columnSeparatorStyle |
Style des séparateurs de colonnes. Ce style peut être défini même si la section ne comporte qu'une seule colonne. Lors de la mise à jour de cette propriété, vous devez définir une valeur concrète. Si vous ne définissez pas cette propriété, une erreur 400 "Bad Request" (Mauvaise requête) s'affiche. |
contentDirection |
Orientation du contenu de cette section. Si cette règle n'est pas configurée, la valeur par défaut est Lors de la mise à jour de cette propriété, vous devez définir une valeur concrète. Si vous ne définissez pas cette propriété, une erreur 400 "Bad Request" (Mauvaise requête) s'affiche. |
marginTop |
Marge supérieure de la page de la section. Si ce champ n'est pas défini, la valeur par défaut est Lors de la mise à jour de cette propriété, vous devez définir une valeur concrète. La réinitialisation de cette propriété génère une erreur 400 de requête incorrecte. |
marginBottom |
Marge inférieure de la page de la section. Si elle n'est pas définie, la valeur par défaut est Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. La réinitialisation de cette propriété génère une erreur 400 de requête incorrecte. |
marginRight |
Marge de droite de la section. Si ce champ n'est pas défini, la valeur par défaut est Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. Si vous ne définissez pas cette propriété, une erreur 400 "Bad Request" (Mauvaise requête) s'affiche. |
marginLeft |
Marge de gauche de la section. Si cette règle n'est pas configurée, la valeur par défaut de DocumentStyle est Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. La réinitialisation de cette propriété génère une erreur 400 de requête incorrecte. |
marginHeader |
Marge de l'en-tête de la section. Si cette règle n'est pas configurée, la valeur par défaut de DocumentStyle est Lors de la mise à jour de cette propriété, vous devez définir une valeur concrète. La réinitialisation de cette propriété génère une erreur 400 de requête incorrecte. |
marginFooter |
Marge du pied de page de la section. Si ce champ n'est pas défini, la valeur par défaut est Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. La réinitialisation de cette propriété génère une erreur 400 de requête incorrecte. |
sectionType |
Uniquement en sortie. Type de section. |
defaultHeaderId |
ID de l'en-tête par défaut. Si cette règle n'est pas configurée, la valeur hérite du style de section Cette propriété est en lecture seule. |
defaultFooterId |
ID du pied de page par défaut. Si cette règle n'est pas configurée, la valeur hérite du style de section Cette propriété est en lecture seule. |
firstPageHeaderId |
ID de l'en-tête utilisé uniquement pour la première page de la section. Si Cette propriété est en lecture seule. |
firstPageFooterId |
ID du pied de page utilisé uniquement pour la première page de la section. Si Cette propriété est en lecture seule. |
evenPageHeaderId |
ID de l'en-tête utilisé uniquement pour les pages paires. Si la valeur de Cette propriété est en lecture seule. |
evenPageFooterId |
ID du pied de page utilisé uniquement pour les pages paires. Si la valeur de Cette propriété est en lecture seule. |
useFirstPageHeaderFooter |
Indique s'il faut utiliser les ID d'en-tête / pied de page de la première page pour la première page de la section. Si cette règle n'est pas configurée, elle hérite du paramètre Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. Si vous ne définissez pas cette propriété, une erreur 400 "Bad Request" (Mauvaise requête) s'affiche. |
pageNumberStart |
Numéro de page à partir duquel commencer à compter le nombre de pages de cette section. Si cette règle n'est pas configurée, la numérotation des pages continue à partir de la section précédente. Si la valeur n'est pas définie dans la première Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. La réinitialisation de cette propriété génère une erreur 400 de requête incorrecte. |
flipPageOrientation |
Facultatif. Indique si les dimensions du Lors de la mise à jour de cette propriété, vous devez définir une valeur concrète. La réinitialisation de cette propriété génère une erreur 400 de requête incorrecte. |
SectionColumnProperties
Propriétés qui s'appliquent à la colonne d'une section.
Représentation JSON |
---|
{ "width": { object ( |
Champs | |
---|---|
width |
Uniquement en sortie. Largeur de la colonne. |
paddingEnd |
Marge intérieure à la fin de la colonne. |
ColumnSeparatorStyle
Style des séparateurs de colonnes.
Enums | |
---|---|
COLUMN_SEPARATOR_STYLE_UNSPECIFIED |
Style de séparateur de colonne non spécifié. |
NONE |
Aucune ligne de séparateur de colonnes entre les colonnes. |
BETWEEN_EACH_COLUMN |
Affiche une ligne de séparation de colonne entre chaque colonne. |
SectionType
Représente le positionnement du début de la section actuelle par rapport à la section précédente.
Enums | |
---|---|
SECTION_TYPE_UNSPECIFIED |
Le type de section n'est pas spécifié. |
CONTINUOUS |
La section commence immédiatement après le dernier paragraphe de la section précédente. |
NEXT_PAGE |
La section commence sur la page suivante. |
Tableau
Un StructuralElement
représentant une table.
Représentation JSON |
---|
{ "rows": integer, "columns": integer, "tableRows": [ { object ( |
Champs | |
---|---|
rows |
Nombre de lignes dans la table. |
columns |
Nombre de colonnes dans le tableau. Il est possible qu'un tableau ne soit pas rectangulaire, c'est pourquoi certaines lignes peuvent comporter un nombre de cellules différent. |
tableRows[] |
Contenu et style de chaque ligne. |
suggestedInsertionIds[] |
ID d'insertion suggérés. Un |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée. |
tableStyle |
Style de la table. |
Ligne de tableau
Contenu et style d'une ligne dans un Table
.
Représentation JSON |
---|
{ "startIndex": integer, "endIndex": integer, "tableCells": [ { object ( |
Champs | |
---|---|
startIndex |
Index de départ basé sur zéro de cette ligne, exprimé en unités de code UTF-16. |
endIndex |
Index de fin de cette ligne, à partir de zéro, en unités de code UTF-16 (exclusif). |
tableCells[] |
Contenu et style de chaque cellule de cette ligne. Un tableau peut ne pas être rectangulaire. Par conséquent, le nombre de cellules de certaines lignes peut être différent de celui des autres lignes du même tableau. |
suggestedInsertionIds[] |
ID d'insertion suggérés. Un élément |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée. |
tableRowStyle |
Style de la ligne du tableau. |
suggestedTableRowStyleChanges |
Le style suggéré change pour cette ligne, en fonction de l'ID de suggestion. |
TableCell
Contenu et style d'une cellule dans un Table
.
Représentation JSON |
---|
{ "startIndex": integer, "endIndex": integer, "content": [ { object ( |
Champs | |
---|---|
startIndex |
Index de début de cette cellule, basé sur zéro, en unités de code UTF-16. |
endIndex |
L'index de fin basé sur zéro de cette cellule, exclusif, en unités de code UTF-16. |
content[] |
Contenu de la cellule. |
tableCellStyle |
Style de la cellule. |
suggestedInsertionIds[] |
ID d'insertion suggérés. Un |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée. |
suggestedTableCellStyleChanges |
Modifications suggérées pour le style de cellule du tableau, associées à l'ID de suggestion. |
TableCellStyle
Style d'une TableCell
.
Les styles de cellule de tableau hérités sont représentés par des champs non définis dans ce message. Le style d'une cellule de tableau peut hériter du style du tableau.
Représentation JSON |
---|
{ "rowSpan": integer, "columnSpan": integer, "backgroundColor": { object ( |
Champs | |
---|---|
rowSpan |
Étendue de lignes de la cellule. Cette propriété est en lecture seule. |
columnSpan |
Colonne s'étendant sur la cellule. Cette propriété est en lecture seule. |
backgroundColor |
Couleur d'arrière-plan de la cellule. |
borderLeft |
Bordure gauche de la cellule. |
borderRight |
Bordure droite de la cellule. |
borderTop |
Bordure supérieure de la cellule. |
borderBottom |
Bordure inférieure de la cellule. |
paddingLeft |
Marge intérieure gauche de la cellule. |
paddingRight |
Marge intérieure droite de la cellule. |
paddingTop |
Marge intérieure supérieure de la cellule. |
paddingBottom |
Marge intérieure inférieure de la cellule. |
contentAlignment |
Alignement du contenu dans la cellule du tableau. L'alignement par défaut correspond à celui des cellules de table nouvellement créées dans l'éditeur Docs. |
TableCellBorder
Bordure autour d'une cellule de tableau.
Les bordures des cellules de tableau ne peuvent pas être transparentes. Pour masquer la bordure d'une cellule d'un tableau, définissez sa largeur sur 0.
Représentation JSON |
---|
{ "color": { object ( |
Champs | |
---|---|
color |
Couleur de la bordure. Cette couleur ne peut pas être transparente. |
width |
Largeur de la bordure. |
dashStyle |
Style de tiret de la bordure. |
ContentAlignment
Types d'alignement du contenu.
Issu d'un sous-ensemble de valeurs de "ST_TextAnchoringType" saisie simple figurant dans la section 20.1.10.59 du document "Office Open XML File Formats - Fundamentals and Markup Language Reference" (Formats de fichiers XML ouverts d'Office – Principes de base et référence du langage de balisage), partie 1 de la 4e édition d'ECMA-376.
Enums | |
---|---|
CONTENT_ALIGNMENT_UNSPECIFIED |
Alignement de contenu non spécifié. L'alignement de contenu est hérité de l'élément parent, le cas échéant. |
CONTENT_ALIGNMENT_UNSUPPORTED |
Alignement de contenu non accepté. |
TOP |
Alignement qui place le contenu en haut du conteneur de contenu. Correspond à ECMA-376 ST_TextAnchoringType "t". |
MIDDLE |
Alignement qui aligne le contenu par rapport au milieu du conteneur de contenu. Correspond à ECMA-376 ST_TextAnchoringType "ctr". |
BOTTOM |
Alignement qui aligne le contenu par rapport au bas du conteneur de contenu. Correspond à ST_TextAnchoringType "b" dans la norme ECMA-376. |
SuggestedTableCellStyle
Suggestion de modification de TableCellStyle
.
Représentation JSON |
---|
{ "tableCellStyle": { object ( |
Champs | |
---|---|
tableCellStyle |
|
tableCellStyleSuggestionState |
Masque qui indique quels champs de la base |
TableCellStyleSuggestionState
Masque qui indique quels champs de la base TableCellStyle
ont été modifiés dans cette suggestion. Une nouvelle valeur est suggérée pour chaque champ défini sur "true".
Représentation JSON |
---|
{ "rowSpanSuggested": boolean, "columnSpanSuggested": boolean, "backgroundColorSuggested": boolean, "borderLeftSuggested": boolean, "borderRightSuggested": boolean, "borderTopSuggested": boolean, "borderBottomSuggested": boolean, "paddingLeftSuggested": boolean, "paddingRightSuggested": boolean, "paddingTopSuggested": boolean, "paddingBottomSuggested": boolean, "contentAlignmentSuggested": boolean } |
Champs | |
---|---|
rowSpanSuggested |
Indique si une modification a été suggérée pour |
columnSpanSuggested |
Indique si une modification a été suggérée pour |
backgroundColorSuggested |
Indique si une modification a été suggérée pour |
borderLeftSuggested |
Indique si une modification a été suggérée pour |
borderRightSuggested |
Indique si une modification a été suggérée pour |
borderTopSuggested |
Indique si une modification a été suggérée pour |
borderBottomSuggested |
Indique si une modification a été suggérée pour |
paddingLeftSuggested |
Indique si une modification a été suggérée pour |
paddingRightSuggested |
Indique si une modification a été suggérée pour |
paddingTopSuggested |
Indique si une modification a été suggérée pour |
paddingBottomSuggested |
Indique si une modification a été suggérée pour |
contentAlignmentSuggested |
Indique si une modification a été suggérée pour |
TableRowStyle
Styles appliqués à une ligne de tableau.
Représentation JSON |
---|
{
"minRowHeight": {
object ( |
Champs | |
---|---|
minRowHeight |
Hauteur minimale de la ligne. La ligne s'affiche dans l'éditeur Docs avec une hauteur égale ou supérieure à cette valeur afin d'afficher tout le contenu de ses cellules. |
tableHeader |
Indique si la ligne est un en-tête de tableau. |
preventOverflow |
Indique si la ligne ne peut pas dépasser les limites de page ou de colonne. |
SuggestedTableRowStyle
Suggestion de modification d'un TableRowStyle
.
Représentation JSON |
---|
{ "tableRowStyle": { object ( |
Champs | |
---|---|
tableRowStyle |
|
tableRowStyleSuggestionState |
Masque qui indique quels champs de la base |
TableRowStyleSuggestionState
Masque indiquant les champs de l'TableRowStyle
de base qui ont été modifiés dans cette suggestion. Une nouvelle valeur est suggérée pour chaque champ défini sur "true".
Représentation JSON |
---|
{ "minRowHeightSuggested": boolean } |
Champs | |
---|---|
minRowHeightSuggested |
Indique si une modification a été suggérée pour |
TableStyle
Styles qui s'appliquent à un tableau
Représentation JSON |
---|
{
"tableColumnProperties": [
{
object ( |
Champs | |
---|---|
tableColumnProperties[] |
Propriétés de chaque colonne. Notez que dans Docs, les tableaux contiennent des lignes et les lignes contiennent des cellules, comme dans HTML. Ainsi, les propriétés d'une ligne se trouvent dans l'élément |
TableColumnProperties
Propriétés d'une colonne dans un tableau.
Représentation JSON |
---|
{ "widthType": enum ( |
Champs | |
---|---|
widthType |
Type de largeur de la colonne. |
width |
Largeur de la colonne. Défini lorsque le |
WidthType
Type de largeur de la colonne.
Enums | |
---|---|
WIDTH_TYPE_UNSPECIFIED |
Le type de largeur de colonne n'est pas spécifié. |
EVENLY_DISTRIBUTED |
La largeur de colonne est répartie de manière uniforme entre les autres colonnes réparties de manière uniforme. La largeur de la colonne est déterminée automatiquement et une partie égale de la largeur restante est réservée au tableau après avoir pris en compte toutes les colonnes dont la largeur est spécifiée. |
FIXED_WIDTH |
Largeur de colonne fixe. La propriété [width][google.apps.docs.v1.TableColumnProperties.width contient la largeur de la colonne. |
TableOfContents
StructuralElement
représentant une table des matières.
Représentation JSON |
---|
{
"content": [
{
object ( |
Champs | |
---|---|
content[] |
Contenu de la table des matières. |
suggestedInsertionIds[] |
ID d'insertion suggérés. Un élément |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée. |
En-tête
En-tête de document.
Représentation JSON |
---|
{
"headerId": string,
"content": [
{
object ( |
Champs | |
---|---|
headerId |
ID de l'en-tête. |
content[] |
Contenu de l'en-tête. Les index du contenu d'un en-tête commencent à zéro. |
Note de bas de page
Note de bas de page d'un document.
Représentation JSON |
---|
{
"footnoteId": string,
"content": [
{
object ( |
Champs | |
---|---|
footnoteId |
ID de la note de bas de page. |
content[] |
Contenu de la note de bas de page. Les index du contenu d'une note de bas de page commencent à zéro. |
DocumentStyle
Style du document.
Représentation JSON |
---|
{ "background": { object ( |
Champs | |
---|---|
background |
Arrière-plan du document. Les documents ne peuvent pas avoir de couleur d'arrière-plan transparente. |
defaultHeaderId |
ID de l'en-tête par défaut. Si cette règle n'est pas configurée, il n'y a pas d'en-tête par défaut. Cette propriété est en lecture seule. |
defaultFooterId |
ID du pied de page par défaut. Si cette règle n'est pas configurée, il n'y a pas de pied de page par défaut. Cette propriété est en lecture seule. |
evenPageHeaderId |
ID de l'en-tête utilisé uniquement pour les pages paires. La valeur de Cette propriété est en lecture seule. |
evenPageFooterId |
ID du pied de page utilisé uniquement pour les pages paires. La valeur de Cette propriété est en lecture seule. |
firstPageHeaderId |
ID de l'en-tête utilisé uniquement pour la première page. Si cette règle n'est pas configurée, aucun en-tête unique n'existe pour la première page. La valeur de Cette propriété est en lecture seule. |
firstPageFooterId |
ID du pied de page utilisé uniquement pour la première page. Si cette règle n'est pas configurée, aucun pied de page unique n'existe pour la première page. La valeur de Cette propriété est en lecture seule. |
useFirstPageHeaderFooter |
Indique s'il faut utiliser les ID d'en-tête / pied de page de la première page pour la première page. |
useEvenPageHeaderFooter |
Indique si les ID d'en-tête / pied de page des pages paires doivent être utilisés. |
pageNumberStart |
Numéro de page à partir duquel commencer à compter le nombre de pages. |
marginTop |
Marge supérieure de la page. Si vous modifiez la marge supérieure de la page dans le style de document, la marge supérieure de la page est effacée dans tous les styles de section. |
marginBottom |
Marge inférieure de la page. Si vous modifiez la marge inférieure de la page dans le style de document, la marge inférieure de la page est effacée de tous les styles de section. |
marginRight |
Marge de droite de la page. Si vous modifiez la marge droite de la page dans le style du document, elle est effacée pour tous les styles de section. Cela peut également entraîner le redimensionnement des colonnes dans toutes les sections. |
marginLeft |
Marge de gauche de la page. La modification de la marge gauche de la page dans le style du document la supprime pour tous les styles de section. Cela peut également entraîner le redimensionnement des colonnes dans toutes les sections. |
pageSize |
Taille d'une page du document. |
marginHeader |
Espace entre le haut de la page et le contenu de l'en-tête. |
marginFooter |
Espace entre le bas de la page et le contenu du pied de page. |
useCustomHeaderFooterMargins |
Indique si les valeurs DocumentStyle Cette propriété est en lecture seule. |
flipPageOrientation |
Facultatif. Indique si les dimensions du |
Contexte
Représente l'arrière-plan d'un document.
Représentation JSON |
---|
{
"color": {
object ( |
Champs | |
---|---|
color |
Couleur de l'arrière-plan. |
Taille
Une largeur et une hauteur.
Représentation JSON |
---|
{ "height": { object ( |
Champs | |
---|---|
height |
Hauteur de l'objet. |
width |
Largeur de l'objet. |
SuggestedDocumentStyle
Suggestion de modification de la DocumentStyle
.
Représentation JSON |
---|
{ "documentStyle": { object ( |
Champs | |
---|---|
documentStyle |
|
documentStyleSuggestionState |
Masque indiquant les champs de l' |
DocumentStyleSuggestionState
Masque indiquant les champs de l'DocumentStyle
de base qui ont été modifiés dans cette suggestion. Une nouvelle valeur est suggérée pour chaque champ défini sur "true".
Représentation JSON |
---|
{ "backgroundSuggestionState": { object ( |
Champs | |
---|---|
backgroundSuggestionState |
Masque indiquant les champs de |
defaultHeaderIdSuggested |
Indique si une modification a été suggérée pour |
defaultFooterIdSuggested |
Indique si une modification a été suggérée pour |
evenPageHeaderIdSuggested |
Indique si une modification a été suggérée pour |
evenPageFooterIdSuggested |
Indique si une modification a été suggérée pour |
firstPageHeaderIdSuggested |
Indique si une modification a été suggérée pour |
firstPageFooterIdSuggested |
Indique si une modification a été suggérée pour |
useFirstPageHeaderFooterSuggested |
Indique si une modification a été suggérée pour |
useEvenPageHeaderFooterSuggested |
Indique si une modification a été suggérée pour |
pageNumberStartSuggested |
Indique si une modification a été suggérée pour |
marginTopSuggested |
Indique si une modification a été suggérée pour |
marginBottomSuggested |
Indique si une modification a été suggérée pour |
marginRightSuggested |
Indique si une modification a été suggérée pour |
marginLeftSuggested |
Indique si une modification a été suggérée pour |
pageSizeSuggestionState |
Masque qui indique lequel des champs dans [size] [google.apps.docs.v1.DocumentStyle.size] a été modifié dans cette suggestion. |
marginHeaderSuggested |
Indique si une modification a été suggérée pour |
marginFooterSuggested |
Indique si une modification a été suggérée pour |
useCustomHeaderFooterMarginsSuggested |
Indique si une modification a été suggérée pour |
flipPageOrientationSuggested |
Facultatif. Indique si une modification a été suggérée pour |
BackgroundSuggestionState
Masque qui indique quels champs de la base Background
ont été modifiés dans cette suggestion. Pour tout champ défini sur "true", Backgound
a une nouvelle valeur suggérée.
Représentation JSON |
---|
{ "backgroundColorSuggested": boolean } |
Champs | |
---|---|
backgroundColorSuggested |
Indique si la couleur d'arrière-plan actuelle a été modifiée dans cette suggestion. |
SizeSuggestionState
Masque indiquant les champs de l'Size
de base qui ont été modifiés dans cette suggestion. Pour tout champ défini sur "true", Size
propose une nouvelle valeur.
Représentation JSON |
---|
{ "heightSuggested": boolean, "widthSuggested": boolean } |
Champs | |
---|---|
heightSuggested |
Indique si une modification a été suggérée pour |
widthSuggested |
Indique si une modification a été suggérée pour |
NamedStyles
Styles nommés. Les paragraphes du document peuvent hériter de leurs TextStyle
et ParagraphStyle
de ces styles nommés.
Représentation JSON |
---|
{
"styles": [
{
object ( |
Champs | |
---|---|
styles[] |
Styles nommés. Il existe une entrée pour chacun des |
NamedStyle
Un style nommé. Les paragraphes du document peuvent hériter de leurs TextStyle
et ParagraphStyle
de ce style nommé lorsqu'ils ont le même type de style nommé.
Représentation JSON |
---|
{ "namedStyleType": enum ( |
Champs | |
---|---|
namedStyleType |
Type de ce style nommé. |
textStyle |
Style de texte de ce style nommé. |
paragraphStyle |
Style de paragraphe de ce style nommé. |
SuggestedNamedStyles
Suggestion de modification de la NamedStyles
.
Représentation JSON |
---|
{ "namedStyles": { object ( |
Champs | |
---|---|
namedStyles |
|
namedStylesSuggestionState |
Masque indiquant les champs de l' |
NamedStylesSuggestionState
État de suggestion d'un message NamedStyles
.
Représentation JSON |
---|
{
"stylesSuggestionStates": [
{
object ( |
Champs | |
---|---|
stylesSuggestionStates[] |
Masque qui indique quels champs du L'ordre de ces états de suggestion de style nommé correspond à l'ordre du style nommé correspondant dans la suggestion |
NamedStyleSuggestionState
État de suggestion d'un message NamedStyle
.
Représentation JSON |
---|
{ "namedStyleType": enum ( |
Champs | |
---|---|
namedStyleType |
Type de style nommé auquel cet état de suggestion correspond. Ce champ est fourni pour faciliter la mise en correspondance de NamedStyleSuggestionState avec son |
textStyleSuggestionState |
Masque indiquant les champs de |
paragraphStyleSuggestionState |
Masque indiquant les champs de |
Liste
Une liste représente les attributs de liste pour un groupe de paragraphes qui appartiennent tous à la même liste. Un paragraphe faisant partie d'une liste contient une référence à l'ID de la liste dans son élément bullet
.
Représentation JSON |
---|
{ "listProperties": { object ( |
Champs | |
---|---|
listProperties |
Propriétés de la liste. |
suggestedListPropertiesChanges |
Modifications suggérées apportées aux propriétés de la liste, triées par ID de suggestion. |
suggestedInsertionId |
ID d'insertion suggéré. Si ce champ est vide, l'insertion n'est pas suggérée. |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression n'est proposée pour cette liste. |
ListProperties
Propriétés d'une list
, qui décrivent l'apparence des puces appartenant aux paragraphes associés à une liste.
Représentation JSON |
---|
{
"nestingLevels": [
{
object ( |
Champs | |
---|---|
nestingLevels[] |
Décrit les propriétés des puces au niveau associé. Une liste comporte au maximum neuf niveaux d'imbrication, avec le niveau d'imbrication 0 correspondant au niveau le plus élevé et le niveau d'imbrication 8 correspondant au niveau le plus imbriqué. Les niveaux d'imbrication sont renvoyés par ordre croissant, le moins imbriqué étant renvoyé en premier. |
NestingLevel
Contient les propriétés décrivant l'apparence d'une liste à puces à un niveau d'imbrication donné.
Représentation JSON |
---|
{ "bulletAlignment": enum ( |
Champs | |
---|---|
bulletAlignment |
Alignement de la puce dans l'espace alloué à son affichage. |
glyphFormat |
Chaîne de format utilisée par les puces à ce niveau d'imbrication. Le format glyphe contient un ou plusieurs espaces réservés, qui sont remplacés par les valeurs appropriées en fonction de Par exemple, le format de glyphe
Le format glyphe peut contenir des espaces réservés pour le niveau d'imbrication actuel, ainsi que des espaces réservés pour les niveaux d'imbrication parents. Par exemple, une liste peut avoir un format de glyphe
Pour les niveaux d'imbrication ordonnés, la chaîne qui remplace un espace réservé au format de glyphe pour un paragraphe donné dépend de l'ordre du paragraphe dans la liste. |
indentFirstLine |
Indentation de la première ligne des paragraphes à ce niveau d'imbrication. |
indentStart |
Indentation des paragraphes à ce niveau d'imbrication. Appliquée sur le côté qui correspond au début du texte, en fonction de l'orientation du contenu du paragraphe. |
textStyle |
Style de texte des puces à ce niveau d'imbrication. |
startNumber |
Numéro du premier élément de liste à ce niveau d'imbrication. La valeur 0 est traitée comme la valeur 1 pour les listes avec lettres et chiffres romains. Pour les valeurs 0 et 1, les listes alphabétiques et en chiffres romains commenceront respectivement à Cette valeur est ignorée pour les niveaux d'imbrication avec des glyphes non ordonnés. |
Champ d'union glyph_kind . Type de glyphe utilisé par les puces. Il définit le glyphe de puce qui remplace les espaces réservés dans glyph_format . La glyph_kind ne peut être qu'un des éléments suivants : |
|
glyphType |
Type de glyphe utilisé par les puces lorsque les paragraphes de ce niveau d'imbrication sont triés. Le type de glyphe détermine le type de glyphe utilisé pour remplacer les espaces réservés dans le |
glyphSymbol |
Glyphe personnalisé utilisé dans les puces lorsque les paragraphes à ce niveau d'imbrication ne sont pas ordonnés. Le symbole de glyphe remplace les espaces réservés dans |
BulletAlignment
Types d'alignement pour une puce.
Enums | |
---|---|
BULLET_ALIGNMENT_UNSPECIFIED |
L'alignement de la puce n'est pas spécifié. |
START |
La puce est alignée sur le début de l'espace alloué à son affichage. Aligné à gauche pour le texte de gauche à droite, aligné à droite dans le cas contraire. |
CENTER |
Le point est aligné au centre de l'espace alloué à son affichage. |
END |
Le point est aligné à la fin de l'espace alloué pour le rendre. Aligné à droite pour le texte de gauche à droite, aligné à gauche dans le cas contraire. |
GlyphType
Types de glyphes utilisés dans les puces lorsque les paragraphes à ce niveau d'imbrication sont ordonnés.
Enums | |
---|---|
GLYPH_TYPE_UNSPECIFIED |
Le type de glyphe n'est pas spécifié ou n'est pas compatible. |
NONE |
Chaîne vide. |
DECIMAL |
Un nombre, comme 1 , 2 ou 3 . |
ZERO_DECIMAL |
Nombre dont les chiffres à un seul chiffre sont précédés d'un zéro, comme 01 , 02 ou 03 . Les nombres à plus d'un chiffre ne sont pas précédés d'un zéro. |
UPPER_ALPHA |
Une lettre majuscule, comme A , B ou C . |
ALPHA |
Une lettre minuscule, telle que a , b ou c . |
UPPER_ROMAN |
Chiffre romain en majuscule, tel que I , II ou III . |
ROMAN |
Un chiffre romain minuscule, comme i , ii ou iii . |
SuggestedListProperties
Suggestion de modification de ListProperties
.
Représentation JSON |
---|
{ "listProperties": { object ( |
Champs | |
---|---|
listProperties |
|
listPropertiesSuggestionState |
Masque qui indique quels champs de la base |
ListPropertiesSuggestionState
Masque qui indique quels champs de la base ListProperties
ont été modifiés dans cette suggestion. Pour tout champ défini sur "true", une nouvelle valeur suggérée est proposée.
Représentation JSON |
---|
{
"nestingLevelsSuggestionStates": [
{
object ( |
Champs | |
---|---|
nestingLevelsSuggestionStates[] |
Masque qui indique quels champs du Les états de suggestion des niveaux d'imbrication sont renvoyés par ordre croissant du niveau d'imbrication, le moins imbriqué étant renvoyé en premier. |
NestingLevelSuggestionState
Masque indiquant les champs de l'NestingLevel
de base qui ont été modifiés dans cette suggestion. Pour tout champ défini sur "true", une nouvelle valeur suggérée est proposée.
Représentation JSON |
---|
{
"bulletAlignmentSuggested": boolean,
"glyphTypeSuggested": boolean,
"glyphFormatSuggested": boolean,
"glyphSymbolSuggested": boolean,
"indentFirstLineSuggested": boolean,
"indentStartSuggested": boolean,
"textStyleSuggestionState": {
object ( |
Champs | |
---|---|
bulletAlignmentSuggested |
Indique si une modification a été suggérée pour |
glyphTypeSuggested |
Indique si une modification a été suggérée pour |
glyphFormatSuggested |
Indique si une modification a été suggérée pour |
glyphSymbolSuggested |
Indique si une modification a été suggérée pour |
indentFirstLineSuggested |
Indique si une modification a été suggérée pour |
indentStartSuggested |
Indique si une modification a été suggérée pour |
textStyleSuggestionState |
Masque qui indique les champs de |
startNumberSuggested |
Indique si une modification a été suggérée pour |
NamedRanges
Collection de tous les NamedRange
du document portant le même nom.
Représentation JSON |
---|
{
"name": string,
"namedRanges": [
{
object ( |
Champs | |
---|---|
name |
Nom partagé par tous les |
namedRanges[] |
Les |
NamedRange
Ensemble de valeurs Range
avec le même ID de plage nommée.
Les plages nommées permettent aux développeurs d'associer des parties d'un document à un libellé défini par l'utilisateur de manière arbitraire afin que leur contenu puisse être lu ou modifié par programmation ultérieurement. Un document peut contenir plusieurs plages nommées portant le même nom, mais chaque plage nommée possède un identifiant unique.
Une plage nommée est créée avec un seul Range
, et le contenu inséré dans une plage nommée étend généralement cette plage. Toutefois, certaines modifications apportées au document peuvent entraîner la division de la plage en plusieurs plages.
Les plages nommées ne sont pas privées. Toutes les applications et tous les collaborateurs ayant accès au document peuvent voir ses plages nommées.
Représentation JSON |
---|
{
"namedRangeId": string,
"name": string,
"ranges": [
{
object ( |
Champs | |
---|---|
namedRangeId |
ID de la plage nommée. |
name |
Nom de la plage nommée. |
ranges[] |
Plages appartenant à cette plage nommée. |
Plage
Spécifie une plage de texte contiguë.
Représentation JSON |
---|
{ "segmentId": string, "startIndex": integer, "endIndex": integer, "tabId": string } |
Champs | |
---|---|
segmentId |
ID de l'en-tête, du pied de page ou de la note de bas de page dans lesquels se trouve la plage. Un ID de segment vide indique le corps du document. |
startIndex |
Index de début de cette plage, basé sur zéro, en unités de code UTF-16. Dans toutes les utilisations actuelles, un index de départ doit être fourni. Ce champ est une valeur Int32Value destinée aux futurs cas d'utilisation avec des plages ouvertes. |
endIndex |
Index de fin de cette plage, à partir de zéro, en unités de code UTF-16 (exclusif). Dans tous les cas d'utilisation actuels, un indice de fin doit être fourni. Ce champ est une valeur Int32Value destinée aux futurs cas d'utilisation avec des plages ouvertes. |
tabId |
Onglet contenant cette plage. 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:
|
InlineObject
Objet qui s'affiche en ligne avec le texte. Un InlineObject contient un EmbeddedObject
, comme une image.
Représentation JSON |
---|
{ "objectId": string, "inlineObjectProperties": { object ( |
Champs | |
---|---|
objectId |
ID de cet objet intégré. Permet de mettre à jour les propriétés d'un objet. |
inlineObjectProperties |
Propriétés de cet objet intégré. |
suggestedInlineObjectPropertiesChanges |
Modifications suggérées pour les propriétés de l'objet intégré, associées par l'ID de suggestion. |
suggestedInsertionId |
ID d'insertion suggéré. Si ce champ est vide, l'insertion n'est pas suggérée. |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée. |
InlineObjectProperties
Propriétés d'un InlineObject
.
Représentation JSON |
---|
{
"embeddedObject": {
object ( |
Champs | |
---|---|
embeddedObject |
Objet intégré de cet objet intégré. |
EmbeddedObject
Objet intégré dans le document.
Représentation JSON |
---|
{ "title": string, "description": string, "embeddedObjectBorder": { object ( |
Champs | |
---|---|
title |
Titre de l'objet intégré. |
description |
Description de l'objet intégré. |
embeddedObjectBorder |
Bordure de l'objet intégré. |
size |
Taille visible de l'image après le recadrage. |
marginTop |
Marge supérieure de l'objet intégré. |
marginBottom |
Marge inférieure de l'objet intégré. |
marginRight |
Marge droite de l'objet intégré. |
marginLeft |
Marge gauche de l'objet intégré. |
linkedContentReference |
Référence au contenu de la source externe associée. Par exemple, il contient une référence au graphique Google Sheets source lorsque l'objet intégré est un graphique associé. Si cette règle n'est pas configurée, l'objet intégré n'est pas associé. |
Champ d'union properties . Propriétés spécifiques à chaque type d'objet intégré. properties ne peut être qu'un des éléments suivants : |
|
embeddedDrawingProperties |
Propriétés d'un dessin intégré. |
imageProperties |
Propriétés d'une image. |
EmbeddedDrawingProperties
Ce type ne comporte aucun champ.
Propriétés d'un dessin intégré et utilisées pour différencier le type d'objet. Un dessin incorporé est un dessin créé et modifié dans un document. Notez que les informations détaillées ne sont pas disponibles.
ImageProperties
Propriétés d'une image.
Représentation JSON |
---|
{
"contentUri": string,
"sourceUri": string,
"brightness": number,
"contrast": number,
"transparency": number,
"cropProperties": {
object ( |
Champs | |
---|---|
contentUri |
URI de l'image avec une durée de vie par défaut de 30 minutes. Cet URI comporte un tag correspondant au compte du demandeur. Toute personne disposant de l'URI accède effectivement à l'image en tant que demandeur d'origine. L'accès à l'image peut être perdu en cas de modification des paramètres de partage du document. |
sourceUri |
L'URI source est l'URI utilisé pour insérer l'image. L'URI source peut être vide. |
brightness |
Effet de luminosité de l'image. La valeur doit être comprise dans l'intervalle [-1.0, 1.0], où 0 signifie qu'il n'y a aucun effet. |
contrast |
Effet de contraste de l'image. La valeur doit être comprise dans l'intervalle [-1,0, 1,0], où 0 signifie qu'aucun effet n'est appliqué. |
transparency |
Effet de transparence de l'image. La valeur doit se situer dans l'intervalle [0,0, 1,0], où 0 signifie aucun effet et 1 signifie transparent. |
cropProperties |
Propriétés de recadrage de l'image. |
angle |
Angle de rotation de l'image dans le sens des aiguilles d'une montre, en radians. |
CropProperties
Propriétés de recadrage d'une image.
Le rectangle de recadrage est représenté à l'aide de décalages fractionnaires par rapport aux quatre bords du contenu d'origine.
- Si le décalage se situe dans l'intervalle (0, 1), le bord correspondant du rectangle de recadrage est positionné à l'intérieur du rectangle de délimitation d'origine de l'image.
- Si le décalage est négatif ou supérieur à 1, le bord correspondant du rectangle de recadrage se trouve en dehors du rectangle de délimitation d'origine de l'image.
- Si tous les décalages et l'angle de rotation sont de 0, l'image n'est pas recadrée.
Représentation JSON |
---|
{ "offsetLeft": number, "offsetRight": number, "offsetTop": number, "offsetBottom": number, "angle": number } |
Champs | |
---|---|
offsetLeft |
Le décalage indique la distance entre le bord gauche du rectangle de recadrage et le bord gauche du contenu d'origine, exprimée en fraction de la largeur du contenu d'origine. |
offsetRight |
Le décalage indique la distance entre le bord droit du rectangle de recadrage et le bord droit du contenu d'origine, sous la forme d'une fraction de la largeur du contenu d'origine. |
offsetTop |
Le décalage indique la distance entre le bord supérieur du rectangle de recadrage et le bord supérieur du contenu d'origine sous la forme d'une fraction de la hauteur du contenu d'origine. |
offsetBottom |
Le décalage indique la distance entre le bord inférieur du rectangle de recadrage et le bord inférieur du contenu d'origine, exprimée en fraction de la hauteur du contenu d'origine. |
angle |
Angle de rotation dans le sens des aiguilles d'une montre du rectangle de recadrage autour de son centre, en radians. La rotation est appliquée après les décalages. |
EmbeddedObjectBorder
Bordure autour d'un EmbeddedObject
.
Représentation JSON |
---|
{ "color": { object ( |
Champs | |
---|---|
color |
Couleur de la bordure. |
width |
Largeur de la bordure. |
dashStyle |
Style de la bordure. |
propertyState |
État de la propriété de la bordure. |
PropertyState
États possibles d'une propriété.
Enums | |
---|---|
RENDERED |
Si l'état d'une propriété est RENDERED, l'élément dispose de la propriété correspondante lorsqu'il est affiché dans le document. Il s'agit de la valeur par défaut. |
NOT_RENDERED |
Si l'état d'une propriété est NOT_RENDERED, l'élément ne possède pas la propriété correspondante lorsqu'il est affiché dans le document. |
LinkedContentReference
Référence au contenu de la source externe associée.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union reference . Référence spécifique au type de contenu associé. reference ne peut être qu'un des éléments suivants : |
|
sheetsChartReference |
Référence au graphique lié. |
SheetsChartReference
Référence à un graphique associé intégré à partir de Google Sheets.
Représentation JSON |
---|
{ "spreadsheetId": string, "chartId": integer } |
Champs | |
---|---|
spreadsheetId |
ID de la feuille de calcul Google Sheets contenant le graphique source. |
chartId |
ID du graphique spécifique dans la feuille de calcul Google Sheets qui est intégrée. |
SuggestedInlineObjectProperties
Suggestion de modification pour InlineObjectProperties
.
Représentation JSON |
---|
{ "inlineObjectProperties": { object ( |
Champs | |
---|---|
inlineObjectProperties |
Un élément |
inlineObjectPropertiesSuggestionState |
Masque indiquant les champs de l' |
InlineObjectPropertiesSuggestionState
Masque qui indique quels champs de la base InlineObjectProperties
ont été modifiés dans cette suggestion. Une nouvelle valeur est suggérée pour chaque champ défini sur "true".
Représentation JSON |
---|
{
"embeddedObjectSuggestionState": {
object ( |
Champs | |
---|---|
embeddedObjectSuggestionState |
Masque qui indique les champs de |
EmbeddedObjectSuggestionState
Masque qui indique quels champs de la base EmbeddedObject
ont été modifiés dans cette suggestion. Une nouvelle valeur est suggérée pour chaque champ défini sur "true".
Représentation JSON |
---|
{ "embeddedDrawingPropertiesSuggestionState": { object ( |
Champs | |
---|---|
embeddedDrawingPropertiesSuggestionState |
Masque indiquant les champs de |
imagePropertiesSuggestionState |
Masque indiquant les champs de |
titleSuggested |
Indique si une modification a été suggérée pour |
descriptionSuggested |
Indique si une modification a été suggérée pour |
embeddedObjectBorderSuggestionState |
Masque indiquant les champs de |
sizeSuggestionState |
Masque indiquant les champs de |
marginLeftSuggested |
Indique si une modification a été suggérée pour |
marginRightSuggested |
Indique si une modification a été suggérée pour |
marginTopSuggested |
Indique si une modification a été suggérée pour |
marginBottomSuggested |
Indique si une modification a été suggérée pour |
linkedContentReferenceSuggestionState |
Masque qui indique les champs de |
EmbeddedDrawingPropertiesSuggestionState
Ce type ne comporte aucun champ.
Masque indiquant les champs de l'EmbeddedDrawingProperties
de base qui ont été modifiés dans cette suggestion. Une nouvelle valeur est suggérée pour chaque champ défini sur "true".
ImagePropertiesSuggestionState
Masque qui indique quels champs de la base ImageProperties
ont été modifiés dans cette suggestion. Une nouvelle valeur est suggérée pour chaque champ défini sur "true".
Représentation JSON |
---|
{
"contentUriSuggested": boolean,
"sourceUriSuggested": boolean,
"brightnessSuggested": boolean,
"contrastSuggested": boolean,
"transparencySuggested": boolean,
"cropPropertiesSuggestionState": {
object ( |
Champs | |
---|---|
contentUriSuggested |
Indique si une modification a été suggérée pour |
sourceUriSuggested |
Indique si une modification a été suggérée pour [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri]. |
brightnessSuggested |
Indique si une modification de la luminosité a été suggérée [google.apps.docs.v1.EmbeddedObject.brightness]. |
contrastSuggested |
Indique si une modification a été suggérée pour [contrast] [google.apps.docs.v1.EmbeddedObject.contrast]. |
transparencySuggested |
Indique si une modification de [transparence] a été suggérée [google.apps.docs.v1.EmbeddedObject.transparency]. |
cropPropertiesSuggestionState |
Masque qui indique les champs de |
angleSuggested |
Indique si une modification a été suggérée pour [angle] [google.apps.docs.v1.EmbeddedObject.angle]. |
CropPropertiesSuggestionState
Masque indiquant les champs de l'CropProperties
de base qui ont été modifiés dans cette suggestion. Une nouvelle valeur est suggérée pour chaque champ défini sur "true".
Représentation JSON |
---|
{ "offsetLeftSuggested": boolean, "offsetRightSuggested": boolean, "offsetTopSuggested": boolean, "offsetBottomSuggested": boolean, "angleSuggested": boolean } |
Champs | |
---|---|
offsetLeftSuggested |
Indique si une modification a été suggérée pour |
offsetRightSuggested |
Indique si une modification a été suggérée pour |
offsetTopSuggested |
Indique si une modification a été suggérée pour |
offsetBottomSuggested |
Indique si une modification a été suggérée pour |
angleSuggested |
Indique si une modification a été suggérée pour |
EmbeddedObjectBorderSuggestionState
Masque qui indique quels champs de la base EmbeddedObjectBorder
ont été modifiés dans cette suggestion. Une nouvelle valeur est suggérée pour chaque champ défini sur "true".
Représentation JSON |
---|
{ "colorSuggested": boolean, "widthSuggested": boolean, "dashStyleSuggested": boolean, "propertyStateSuggested": boolean } |
Champs | |
---|---|
colorSuggested |
Indique si une modification a été suggérée pour [color] [google.apps.docs.v1.EmbeddedBorderObject.color]. |
widthSuggested |
Indique si une modification a été suggérée pour [width] [google.apps.docs.v1.EmbeddedBorderObject.width]. |
dashStyleSuggested |
Indique si une modification a été suggérée pour [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style]. |
propertyStateSuggested |
Indique si une modification a été suggérée pour [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state] |
LinkedContentReferenceSuggestionState
Masque indiquant les champs de l'LinkedContentReference
de base qui ont été modifiés dans cette suggestion. Pour tout champ défini sur "true", une nouvelle valeur suggérée est proposée.
Représentation JSON |
---|
{
"sheetsChartReferenceSuggestionState": {
object ( |
Champs | |
---|---|
sheetsChartReferenceSuggestionState |
Masque indiquant les champs de |
SheetsChartReferenceSuggestionState
Masque indiquant les champs de l'SheetsChartReference
de base qui ont été modifiés dans cette suggestion. Une nouvelle valeur est suggérée pour chaque champ défini sur "true".
Représentation JSON |
---|
{ "spreadsheetIdSuggested": boolean, "chartIdSuggested": boolean } |
Champs | |
---|---|
spreadsheetIdSuggested |
Indique si une modification a été suggérée pour |
chartIdSuggested |
Indique si une modification a été suggérée pour |
PositionedObject
Objet partagé avec un Paragraph
et positionné par rapport au début du paragraphe. Un objet PositionedObject contient un EmbeddedObject
, tel qu'une image.
Représentation JSON |
---|
{ "objectId": string, "positionedObjectProperties": { object ( |
Champs | |
---|---|
objectId |
Identifiant de cet objet positionné. |
positionedObjectProperties |
Propriétés de cet objet positionné. |
suggestedPositionedObjectPropertiesChanges |
Modifications suggérées pour les propriétés de l'objet positionné, associées à l'ID de suggestion. |
suggestedInsertionId |
ID d'insertion suggéré. Si ce champ est vide, l'insertion n'est pas suggérée. |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée. |
PositionedObjectProperties
Propriétés d'un PositionedObject
.
Représentation JSON |
---|
{ "positioning": { object ( |
Champs | |
---|---|
positioning |
Positionnement de cet objet positionné par rapport à la nouvelle ligne de l' |
embeddedObject |
Objet intégré de cet objet positionné. |
PositionedObjectPositioning
Positionnement d'un PositionedObject
. L'objet positionné est positionné par rapport au début du Paragraph
avec lequel il est partagé.
Représentation JSON |
---|
{ "layout": enum ( |
Champs | |
---|---|
layout |
Mise en page de cet objet positionné. |
leftOffset |
Décalage du bord gauche de l'objet positionné par rapport au début du |
topOffset |
Décalage du bord supérieur de l'objet positionné par rapport au début du |
PositionedObjectLayout
Mises en page possibles d'un [objet positionné][google.aps.docs.v1.PositionedObject].
Enums | |
---|---|
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED |
La mise en page n'est pas spécifiée. |
WRAP_TEXT |
Le texte s'affiche autour de l'objet positionné. |
BREAK_LEFT |
Brise le texte de sorte que l'objet positionné se trouve à gauche et le texte à droite. |
BREAK_RIGHT |
Coupe le texte de sorte que l'objet positionné soit à droite et le texte à gauche. |
BREAK_LEFT_RIGHT |
Coupe le texte de sorte qu'il n'y ait pas de texte à gauche ou à droite de l'objet positionné. |
IN_FRONT_OF_TEXT |
L'objet positionné se trouve devant le texte. |
BEHIND_TEXT |
L'objet positionné se trouve derrière le texte. |
SuggestedPositionedObjectProperties
Suggestion de modification pour PositionedObjectProperties
.
Représentation JSON |
---|
{ "positionedObjectProperties": { object ( |
Champs | |
---|---|
positionedObjectProperties |
|
positionedObjectPropertiesSuggestionState |
Masque qui indique quels champs de la base |
PositionedObjectPropertiesSuggestionState
Masque qui indique quels champs de la base PositionedObjectProperties
ont été modifiés dans cette suggestion. Pour tout champ défini sur "true", une nouvelle valeur suggérée est proposée.
Représentation JSON |
---|
{ "positioningSuggestionState": { object ( |
Champs | |
---|---|
positioningSuggestionState |
Masque qui indique les champs de |
embeddedObjectSuggestionState |
Masque qui indique les champs de |
PositionedObjectPositioningSuggestionState
Masque qui indique quels champs de la base PositionedObjectPositioning
ont été modifiés dans cette suggestion. Pour tout champ défini sur "true", une nouvelle valeur suggérée est proposée.
Représentation JSON |
---|
{ "layoutSuggested": boolean, "leftOffsetSuggested": boolean, "topOffsetSuggested": boolean } |
Champs | |
---|---|
layoutSuggested |
Indique si une modification a été suggérée pour |
leftOffsetSuggested |
Indique si une modification a été suggérée pour |
topOffsetSuggested |
Indique si une modification a été suggérée pour |
SuggestionsViewMode
Mode d'affichage des suggestions appliqué au document. Il indique la façon dont les modifications suggérées sont représentées. Il propose des options pour lire le document avec toutes les suggestions intégrées, acceptées ou refusées.
Enums | |
---|---|
DEFAULT_FOR_CURRENT_ACCESS |
Le mode SuggestionsViewMode appliqué au document renvoyé dépend du niveau d'accès actuel de l'utilisateur. Si l'utilisateur ne dispose que d'un accès en lecture, PREVIEW_WITHOUT_SUGGESTIONS est appliqué. Sinon, SUGGESTIONS_INLINE est appliqué. Il s'agit du mode de vue des suggestions par défaut. |
SUGGESTIONS_INLINE |
Le document renvoyé contient des suggestions intégrées. Les modifications suggérées seront différenciées du contenu de base dans le document. Les requêtes de récupération d'un document à l'aide de ce mode renvoient une erreur 403 si l'utilisateur n'est pas autorisé à afficher les suggestions de modifications. |
PREVIEW_SUGGESTIONS_ACCEPTED |
Le document renvoyé est un aperçu dans lequel toutes les modifications suggérées sont acceptées. Les requêtes de récupération d'un document à l'aide de ce mode renvoient une erreur 403 si l'utilisateur n'est pas autorisé à afficher les suggestions de modifications. |
PREVIEW_WITHOUT_SUGGESTIONS |
Le document renvoyé est un aperçu dans lequel toutes les suggestions de modifications sont refusées, le cas échéant. |
Méthodes |
|
---|---|
|
Applique une ou plusieurs mises à jour au document. |
|
Crée un document vierge à l'aide du titre indiqué dans la requête. |
|
Récupère la dernière version du document spécifié. |