- Ressource : Document
- Corps
- StructuralElement
- Paragraphe
- ParagraphElement
- TextRun
- TextStyle
- OptionalColor
- Couleur
- RgbColor
- Dimension
- Unité
- WeightedFontFamily
- BaselineOffset
- Associer
- SuggestedTextStyle
- TextStyleSuggestionState
- Texte automatique
- Type
- PageSaut
- ColumnBreak
- FootnoteReference
- HorizontalRule
- Équation
- InlineObjectElement
- Personne
- PersonProperties
- RichLink
- Propriétés RichLink
- ParagraphStyle
- NomDuStyle
- Alignement
- ContentDirection (en anglais)
- Mode espacement
- ParagraphBorder
- Trait d'union
- TabStop
- TabStopAlignment
- Ombrage
- SuggestedParagraphStyle
- ParagraphStyleSuggestionState
- ShadingSuggestionState
- Puce
- SuggestedBullet
- BulletSuggestionState
- ObjectReferences
- Saut de section
- SectionStyle
- SectionColumnProperties
- Style style colonne
- Type de section
- Tableau
- TableRow
- TableCell
- TableCellStyle
- TableCellBorder
- Alignement du contenu
- SuggestedTableCellStyle
- TableCellStyleSuggestionState
- TableRowStyle
- SuggestedTableRowStyle
- TableRowStyleSuggestionState
- TableStyle
- TableColumnProperties
- WidthType (Type de largeur)
- TableOfContents
- En-tête
- Pied de page
- Note de bas de page
- DocumentStyle
- Contexte
- Taille
- SuggestionsDocumentStyle
- DocumentStyleSuggestionState
- BackgroundSuggestionState
- SizeSuggestionState
- NamedStyles
- NamedStyle
- SuggestionsNamedStyles
- NamedStylesSuggestionState
- NamedStyleSuggestionState
- Liste
- ListProperties
- NestingLevel
- Alignement
- Glyphe
- SuggestionsListListProperties
- ListPropertiesSuggestionState
- NestingLevelSuggestionState
- NamedRanges
- PlageNommée
- Plage
- SuggestionsViewMode
- InlineObject
- InlineObjectProperties
- EmbeddedObject
- EmbeddedDrawingProperties
- ImageProperties
- CropProperties
- EmbeddedObjectBorder
- PropertyState
- LinkedContentReference
- SheetsChartReference
- SuggestionsInlineObjectProperties
- InlineObjectPropertiesSuggestionState
- EmbeddedObjectSuggestionState
- EmbeddedDrawingPropertiesSuggestionState
- ImagePropertiesSuggestionState
- CropPropertiesSuggestionState
- EmbeddedObjectBorderStateState
- LinkedContentReferenceSuggestionState
- SheetsChartReferenceSuggestionState
- PositionedObject
- PositionedObjectProperties
- PositionedObjectPositioning
- PositionedObjectLayout
- SuggestionsPositionedObjectProperties
- PositionedObjectPropertiesSuggestionState
- PositionedObjectPositioningSuggestionState
- Méthodes
Ressource : Document
Un document Google Docs
Représentation JSON |
---|
{ "documentId": string, "title": string, "body": { object ( |
Champs | |
---|---|
documentId |
Uniquement en sortie. L'ID du document |
title |
Titre du document. |
body |
Uniquement en sortie. Corps principal du document. |
headers |
Uniquement en sortie. En-têtes du document, associés à un ID d'en-tête. |
footers |
Uniquement en sortie. Pieds de page du document, associés à un ID de pied de page. |
footnotes |
Uniquement en sortie. Notes de document du document, associées à un ID de note de bas de page. |
documentStyle |
Uniquement en sortie. Style du document. |
suggestedDocumentStyleChanges |
Uniquement en sortie. Les modifications proposées pour le style du document sont associées à un ID de suggestion. |
namedStyles |
Uniquement en sortie. Styles nommés du document. |
suggestedNamedStylesChanges |
Uniquement en sortie. Les modifications suggérées aux styles nommés du document sont associées à un ID de suggestion. |
lists |
Uniquement en sortie. Listes du document, associées à un ID de liste. |
namedRanges |
Uniquement en sortie. Plages nommées dans le document, associées à un nom. |
revisionId |
Uniquement en sortie. ID de révision du document. Peut être utilisée dans les demandes 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. N'est renseigné que si l'utilisateur est autorisé à modifier le document. L'ID de révision n'est pas un nombre séquentiel, mais une chaîne opaque. Le format de l'ID de révision peut changer au fil du temps. La validité d'un ID de révision renvoyé n'est garantie que pendant 24 heures après son envoi. Il ne peut pas être partagé entre les utilisateurs. Si l'ID de révision n'est pas modifié entre les appels, cela signifie que le document n'a pas changé. À l'inverse, si l'ID a changé (pour le même document et le même utilisateur), cela signifie généralement que le document a été mis à jour. Toutefois, un changement d'identifiant peut également être dû à des facteurs internes, tels que les changements 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 portant l'attribut |
inlineObjects |
Uniquement en sortie. Objets intégrés dans le document, associés à un ID d'objet. |
positionedObjects |
Uniquement en sortie. Objets positionnés dans le document, associés à un 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. |
Élément structurel
"StructuralElement" décrit le contenu qui structure le document.
Représentation JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
Champs | |
---|---|
startIndex |
Index de départ basé sur zéro de cet élément structurel, en unités de code UTF-16. |
endIndex |
Index de fin de base zéro de cet élément structurel, exclusif, en unités de code UTF-16. |
Champ d'union content . Contenu de l'élément structurel. content ne peut être qu'un des éléments suivants : |
|
paragraph |
Type de paragraphe de l'élément structurel. |
sectionBreak |
Type de saut de section de l'élément structurel. |
table |
Type de table de l'élément structurel. |
tableOfContents |
Table des matières du type d'élément structurel. |
Paragraph
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, divisé en plusieurs parties qui la composent. |
paragraphStyle |
Style de ce paragraphe. |
suggestedParagraphStyleChanges |
Le style de paragraphe suggéré change pour ce paragraphe, associé à l'ID de suggestion. |
bullet |
Puce pour ce paragraphe. S'il n'est pas présent, le paragraphe n'appartient pas à une liste. |
suggestedBulletChanges |
La modification suggérée dans la puce de ce paragraphe |
positionedObjectIds[] |
ID des objets positionnés partageant ce paragraphe. |
suggestedPositionedObjectIds |
ID des objets positionnés qui doivent être associés au paragraphe, avec un ID de suggestion. |
Élément de paragraphe
Un ParagraphElement décrit le contenu d'un élément Paragraph
.
Représentation JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
Champs | |
---|---|
startIndex |
Index de début de base zéro de cet élément de paragraphe, en unités de code UTF-16. |
endIndex |
Index de fin zéro base de cet élément de paragraphe, exclusif, 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 avec texte automatique. |
pageBreak |
Élément de paragraphe avec saut de page. |
columnBreak |
Élément de paragraphe avec saut de colonne |
footnoteReference |
Élément de paragraphe de référence de note de bas de page. |
horizontalRule |
Élément de paragraphe de règle horizontale. |
equation |
Élément de paragraphe d'équation. |
inlineObjectElement |
Élément de paragraphe d'objet intégré. |
person |
Élément de paragraphe qui renvoie vers une personne ou une adresse e-mail. |
richLink |
Élément de paragraphe lié à une ressource Google (un fichier dans Google Drive, une vidéo YouTube ou un événement Agenda, par exemple). |
Exécution de texte
ParagraphElement
qui représente une exécution de texte ayant 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 non textuels de l'exécution sont remplacés par le caractère Unicode U+E907. |
suggestedInsertionIds[] |
ID d'insertion suggérés. Une |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu ne sera 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 qui peut ê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'emplacement du style de texte:
- Le TextStyle du texte dans un
Paragraph
hérite dunamed style type
correspondant du paragraphe. - Le TextStyle sur un
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 du style de tableau.
Si le style de texte n'hérite pas d'un élément parent, la réinitialisation des champs rétablit le style et rétablit la valeur 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 en gras. |
italic |
Mettre le texte en italique |
underline |
Indique si le texte est souligné. |
strikethrough |
Indique si le texte est barré. |
smallCaps |
Indique si le texte est en petits caractères. |
backgroundColor |
Couleur d'arrière-plan du texte. Si elle est définie, la couleur est RVB ou transparente, en fonction du champ |
foregroundColor |
Couleur de premier plan du texte. Si elle est définie, la couleur est RVB ou transparente, en fonction du champ |
fontSize |
Taille de la police du texte. |
weightedFontFamily |
Famille de polices et épaisseur du texte affiché 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 |
link |
Lien hypertexte du texte. Si la règle n'est pas configurée, il n'y a pas de lien. Les liens ne sont pas hérités du texte parent. La modification du lien dans une requête de mise à jour entraîne des changements supplémentaires du style de texte de la plage:
|
Couleur facultative
Couleur pouvant être soit opaque, soit totalement transparente.
Représentation JSON |
---|
{
"color": {
object ( |
Champs | |
---|---|
color |
S'il est défini, il sera utilisé comme couleur opaque. Si la 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 couleur RVB. |
Couleur RVB
Couleur RVB.
Représentation JSON |
---|
{ "red": number, "green": number, "blue": number } |
Champs | |
---|---|
red |
Composant rouge de la couleur, de 0 à 1. |
green |
Composant vert de la couleur, de 0,0 à 1,0. |
blue |
Composant bleu de la couleur, de 0,0 à 1,0. |
Dimension
Magnitude dans une seule direction, dans les unités spécifiées.
Représentation JSON |
---|
{
"magnitude": number,
"unit": enum ( |
Champs | |
---|---|
magnitude |
Magnitude. |
unit |
Unités pour la magnitude. |
Unité
Unités de mesure.
Enums | |
---|---|
UNIT_UNSPECIFIED |
Les unités sont inconnues. |
PT |
Un point, 1/72 de pouce. |
Famille de polices pondérées
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 depuis le menu Police de Docs ou Google Fonts. Si le nom de la police n'est pas reconnu, le texte est affiché dans |
weight |
Épaisseur de la police. Ce champ peut contenir n'importe quelle valeur multiple d'une valeur de La valeur par défaut est L'épaisseur de la police ne représente qu'un seul de ses composants. Une combinaison de
|
BaselineOffset
Manières dont le texte peut être décalé verticalement de sa position normale.
Enums | |
---|---|
BASELINE_OFFSET_UNSPECIFIED |
Le décalage de référence du texte est hérité de l'élément parent. |
NONE |
Le texte n'est pas décalé verticalement. |
SUPERSCRIPT |
Le texte est décalé verticalement vers le haut (en 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. |
bookmarkId |
ID d'un favori dans ce document. |
headingId |
ID d'un titre dans ce document. |
Style de texte suggéré
Suggestion de modification d'un TextStyle
.
Représentation JSON |
---|
{ "textStyle": { object ( |
Champs | |
---|---|
textStyle |
|
textStyleSuggestionState |
Masque indiquant quels champs de la base |
Suggestion de style du texte
Masque indiquant quels champs de la base TextStyle
ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggéré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 s'il y a eu une suggestion de modification de |
italicSuggested |
Indique s'il y a eu une suggestion de modification de |
underlineSuggested |
Indique s'il y a eu une suggestion de modification de |
strikethroughSuggested |
Indique s'il y a eu une suggestion de modification de |
smallCapsSuggested |
Indique s'il y a eu une suggestion de modification de |
backgroundColorSuggested |
Indique s'il y a eu une suggestion de modification de |
foregroundColorSuggested |
Indique s'il y a eu une suggestion de modification de |
fontSizeSuggested |
Indique s'il y a eu une suggestion de modification de |
weightedFontFamilySuggested |
Indique s'il y a eu une suggestion de modification de |
baselineOffsetSuggested |
Indique s'il y a eu une suggestion de modification de |
linkSuggested |
Indique s'il y a eu une suggestion de modification de |
Texte automatique
ParagraphElement
représentant une zone du texte qui est remplacée de façon dynamique par du contenu qui peut changer au fil du temps, comme un numéro de page.
Représentation JSON |
---|
{ "type": enum ( |
Champs | |
---|---|
type |
Type de texte automatique. |
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 ne sera proposée. |
textStyle |
Style de texte de ce texte automatique. |
suggestedTextStyleChanges |
Le style de texte suggéré est remplacé par le texte automatique, associé à l'ID de suggestion. |
Type
Types de texte automatique.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Type de texte automatique non spécifié. |
PAGE_NUMBER |
Saisissez du texte automatique qui représente le numéro de page actuel. |
PAGE_COUNT |
Saisissez un texte automatique qui représente le nombre total de pages du document. |
Saut de page
Élément ParagraphElement
représentant un saut de page. Un saut de page fait débuter le texte suivant en haut de la page suivante.
Représentation JSON |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Champs | |
---|---|
suggestedInsertionIds[] |
ID d'insertion suggérés. Une |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu ne sera proposée. |
textStyle |
Style de texte de ce saut de page. À l'instar du contenu textuel, comme les exécutions de texte et les références à une note de bas de page, le style de texte d'un saut de page peut avoir une incidence sur la mise en page, ainsi que sur le style du texte inséré à côté. |
suggestedTextStyleChanges |
Le style de texte suggéré est remplacé par cet extrait de page, associé à l'ID de suggestion. |
Saut de colonne
ParagraphElement
représentant un saut de colonne. Le saut de colonne fait apparaître 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. Une |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu ne sera proposée. |
textStyle |
Style de texte de cet ColumnBreak. Comme pour le contenu textuel, comme les exécutions de texte et les références à une note de bas de page, le style de texte d'un saut de colonne peut avoir une incidence sur la mise en page, ainsi que sur le style du texte inséré à côté. |
suggestedTextStyleChanges |
Le style de texte suggéré est remplacé par cet élément ColumnBreak, associé à l'ID de suggestion. |
Référence à la note de bas de page
ParagraphElement
représentant une référence à une note de bas de page. Une référence à une note de bas de page correspond au contenu intégré affiché avec un nombre et permet d'identifier la note de bas de page.
Représentation JSON |
---|
{ "footnoteId": string, "footnoteNumber": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Champs | |
---|---|
footnoteId |
ID de la propriété |
footnoteNumber |
Nombre de rendus de cette note de bas de page. |
suggestedInsertionIds[] |
ID d'insertion suggérés. Une |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu ne sera proposée. |
textStyle |
Style de texte de cette note de bas de page. |
suggestedTextStyleChanges |
Le style de texte suggéré est remplacé par cette note de bas de page, associée à l'ID de la suggestion. |
Règle horizontale
Élément 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 ne sera proposée. |
textStyle |
Style de texte de cette HorizontalRule. Comme pour le contenu textuel, comme les exécutions de texte et les références à une note de bas de page, le style de texte d'une règle 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é devient HorizontalRule, associé à un 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 |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu ne sera proposée. |
Élément intégré
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 |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu ne sera proposée. |
textStyle |
Style de texte de cet élément InlineObjectElement. Comme pour le contenu textuel, comme les exécutions 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 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 cet objet InlineObject, associé à un ID de suggestion. |
Person
Une personne ou une adresse e-mail mentionnées dans un document Ces mentions se comportent comme un élément immuable unique contenant le nom ou l'adresse e-mail de la personne concernée.
Représentation JSON |
---|
{ "personId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Champs | |
---|---|
personId |
Uniquement en sortie. Identifiant unique de cette association. |
suggestedInsertionIds[] |
Les ID des suggestions permettent d'insérer cette personne dans le document. Un élément |
suggestedDeletionIds[] |
ID des suggestions de suppression du lien de cette personne du document. Un |
textStyle |
Style de texte de ce |
suggestedTextStyleChanges |
Le style de texte suggéré passe à |
personProperties |
Uniquement en sortie. Propriétés de ce |
Propriétés personnelles
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 est affiché dans le texte du lien plutôt que dans l'adresse e-mail de la personne. |
email |
Uniquement en sortie. Adresse e-mail associée à ce |
Lien profond
Lien vers une ressource Google (un fichier dans Drive, une vidéo YouTube ou un événement Agenda, par exemple).
Représentation JSON |
---|
{ "richLinkId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Champs | |
---|---|
richLinkId |
Uniquement en sortie. ID de cette association. |
suggestedInsertionIds[] |
ID des suggestions insérant ce lien dans le document Un élément |
suggestedDeletionIds[] |
ID des suggestions qui suppriment ce lien du document. Un |
textStyle |
Style de texte de ce |
suggestedTextStyleChanges |
Le style de texte suggéré passe à |
richLinkProperties |
Uniquement en sortie. Propriétés de ce |
Propriétés des liens enrichis
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. L'URI vers |
mimeType |
Uniquement en sortie. Type MIME du |
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 du style de paragraphe:
- Le ParagraphStyle dans un
Paragraph
hérite dunamed style type
correspondant du paragraphe. - Le ParagraphStyle sur un
named style
hérite du style nomménormal text
. - Le style de paragraphe Style
normal text
du style hérité hérite du style de paragraphe par défaut dans l'éditeur Docs. - Le style de paragraphe défini sur un élément
Paragraph
contenu dans un tableau peut hériter de son style de paragraphe du style de tableau.
Si le style de paragraphe n'hérite pas d'un élément parent, la réinitialisation des champs rétablit le style et rétablit une valeur correspondant aux valeurs par défaut dans l'éditeur Docs.
Représentation JSON |
---|
{ "headingId": string, "namedStyleType": enum ( |
Champs | |
---|---|
headingId |
ID du titre du paragraphe. Si ce champ est vide, il ne s'agit pas d'un titre. Cette propriété est en lecture seule. |
namedStyleType |
Type de style nommé du paragraphe. Étant donné que la mise à jour du type de style nommé a une incidence sur les autres propriétés de ParagraphStyle, il est appliqué avant les autres propriétés. |
alignment |
Alignement du texte pour ce paragraphe. |
lineSpacing |
Quantité d'espace entre des lignes, sous la forme d'un pourcentage de normal, le normal étant représenté par 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 pour le paragraphe. |
spaceAbove |
Il s'agit de la quantité d'espace supplémentaire au-dessus du paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent. |
spaceBelow |
Il s'agit de 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 "entre" s'affiche lorsque le paragraphe adjacent présente les mêmes propriétés de bordure et de retrait. Impossible de modifier partiellement les bordures des paragraphes. Lorsque vous modifiez la bordure d'un paragraphe, vous devez spécifier la nouvelle bordure dans son intégralité. |
borderTop |
Bordure en haut de ce paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent. La bordure supérieure s'affiche lorsque les propriétés de bordure et de retrait de ce paragraphe sont différentes. Impossible de modifier partiellement les bordures des paragraphes. Lorsque vous modifiez la bordure d'un paragraphe, vous devez spécifier la nouvelle bordure dans son intégralité. |
borderBottom |
Bordure en bas de ce paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent. La bordure inférieure s'affiche lorsque les propriétés de bordure et de retrait du paragraphe ci-dessous sont différentes. Impossible de modifier partiellement les bordures des paragraphes. 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 modifier partiellement les bordures des paragraphes. Lorsque vous modifiez la bordure d'un paragraphe, vous devez spécifier la nouvelle bordure dans son intégralité. |
borderRight |
Bordure à droite de ce paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent. Impossible de modifier partiellement les bordures des paragraphes. Lorsque vous modifiez la bordure d'un paragraphe, vous devez spécifier la nouvelle bordure dans son intégralité. |
indentFirstLine |
Niveau de retrait de la première ligne du paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent. |
indentStart |
La quantité de retrait pour le paragraphe sur le côté qui correspond au début du texte, en fonction de la direction actuelle du paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent. |
indentEnd |
La quantité de retrait pour le paragraphe sur le côté qui correspond à la fin du texte, en fonction de la direction actuelle du paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent. |
tabStops[] |
La liste des onglets s'arrête pour ce paragraphe. La liste des tabulations 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 colonne si possible. Si cette règle n'est pas configurée, la valeur est héritée du parent. |
keepWithNext |
Indique si une partie ou la fin 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 s'il faut éviter les veuves et les orphelins pour le paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent. |
shading |
Nuance 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. Si vous essayez de modifier |
TypeStyleStyle
Types de styles nommés.
Enums | |
---|---|
NAMED_STYLE_TYPE_UNSPECIFIED |
Le type de style nommé n'est pas spécifié. |
NORMAL_TEXT |
Texte normal. |
TITLE |
Titre. |
SUBTITLE |
Sous-titres. |
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 d'un paragraphe.
Enums | |
---|---|
ALIGNMENT_UNSPECIFIED |
L'alignement du paragraphe est hérité de l'élément parent. |
START |
Le paragraphe est aligné par rapport au début de la ligne. Aligné à gauche pour le texte de gauche à droite, sinon aligné à droite. |
CENTER |
Le paragraphe est centré. |
END |
Le paragraphe est aligné à la fin de la ligne. Aligné à droite pour le texte de gauche à droite, ou à gauche dans le cas contraire. |
JUSTIFIED |
Le paragraphe est justifié. |
Direction du contenu
Le contenu de l'itinéraire peut circuler.
Enums | |
---|---|
CONTENT_DIRECTION_UNSPECIFIED |
La direction du contenu n'est pas spécifiée. |
LEFT_TO_RIGHT |
Le contenu s'affiche de gauche à droite. |
RIGHT_TO_LEFT |
Le contenu va de droite à gauche. |
Mode espacement
Les différents modes d'espacement des paragraphes
Enums | |
---|---|
SPACING_MODE_UNSPECIFIED |
Le mode d'espacement est hérité de l'élément parent. |
NEVER_COLLAPSE |
L'espacement des paragraphes est toujours affiché. |
COLLAPSE_LISTS |
L'espacement des paragraphes est ignoré entre les éléments de liste. |
Bordure de paragraphe
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. |
Style de tirets
Types de tirets permettant d'afficher la géométrie linéaire. Ces valeurs sont basées sur le type simple "ST_PresetLineDashVal", décrit à la section 20.1.10.48 de l'article "Office Open XML File Formats - Fundamentals and Markup Language Reference" (Partie 1 de la 4e édition ECMA-376).
Enums | |
---|---|
DASH_STYLE_UNSPECIFIED |
Style de tiret non spécifié. |
SOLID |
Ligne continue. Correspond à la valeur "solide" ECMA-376 ST_PresetLineDashVal. Il s'agit du style de tiret par défaut. |
DOT |
Ligne pointillée. Correspond à la valeur "dot" de ECMA-376 ST_PresetLineDashVal. |
DASH |
Ligne en pointillés Correspond à la valeur "dash" de ECMA-376 ST_PresetLineDashVal. |
TabTab
Une tabulation dans un paragraphe.
Représentation JSON |
---|
{ "offset": { object ( |
Champs | |
---|---|
offset |
Décalage entre cet arrêt et la marge de début. |
alignment |
L'alignement de cet onglet s'arrête. Si cette règle n'est pas configurée, elle est définie par défaut sur |
TabStopAlignment
Alignement de la tabulation.
Enums | |
---|---|
TAB_STOP_ALIGNMENT_UNSPECIFIED |
L'alignement de la tabulation n'est pas spécifié. |
START |
Le taquet de tabulation est aligné au 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
Nuance d'un paragraphe.
Représentation JSON |
---|
{
"backgroundColor": {
object ( |
Champs | |
---|---|
backgroundColor |
Couleur d'arrière-plan de cette ombre de paragraphe. |
Style de paragraphe suggéré
Suggestion de modification d'un ParagraphStyle
.
Représentation JSON |
---|
{ "paragraphStyle": { object ( |
Champs | |
---|---|
paragraphStyle |
|
paragraphStyleSuggestionState |
Masque indiquant quels champs de la base |
ParagraphStyleSuggestionState
Masque indiquant quels champs de la base ParagraphStyle
ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggéré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 s'il y a eu une suggestion de modification de |
namedStyleTypeSuggested |
Indique s'il y a eu une suggestion de modification de |
alignmentSuggested |
Indique s'il y a eu une suggestion de modification de |
lineSpacingSuggested |
Indique s'il y a eu une suggestion de modification de |
directionSuggested |
Indique s'il y a eu une suggestion de modification de |
spacingModeSuggested |
Indique s'il y a eu une suggestion de modification de |
spaceAboveSuggested |
Indique s'il y a eu une suggestion de modification de |
spaceBelowSuggested |
Indique s'il y a eu une suggestion de modification de |
borderBetweenSuggested |
Indique s'il y a eu une suggestion de modification de |
borderTopSuggested |
Indique s'il y a eu une suggestion de modification de |
borderBottomSuggested |
Indique s'il y a eu une suggestion de modification de |
borderLeftSuggested |
Indique s'il y a eu une suggestion de modification de |
borderRightSuggested |
Indique s'il y a eu une suggestion de modification de |
indentFirstLineSuggested |
Indique s'il y a eu une suggestion de modification de |
indentStartSuggested |
Indique s'il y a eu une suggestion de modification de |
indentEndSuggested |
Indique s'il y a eu une suggestion de modification de |
keepLinesTogetherSuggested |
Indique s'il y a eu une suggestion de modification de |
keepWithNextSuggested |
Indique s'il y a eu une suggestion de modification de |
avoidWidowAndOrphanSuggested |
Indique s'il y a eu une suggestion de modification de |
shadingSuggestionState |
Masque indiquant les champs qui ont été modifiés dans cette suggestion dans |
pageBreakBeforeSuggested |
Indique s'il y a eu une suggestion de modification de |
ShadingSuggestionState
Masque indiquant quels champs de la base Shading
ont été modifiés dans cette suggestion de modification. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.
Représentation JSON |
---|
{ "backgroundColorSuggested": boolean } |
Champs | |
---|---|
backgroundColorSuggested |
Indique s'il y a eu une suggestion de modification de la |
Puces
Décrit une puce de 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. |
Puce suggérée
Suggestion de modification d'un Bullet
.
Représentation JSON |
---|
{ "bullet": { object ( |
Champs | |
---|---|
bullet |
|
bulletSuggestionState |
Masque indiquant quels champs de la base |
BulletSuggestionState
Masque indiquant quels champs de la base Bullet
ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.
Représentation JSON |
---|
{
"listIdSuggested": boolean,
"nestingLevelSuggested": boolean,
"textStyleSuggestionState": {
object ( |
Champs | |
---|---|
listIdSuggested |
Indique s'il y a eu une suggestion de modification de la |
nestingLevelSuggested |
Indique s'il y a eu une suggestion de modification de la |
textStyleSuggestionState |
Masque indiquant les champs qui ont été modifiés dans cette suggestion dans |
Références d'objet
Un ensemble d'ID d'objets
Représentation JSON |
---|
{ "objectIds": [ string ] } |
Champs | |
---|---|
objectIds[] |
ID des objets. |
Saut de section
StructuralElement
représentant un saut de section. Une section est une plage de contenus ayant le même SectionStyle
. Un saut de section représente le début d'une nouvelle section. Le style de section s'applique à la section qui suit 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. Une |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu ne sera proposée. |
sectionStyle |
Style de la section après ce saut de section. |
Style de section
Style qui s'applique à 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 dans l'éditeur Docs. Vous pouvez modifier une section pour qu'elle n'ait pas plus de trois colonnes. Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. La désactivation de cette propriété entraînera une erreur 400 de requête incorrecte. |
columnSeparatorStyle |
Style des séparateurs de colonnes. Vous pouvez définir ce style même si la section ne comporte qu'une seule colonne. Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. La désactivation de cette propriété génère une erreur 400 "Requête incorrecte". |
contentDirection |
Direction du contenu de cette section. Si cette règle n'est pas configurée, elle est définie par défaut sur Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. La désactivation de cette propriété génère une erreur 400 "Requête incorrecte". |
marginTop |
Marge supérieure de la page. Si cette règle n'est pas configurée, elle est définie par défaut sur Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. La désactivation de cette propriété génère une erreur 400 "Requête incorrecte". |
marginBottom |
Marge de la page en bas. Si cette règle n'est pas configurée, elle est définie par défaut sur Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. La désactivation de cette propriété génère une erreur 400 "Requête incorrecte". |
marginRight |
Marge de la page de droite de la section. Si cette règle n'est pas configurée, elle est définie par défaut sur Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. La désactivation de cette propriété génère une erreur 400 "Requête incorrecte". |
marginLeft |
Marge de la page sur la gauche. Si cette règle n'est pas configurée, elle est définie par défaut sur Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. La désactivation de cette propriété génère une erreur 400 "Requête incorrecte". |
marginHeader |
Marge de l'en-tête de la section. Si cette règle n'est pas configurée, elle est définie par défaut sur Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. La désactivation de cette propriété génère une erreur 400 "Requête incorrecte". |
marginFooter |
Marge en pied de page de la section. Si cette règle n'est pas configurée, elle est définie par défaut sur Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. La désactivation de cette propriété génère une erreur 400 "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 de l'élément "StyleStyle" Cette propriété est en lecture seule. |
defaultFooterId |
Identifiant du pied de page par défaut. Si cette règle n'est pas configurée, la valeur hérite de l'élément "StyleStyle" 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 la valeur de Cette propriété est en lecture seule. |
firstPageFooterId |
Identifiant 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 |
Identifiant 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 ou de pied de page pour la première page de la section. Si cette règle n'est pas configurée, elle hérite de l'élément Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. La désactivation de cette propriété génère une erreur 400 "Requête incorrecte". |
pageNumberStart |
Numéro de la page à partir de laquelle commencer à comptabiliser le nombre de pages pour 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 le premier Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. La désactivation de cette propriété génère une erreur 400 "Requête incorrecte". |
Propriétés de la section de colonne
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 entre les colonnes.
Enums | |
---|---|
COLUMN_SEPARATOR_STYLE_UNSPECIFIED |
Style de séparateur de colonnes non spécifié. |
NONE |
Aucune ligne de séparation entre les colonnes. |
BETWEEN_EACH_COLUMN |
Affiche une ligne de séparation entre chaque colonne. |
Type de section
Représente le positionnement de 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. |
Table
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 la table. Un tableau peut être non rectangulaire. Certaines lignes peuvent donc avoir un nombre de cellules différent. |
tableRows[] |
Contenu et style de chaque ligne. |
suggestedInsertionIds[] |
ID d'insertion suggérés. Une |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu ne sera proposée. |
tableStyle |
Style du tableau. |
TableRow
Contenu et style d'une ligne dans un élément Table
.
Représentation JSON |
---|
{ "startIndex": integer, "endIndex": integer, "tableCells": [ { object ( |
Champs | |
---|---|
startIndex |
Index de départ basé sur zéro de cette ligne, en unités de code UTF-16. |
endIndex |
Index de fin basé sur zéro de cette ligne, exclusif, en unités de code UTF-16. |
tableCells[] |
Le contenu et le style de chaque cellule de cette ligne. Un tableau peut être non rectangulaire. Il est donc possible que certaines lignes comportent un nombre de cellules différent de celui des autres lignes du même tableau. |
suggestedInsertionIds[] |
ID d'insertion suggérés. Une |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu ne sera proposée. |
tableRowStyle |
Style de la ligne du tableau. |
suggestedTableRowStyleChanges |
Le style suggéré change pour cette ligne, associé à l'ID de suggestion. |
TableCell
Contenu et style d'une cellule dans un élément Table
.
Représentation JSON |
---|
{ "startIndex": integer, "endIndex": integer, "content": [ { object ( |
Champs | |
---|---|
startIndex |
Index de début de base de cette cellule, en unités de code UTF-16. |
endIndex |
Index de fin de base 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. Une |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu ne sera proposée. |
suggestedTableCellStyleChanges |
Modifications suggérées du style des cellules du tableau, associées à l'ID de la suggestion. |
Style de cellule
Style d'une propriété TableCell
.
Les styles de cellules de tableau hérités sont représentés par des champs non définis dans ce message. Un style de cellule de tableau peut hériter du style de la table.
Représentation JSON |
---|
{ "rowSpan": integer, "columnSpan": integer, "backgroundColor": { object ( |
Champs | |
---|---|
rowSpan |
Étendue de la cellule. Cette propriété est en lecture seule. |
columnSpan |
L'étendue de colonnes de 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 de la cellule du tableau. L'alignement par défaut correspond à celui des cellules de tableau nouvellement créées dans l'éditeur Docs. |
Bordure TableCellBorder
Bordure autour d'une cellule du tableau
Les bordures de cellules du tableau ne peuvent pas être transparentes. Pour masquer la bordure d'une cellule du tableau, définissez la 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. |
Alignement du contenu
Types d'alignement de contenu.
Dérivé d'un sous-ensemble des valeurs du type simple "ST_TextAnchoringType" de la section 20.1.10.59 de la section "Formats de fichiers XML Office ouverts – Principes de base et langage de balisage", partie 1 de la quatrième édition ECMA-376.
Enums | |
---|---|
CONTENT_ALIGNMENT_UNSPECIFIED |
Un 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 |
Un alignement de contenu non accepté. |
TOP |
Un alignement qui aligne le contenu sur le haut du conteneur Correspond à ECMA-376 ST_TextAnchoringType 't'. |
MIDDLE |
Un alignement qui aligne le contenu au milieu du conteneur. Correspond à ECMA-376 ST_TextAnchoringType 'ctr'. |
BOTTOM |
Alignement qui aligne le contenu sur le bas du conteneur. Correspond à ECMA-376 ST_TextAnchoringType "b". |
Style de cellule suggéré
Suggestion de modification d'un TableCellStyle
.
Représentation JSON |
---|
{ "tableCellStyle": { object ( |
Champs | |
---|---|
tableCellStyle |
|
tableCellStyleSuggestionState |
Masque indiquant quels champs de la base |
TableCellStyleSuggestionState
Masque indiquant quels champs de la base TableCellStyle
ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.
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 s'il y a eu une suggestion de modification de |
columnSpanSuggested |
Indique s'il y a eu une suggestion de modification de |
backgroundColorSuggested |
Indique s'il y a eu une suggestion de modification de |
borderLeftSuggested |
Indique s'il y a eu une suggestion de modification de |
borderRightSuggested |
Indique s'il y a eu une suggestion de modification de |
borderTopSuggested |
Indique s'il y a eu une suggestion de modification de |
borderBottomSuggested |
Indique s'il y a eu une suggestion de modification de |
paddingLeftSuggested |
Indique s'il y a eu une suggestion de modification de |
paddingRightSuggested |
Indique s'il y a eu une suggestion de modification de |
paddingTopSuggested |
Indique s'il y a eu une suggestion de modification de |
paddingBottomSuggested |
Indique s'il y a eu une suggestion de modification de |
contentAlignmentSuggested |
Indique s'il y a eu une suggestion de modification de |
TableRowStyle
Styles qui s'appliquent à une ligne du tableau.
Représentation JSON |
---|
{
"minRowHeight": {
object ( |
Champs | |
---|---|
minRowHeight |
Hauteur minimale de la ligne. La ligne sera affichée dans l'éditeur Docs à une hauteur supérieure ou égale à cette valeur afin d'afficher tout le contenu des cellules de la ligne. |
tableHeader |
Indique si la ligne correspond à un en-tête de tableau. |
preventOverflow |
Indique si la ligne ne peut pas dépasser par-delà les limites des pages ou des colonnes. |
Style de ligne de table suggéré
Suggestion de modification d'un TableRowStyle
.
Représentation JSON |
---|
{ "tableRowStyle": { object ( |
Champs | |
---|---|
tableRowStyle |
|
tableRowStyleSuggestionState |
Masque indiquant quels champs de la base |
TableRowStyleSuggestionState
Masque indiquant quels champs de la base TableRowStyle
ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.
Représentation JSON |
---|
{ "minRowHeightSuggested": boolean } |
Champs | |
---|---|
minRowHeightSuggested |
Indique s'il y a eu une suggestion de modification de |
Style de table
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 le code HTML. Les propriétés d'une ligne se trouvent donc dans le |
TableColumnProperties
Propriétés d'une colonne dans une table.
Représentation JSON |
---|
{ "widthType": enum ( |
Champs | |
---|---|
widthType |
Type de largeur de la colonne. |
width |
Largeur de la colonne. Définissez cet attribut lorsque le paramètre |
Type de largeur
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 des colonnes est réparties uniformément entre les autres colonnes uniformément réparties. La largeur de la colonne est automatiquement déterminée et une part égale à celle du tableau reste égale après la prise en compte de toutes les colonnes avec des largeurs spécifiées. |
FIXED_WIDTH |
Largeur de colonne fixe. La propriété [width][google.apps.docs.v1.TableColumnProperties.width contient la largeur de la colonne. |
Table des matières
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 |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu ne sera proposée. |
Header
Un 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 |
Identifiant 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 |
L'arrière-plan du document La couleur d'arrière-plan des documents ne peut pas être transparente. |
defaultHeaderId |
ID de l'en-tête par défaut. Si cette règle n'est pas configurée, il n'existe pas d'en-tête par défaut. Cette propriété est en lecture seule. |
defaultFooterId |
Identifiant du pied de page par défaut. Si cet attribut n'est pas défini, aucun pied de page par défaut n'est défini. 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 |
Identifiant 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, il n'existe pas d'en-tête unique pour la première page. La valeur de Cette propriété est en lecture seule. |
firstPageFooterId |
Identifiant 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 ou de pied de page pour la première page. |
useEvenPageHeaderFooter |
Indique s'il faut utiliser les ID d'en-tête / de pied de page sur les pages paires. |
pageNumberStart |
Numéro de la page à partir de laquelle commencer à comptabiliser le nombre de pages. |
marginTop |
Marge de la page supérieure. Si vous modifiez la marge supérieure de la page sur le style du document, elle sera effacée sur tous les styles de section. |
marginBottom |
Marge de la page inférieure. Si vous modifiez la marge inférieure de la page sur le style du document, elle sera effacée sur tous les styles de section. |
marginRight |
Marge de la page de droite. Si vous modifiez la marge droite de la page dans le style du document, elle sera effacée sur tous les styles de section. Cela peut également entraîner le redimensionnement des colonnes dans toutes les sections. |
marginLeft |
Marge de la page de gauche. Si vous modifiez la marge de gauche de la page sur le style du document, elle sera effacée sur 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 |
Quantité d'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 éléments DocumentStyle Cette propriété est en lecture seule. |
Contexte
Représente l'arrière-plan d'un document.
Représentation JSON |
---|
{
"color": {
object ( |
Champs | |
---|---|
color |
Couleur d'arrière-plan. |
Taille
Largeur et hauteur.
Représentation JSON |
---|
{ "height": { object ( |
Champs | |
---|---|
height |
Hauteur de l'objet. |
width |
Largeur de l'objet. |
SuggestionDocumentStyle
Une suggestion de modification de la DocumentStyle
.
Représentation JSON |
---|
{ "documentStyle": { object ( |
Champs | |
---|---|
documentStyle |
|
documentStyleSuggestionState |
Masque indiquant quels champs de la base |
DocumentStyleSuggestionState
Masque indiquant quels champs de la base DocumentStyle
ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.
Représentation JSON |
---|
{ "backgroundSuggestionState": { object ( |
Champs | |
---|---|
backgroundSuggestionState |
Masque indiquant les champs qui ont été modifiés dans cette suggestion dans |
defaultHeaderIdSuggested |
Indique s'il y a eu une suggestion de modification de |
defaultFooterIdSuggested |
Indique s'il y a eu une suggestion de modification de |
evenPageHeaderIdSuggested |
Indique s'il y a eu une suggestion de modification de |
evenPageFooterIdSuggested |
Indique s'il y a eu une suggestion de modification de |
firstPageHeaderIdSuggested |
Indique s'il y a eu une suggestion de modification de |
firstPageFooterIdSuggested |
Indique s'il y a eu une suggestion de modification de |
useFirstPageHeaderFooterSuggested |
Indique s'il y a eu une suggestion de modification de |
useEvenPageHeaderFooterSuggested |
Indique s'il y a eu une suggestion de modification de |
pageNumberStartSuggested |
Indique s'il y a eu une suggestion de modification de |
marginTopSuggested |
Indique s'il y a eu une suggestion de modification de |
marginBottomSuggested |
Indique s'il y a eu une suggestion de modification de |
marginRightSuggested |
Indique s'il y a eu une suggestion de modification de |
marginLeftSuggested |
Indique s'il y a eu une suggestion de modification de |
pageSizeSuggestionState |
Masque indiquant les champs de [size] [google.apps.docs.v1.DocumentStyle.size] qui ont été modifiés dans cette suggestion. |
marginHeaderSuggested |
Indique s'il y a eu une suggestion de modification de |
marginFooterSuggested |
Indique s'il y a eu une suggestion de modification de |
useCustomHeaderFooterMarginsSuggested |
Indique s'il y a eu une suggestion de modification de |
SuggestionSuggestionState
Masque indiquant 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 quels champs de la base Size
ont été modifiés dans cette suggestion. Pour tout champ défini sur "true", Size
a une nouvelle valeur suggérée.
Représentation JSON |
---|
{ "heightSuggested": boolean, "widthSuggested": boolean } |
Champs | |
---|---|
heightSuggested |
Indique s'il y a eu une suggestion de modification de |
widthSuggested |
Indique s'il y a eu une suggestion de modification de |
Styles nommés
Styles nommés Les paragraphes du document peuvent hériter des éléments TextStyle
et ParagraphStyle
de ces styles nommés.
Représentation JSON |
---|
{
"styles": [
{
object ( |
Champs | |
---|---|
styles[] |
Styles nommés Il existe une entrée pour chaque |
StyleNommé
Style nommé. Les paragraphes du document peuvent hériter des 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é. |
Suggestions de styles
Une suggestion de modification de la NamedStyles
.
Représentation JSON |
---|
{ "namedStyles": { object ( |
Champs | |
---|---|
namedStyles |
|
namedStylesSuggestionState |
Masque indiquant quels champs de la base |
Suggestion de styles nommés
État de suggestion d'un message NamedStyles
.
Représentation JSON |
---|
{
"stylesSuggestionStates": [
{
object ( |
Champs | |
---|---|
stylesSuggestionStates[] |
Masque indiquant les champs de l'élément L'ordre de ces états de suggestion de style nommé correspond à l'ordre du style nommé correspondant dans la suggestion |
Suggestion de style du nom
É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 l' |
textStyleSuggestionState |
Masque indiquant les champs qui ont été modifiés dans cette suggestion dans |
paragraphStyleSuggestionState |
Masque indiquant les champs qui ont été modifiés dans cette suggestion dans |
Liste
Une liste représente les attributs de liste d'un groupe de paragraphes qui appartiennent tous à la même liste. Un paragraphe qui fait partie d'une liste fait référence à l'identifiant de la liste dans sa bullet
.
Représentation JSON |
---|
{ "listProperties": { object ( |
Champs | |
---|---|
listProperties |
Propriétés de la liste. |
suggestedListPropertiesChanges |
Modifications suggérées des propriétés de la liste, associées à l'ID de la suggestion. |
suggestedInsertionId |
ID d'insertion suggéré. Si ce champ est vide, il ne s'agit pas d'une suggestion d'insertion. |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de cette liste ne sera proposée. |
Propriétés de la liste
Propriétés d'une list
qui décrivent l'apparence des puces d'un paragraphe associé à une liste.
Représentation JSON |
---|
{
"nestingLevels": [
{
object ( |
Champs | |
---|---|
nestingLevels[] |
Décrit les propriétés des puces au niveau associé. Une liste peut comporter jusqu'à neuf niveaux d'imbrication. Le niveau d'imbrication 0 correspond au niveau le plus élevé et le niveau d'imbrication 8 au niveau le plus imbriqué. Les niveaux d'imbrication sont renvoyés par ordre croissant, les moins imbriqués étant renvoyés en premier. |
Niveau d'imbrication
Contient des propriétés décrivant l'apparence d'une liste à un niveau d'imbrication donné.
Représentation JSON |
---|
{ "bulletAlignment": enum ( |
Champs | |
---|---|
bulletAlignment |
Alignement de la puce dans l'espace prévu pour l'affichage de la puce. |
glyphFormat |
Chaîne de format utilisée par les puces à ce niveau d'imbrication. Le format du 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 du glyphe
Le format de 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 le format de glyphe
Pour les niveaux d'imbrication ordonnés, la chaîne qui remplace un espace réservé au format glyphe pour un paragraphe particulier dépend de l'ordre du paragraphe dans la liste. |
indentFirstLine |
Niveau de retrait pour la première ligne de paragraphes à ce niveau d'imbrication. |
indentStart |
Quantité de retrait pour les paragraphes à ce niveau d'imbrication. Appliqué 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 |
Nombre du premier élément de la liste à ce niveau d'imbrication. La valeur 0 correspond à 1 pour les listes numérotées et les listes de chiffres romains. Pour les valeurs à la fois 0 et 1, les listes de lettres et les chiffres romains commenceront à Cette valeur est ignorée pour les niveaux d'imbrication comportant des glyphes non ordonnés. |
Champ d'union glyph_kind . Genre de glyphe utilisé par les puces. Ce code définit le glyphe à puces 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 classés. Le type de glyphe détermine le type de glyphe utilisé pour remplacer les espaces réservés dans |
glyphSymbol |
Symbole de glyphe personnalisé utilisé par les puces lorsque les paragraphes de ce niveau d'imbrication ne sont pas ordonnés. Le symbole glyphe remplace les espaces réservés dans |
Alignement
Types d'alignement d'une puce.
Enums | |
---|---|
BULLET_ALIGNMENT_UNSPECIFIED |
L'alignement de la puce n'est pas spécifié. |
START |
La puce correspond au début de l'espace alloué à l'affichage de la puce. Aligné à gauche pour le texte de gauche à droite, sinon aligné à droite. |
CENTER |
La puce est alignée au centre de l'espace alloué à son affichage. |
END |
La puce est alignée à la fin de l'espace prévu pour le rendu. Aligné à droite pour le texte de gauche à droite, ou à gauche dans le cas contraire. |
Glyphe
Types de glyphes utilisés par 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 tel que 1 , 2 ou 3 |
ZERO_DECIMAL |
Nombre contenant un numéro à un chiffre précédé d'un zéro, tel que 01 , 02 ou 03 . Les nombres comportant plusieurs chiffres 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, comme a , b ou c . |
UPPER_ROMAN |
Un chiffre romain majuscule, comme I , II ou III . |
ROMAN |
Un chiffre romain minuscule, tel que i , ii ou iii . |
Suggestions de propriétés de liste
Suggestion de modification : ListProperties
.
Représentation JSON |
---|
{ "listProperties": { object ( |
Champs | |
---|---|
listProperties |
|
listPropertiesSuggestionState |
Masque indiquant quels champs de la base |
ListPropertiesSuggestionState
Masque indiquant quels champs de la base ListProperties
ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.
Représentation JSON |
---|
{
"nestingLevelsSuggestionStates": [
{
object ( |
Champs | |
---|---|
nestingLevelsSuggestionStates[] |
Masque indiquant les champs de l'élément Les états de suggestion de niveau d'imbrication sont renvoyés par ordre croissant du niveau d'imbrication, le moins imbriqué étant renvoyé en premier. |
Suggestion de niveau d'imbrication
Masque indiquant quels champs de la base NestingLevel
ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.
Représentation JSON |
---|
{
"bulletAlignmentSuggested": boolean,
"glyphTypeSuggested": boolean,
"glyphFormatSuggested": boolean,
"glyphSymbolSuggested": boolean,
"indentFirstLineSuggested": boolean,
"indentStartSuggested": boolean,
"textStyleSuggestionState": {
object ( |
Champs | |
---|---|
bulletAlignmentSuggested |
Indique s'il y a eu une suggestion de modification de |
glyphTypeSuggested |
Indique s'il y a eu une suggestion de modification de |
glyphFormatSuggested |
Indique s'il y a eu une suggestion de modification de |
glyphSymbolSuggested |
Indique s'il y a eu une suggestion de modification de |
indentFirstLineSuggested |
Indique s'il y a eu une suggestion de modification de |
indentStartSuggested |
Indique s'il y a eu une suggestion de modification de |
textStyleSuggestionState |
Masque indiquant les champs qui ont été modifiés dans cette suggestion dans |
startNumberSuggested |
Indique s'il y a eu une suggestion de modification de |
Plages nommées
Collection de tous les NamedRange
du document portant un nom donné.
Représentation JSON |
---|
{
"name": string,
"namedRanges": [
{
object ( |
Champs | |
---|---|
name |
Nom partagé par tous les |
namedRanges[] |
|
Plage nommée
Collection de Range
comportant le même ID de plage nommé.
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. Ainsi, leur contenu peut ê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 une seule valeur Range
, et le contenu inséré dans une plage nommée la développe généralement. Cependant, certaines modifications du document peuvent entraîner sa division en plusieurs plages.
Les plages nommées ne sont pas privées. Toutes les applications et tous les collaborateurs qui ont accès au document peuvent voir ses plages nommées.
Représentation JSON |
---|
{
"namedRangeId": string,
"name": string,
"ranges": [
{
object ( |
Champs | |
---|---|
namedRangeId |
Identifiant 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 } |
Champs | |
---|---|
segmentId |
ID de l'en-tête, du pied de page ou de la note de bas de page dans lesquels se trouve cette plage. Un ID de segment vide correspond au corps du document. |
startIndex |
Index de début basé sur zéro de cette plage, 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 Int32 afin de répondre aux futurs cas d'utilisation avec des plages ouvertes. |
endIndex |
Index de fin basé sur zéro de cette plage, exclusif dans les unités de code UTF-16. Dans toutes les utilisations actuelles, un index final doit être fourni. Ce champ est une valeur Int32 afin de répondre aux futurs cas d'utilisation avec des plages ouvertes. |
Mode VueVue
Mode d'affichage des suggestions appliqué au document, qui indique la façon dont les modifications suggérées sont représentées. Elle permet de lire le document avec toutes les suggestions intégrées, acceptées ou refusées.
Enums | |
---|---|
DEFAULT_FOR_CURRENT_ACCESS |
Le mode d'affichage des suggestions appliqué au document renvoyé dépend du niveau d'accès actuel de l'utilisateur. Si l'utilisateur dispose uniquement d'un accès en lecture, PREVIEW_WITHOUT_SUGGESTIONS est appliqué. Sinon, SUGGESTIONS_INLINE est appliqué. Il s'agit du mode d'affichage des suggestions par défaut. |
SUGGESTIONS_INLINE |
Le document renvoyé contient des suggestions intégrées. Les modifications proposées diffèrent du contenu de base du document. Les requêtes permettant de récupérer un document à l'aide de ce mode renvoient une erreur 403 si l'utilisateur n'est pas autorisé à afficher les modifications suggérées. |
PREVIEW_SUGGESTIONS_ACCEPTED |
Le document renvoyé est un aperçu. Toutes les suggestions de modifications sont acceptées. Les requêtes permettant de récupérer un document à l'aide de ce mode renvoient une erreur 403 si l'utilisateur n'est pas autorisé à afficher les modifications suggérées. |
PREVIEW_WITHOUT_SUGGESTIONS |
Le document renvoyé contient un aperçu. Toutes les suggestions de modifications sont refusées si le document en contient. |
Objet intégré
Objet qui apparaît en ligne. Un objet InlineObject contient un élément EmbeddedObject
tel qu'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 des propriétés d'objet intégrées, associées à un ID de suggestion. |
suggestedInsertionId |
ID d'insertion suggéré. Si ce champ est vide, il ne s'agit pas d'une suggestion d'insertion. |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu ne sera proposée. |
InlineObjectProperties
Propriétés d'une InlineObject
.
Représentation JSON |
---|
{
"embeddedObject": {
object ( |
Champs | |
---|---|
embeddedObject |
Objet intégré de cet objet intégré. |
Objet intégré
Objet intégré dans le document.
Représentation JSON |
---|
{ "title": string, "description": string, "embeddedObjectBorder": { object ( |
Champs | |
---|---|
title |
Titre de l'objet intégré. Les valeurs |
description |
Description de l'objet intégré. Les valeurs |
embeddedObjectBorder |
Bordure de l'objet intégré |
size |
Taille visible de l'image après 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 source externe associé. Par exemple, il contient une référence au graphique Google Sheets source lorsque l'objet intégré est un graphique lié. 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
Propriétés d'un dessin intégré permettant de différencier le type d'objet. Un dessin intégré est un dessin créé et modifié dans un document. Notez que les informations détaillées ne sont pas acceptées.
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 est tagué avec le compte du demandeur. Toute personne disposant de l'URI accède efficacement à l'image en tant que demandeur initial. Si les paramètres de partage du document changent, vous risquez de perdre l'accès à l'image. |
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 correspond à "aucun effet". |
contrast |
Effet de contraste de l'image. La valeur doit être comprise dans l'intervalle [-1,0, 1,0], où 0 correspond à "aucun effet". |
transparency |
Effet de transparence de l'image. La valeur doit être comprise dans l'intervalle [0,0, 1,0], où 0 correspond à "Aucun effet" et 1 à "Transparence". |
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. |
Propriétés du cadrage
Propriétés de recadrage d'une image.
Le rectangle de recadrage est représenté par des décalages fractionnés par rapport aux quatre bords du contenu d'origine.
- Si le décalage est dans l'intervalle (0, 1), le bord correspondant du rectangle de recadrage est positionné dans le 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 est placé en dehors du rectangle de délimitation d'origine de l'image.
- Si tous les décalages et l'angle de rotation sont définis sur 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 original, par rapport à la largeur du contenu original. |
offsetRight |
Le décalage indique la distance entre le bord droit du rectangle de recadrage et le bord droit du contenu d'origine, par rapport à 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, par rapport à la hauteur du contenu original. |
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, par rapport à la hauteur du contenu original. |
angle |
Angle de rotation 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 tiret de la bordure. |
propertyState |
État de la propriété "bordure". |
état de la propriété
États possibles d'une propriété.
Enums | |
---|---|
RENDERED |
Si l'état d'une propriété est RENDERED, l'élément possè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 source externe associé.
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 associé. |
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 intégré à la feuille de calcul Google Sheets. |
SuggestedInlineObjectProperties
Suggestion de modification : InlineObjectProperties
.
Représentation JSON |
---|
{ "inlineObjectProperties": { object ( |
Champs | |
---|---|
inlineObjectProperties |
|
inlineObjectPropertiesSuggestionState |
Masque indiquant quels champs de la base |
InlineObjectPropertiesSuggestionState
Masque indiquant quels champs de la base InlineObjectProperties
ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.
Représentation JSON |
---|
{
"embeddedObjectSuggestionState": {
object ( |
Champs | |
---|---|
embeddedObjectSuggestionState |
Masque indiquant les champs qui ont été modifiés dans cette suggestion dans |
EmbeddedObjectSuggestionState
Masque indiquant quels champs de la base EmbeddedObject
ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.
Représentation JSON |
---|
{ "embeddedDrawingPropertiesSuggestionState": { object ( |
Champs | |
---|---|
embeddedDrawingPropertiesSuggestionState |
Masque indiquant les champs qui ont été modifiés dans cette suggestion dans |
imagePropertiesSuggestionState |
Masque indiquant les champs qui ont été modifiés dans cette suggestion dans |
titleSuggested |
Indique s'il y a eu une suggestion de modification de |
descriptionSuggested |
Indique s'il y a eu une suggestion de modification de |
embeddedObjectBorderSuggestionState |
Masque indiquant les champs qui ont été modifiés dans cette suggestion dans |
sizeSuggestionState |
Masque indiquant les champs qui ont été modifiés dans cette suggestion dans |
marginLeftSuggested |
Indique s'il y a eu une suggestion de modification de |
marginRightSuggested |
Indique s'il y a eu une suggestion de modification de |
marginTopSuggested |
Indique s'il y a eu une suggestion de modification de |
marginBottomSuggested |
Indique s'il y a eu une suggestion de modification de |
linkedContentReferenceSuggestionState |
Masque indiquant les champs qui ont été modifiés dans cette suggestion dans |
EmbeddedDrawingPropertiesSuggestionState
Masque indiquant quels champs de la base EmbeddedDrawingProperties
ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.
ImagePropertiesSuggestionState
Masque indiquant quels champs de la base ImageProperties
ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.
Représentation JSON |
---|
{
"contentUriSuggested": boolean,
"sourceUriSuggested": boolean,
"brightnessSuggested": boolean,
"contrastSuggested": boolean,
"transparencySuggested": boolean,
"cropPropertiesSuggestionState": {
object ( |
Champs | |
---|---|
contentUriSuggested |
Indique s'il y a eu une suggestion de modification de |
sourceUriSuggested |
Indique si une modification suggérée a été apportée à [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri]. |
brightnessSuggested |
Indique si une modification suggérée a été apportée à [brightness] [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 suggérée a été apportée à [transparency] [google.apps.docs.v1.EmbeddedObject.transparency]. |
cropPropertiesSuggestionState |
Masque indiquant les champs qui ont été modifiés dans cette suggestion dans |
angleSuggested |
Indique s'il y a eu une modification suggérée pour [angle] [google.apps.docs.v1.EmbeddedObject.angle]. |
État des suggestions de recadrage
Masque indiquant quels champs de la base CropProperties
ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.
Représentation JSON |
---|
{ "offsetLeftSuggested": boolean, "offsetRightSuggested": boolean, "offsetTopSuggested": boolean, "offsetBottomSuggested": boolean, "angleSuggested": boolean } |
Champs | |
---|---|
offsetLeftSuggested |
Indique s'il y a eu une suggestion de modification de |
offsetRightSuggested |
Indique s'il y a eu une suggestion de modification de |
offsetTopSuggested |
Indique s'il y a eu une suggestion de modification de |
offsetBottomSuggested |
Indique s'il y a eu une suggestion de modification de |
angleSuggested |
Indique s'il y a eu une suggestion de modification de |
EmbeddedObjectBorderState
Masque indiquant quels champs de la base EmbeddedObjectBorder
ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.
Représentation JSON |
---|
{ "colorSuggested": boolean, "widthSuggested": boolean, "dashStyleSuggested": boolean, "propertyStateSuggested": boolean } |
Champs | |
---|---|
colorSuggested |
Indique si une modification suggérée a été apportée à [color] [google.apps.docs.v1.EmbeddedBorderObject.color]. |
widthSuggested |
Indique s'il y a eu une modification suggérée pour [width] [google.apps.docs.v1.EmbeddedBorderObject.width]. |
dashStyleSuggested |
Indique s'il y a eu une modification suggérée pour le [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style]. |
propertyStateSuggested |
Indique s'il y a eu une modification suggérée pour [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state]. |
LinkedContentReferenceSuggestionState
Masque indiquant quels champs de la base LinkedContentReference
ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.
Représentation JSON |
---|
{
"sheetsChartReferenceSuggestionState": {
object ( |
Champs | |
---|---|
sheetsChartReferenceSuggestionState |
Masque indiquant les champs qui ont été modifiés dans cette suggestion dans |
SheetsChartReferenceSuggestionState
Masque indiquant quels champs de la base SheetsChartReference
ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.
Représentation JSON |
---|
{ "spreadsheetIdSuggested": boolean, "chartIdSuggested": boolean } |
Champs | |
---|---|
spreadsheetIdSuggested |
Indique s'il y a eu une suggestion de modification de |
chartIdSuggested |
Indique s'il y a eu une suggestion de modification de |
Objet positionné
Objet limité à un Paragraph
et positionné par rapport au début du paragraphe. Un objet PositionedObject contient un élément EmbeddedObject
tel qu'une image.
Représentation JSON |
---|
{ "objectId": string, "positionedObjectProperties": { object ( |
Champs | |
---|---|
objectId |
ID de cet objet positionné. |
positionedObjectProperties |
Propriétés de cet objet positionné. |
suggestedPositionedObjectPropertiesChanges |
Modifications suggérées des propriétés d'objets positionnées, associées à l'ID de suggestion. |
suggestedInsertionId |
ID d'insertion suggéré. Si ce champ est vide, il ne s'agit pas d'une suggestion d'insertion. |
suggestedDeletionIds[] |
ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu ne sera 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 |
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
auquel 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 [PositionedObject][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'encapsule autour de l'objet positionné. |
BREAK_LEFT |
Divise le texte de sorte que l'objet positionné se trouve à gauche et que le texte se trouve à droite. |
BREAK_RIGHT |
Divise le texte de sorte que l'objet positionné se trouve à droite et le texte à gauche. |
BREAK_LEFT_RIGHT |
Divise le texte de sorte qu'il n'y ait aucun 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. |
SuggestionsPositionedObjectProperties
Suggestion de modification : PositionedObjectProperties
.
Représentation JSON |
---|
{ "positionedObjectProperties": { object ( |
Champs | |
---|---|
positionedObjectProperties |
|
positionedObjectPropertiesSuggestionState |
Masque indiquant quels champs de la base |
PositionedObjectPropertiesSuggestionState
Masque indiquant quels champs de la base PositionedObjectProperties
ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.
Représentation JSON |
---|
{ "positioningSuggestionState": { object ( |
Champs | |
---|---|
positioningSuggestionState |
Masque indiquant les champs qui ont été modifiés dans cette suggestion dans |
embeddedObjectSuggestionState |
Masque indiquant les champs qui ont été modifiés dans cette suggestion dans |
PositionedObjectPositioningSuggestionState
Masque indiquant quels champs de la base PositionedObjectPositioning
ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.
Représentation JSON |
---|
{ "layoutSuggested": boolean, "leftOffsetSuggested": boolean, "topOffsetSuggested": boolean } |
Champs | |
---|---|
layoutSuggested |
Indique s'il y a eu une suggestion de modification de |
leftOffsetSuggested |
Indique s'il y a eu une suggestion de modification de |
topOffsetSuggested |
Indique s'il y a eu une suggestion de modification de |
Méthodes |
|
---|---|
|
Applique une ou plusieurs mises à jour du 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é. |