- Ressource : Document
- Corps du texte
- StructuralElement
- Paragraphe
- ParagraphElement
- TextRun
- TextStyle
- OptionalColor
- Couleur
- RgbColor
- Dimension
- Unité
- WeightedFontFamily
- Décalage de référence
- Lien
- SuggestedTextStyle
- TextStyleSuggestionState
- Texte automatique
- Type
- Saut de page
- ColumnBreak
- Référence de la note de bas de page
- HorizontalRule
- Équation
- InlineObjectElement
- Personne
- PersonProperties
- RichLink
- RichLinkProperties
- ParagraphStyle
- NamedStyleType (Type de style nommé)
- Alignement
- ContentDirection
- Mode Espacement
- ParagraphBorder
- Style de tableau
- TabStop
- TabStopAlignment
- Ombre
- SuggestedParagraphStyle
- ParagraphStyleSuggestionState
- ShadingSuggestionState
- Puce
- suggestedPoint
- BulletSuggestionState
- ObjectReferences
- SectionBreak
- SectionStyle
- SectionColumnProperties
- ColumnSeparatorStyle
- Type de section
- Tableau
- TableRow
- TableCell
- TableCellStyle
- TableCellBorder
- ContentAlignment.
- SuggestedTableCellStyle
- TableCellStyleSuggestionState
- TableRowStyle
- SuggestedTableRowStyle
- TableRowStyleSuggestionState
- TableStyle
- TableColumnProperties
- WidthType
- TableOfContents
- En-tête
- Pied de page
- Note de bas de page
- DocumentStyle
- Contexte
- Taille
- SuggestedDocumentStyle
- DocumentStyleSuggestionState
- BackgroundSuggestionState
- SizeSuggestionState
- NamedStyles
- NamedStyle
- suggestedNamedStyles
- NamedStylesSuggestionState
- NamedStyleSuggestionState
- Liste
- ListProperties
- NestingLevel
- BulletAlignment
- GlyphType (Type de glyphe)
- SuggestedListProperties
- ListPropertiesSuggestionState
- NestingLevelSuggestionState
- NamedRanges
- NamedRange
- Portée
- SuggestionsViewMode
- InlineObject
- InlineObjectProperties
- EmbeddedObject
- EmbeddedDrawingProperties
- ImageProperties
- Propriétés de recadrage
- EmbeddedObjectBorder
- PropertyState
- LinkedContentReference
- SheetsChartReference
- SuggestedInlineObjectProperties
- InlineObjectPropertiesSuggestionState
- EmbeddedObjectSuggestionState
- EmbeddedDrawingPropertiesSuggestionState
- ImagePropertiesSuggestionState
- CropPropertiesSuggestionState
- EmbeddedObjectBorderSuggestionState
- LinkedContentReferenceSuggestionState
- SheetsChartReferenceSuggestionState
- PositionedObject
- PositionedObjectProperties
- PositionedObjectPositioning
- PositionedObjectLayout
- SuggestedPositionedObjectProperties
- PositionedObjectPropertiesSuggestionState
- PositionedObjectPositioningSuggestionState
- Méthodes
Ressource : Document
Un document Google Docs.
Représentation JSON |
---|
{ "documentId": string, "title": string, "body": { object ( |
Champs | |
---|---|
documentId |
Uniquement en sortie. Identifiant 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 par ID d'en-tête. |
footers |
Uniquement en sortie. Pieds de page du document, associés à l'ID de pied de page. |
footnotes |
Uniquement en sortie. Notes de bas de page du document, associées à l'ID de la note de bas de page. |
documentStyle |
Uniquement en sortie. Style du document. |
suggestedDocumentStyleChanges |
Uniquement en sortie. Suggestions de modifications du style du document, associées à l'ID de suggestion. |
namedStyles |
Uniquement en sortie. Styles nommés du document. |
suggestedNamedStylesChanges |
Uniquement en sortie. Modifications suggérées pour les styles nommés du document, associées à l'ID de suggestion. |
lists |
Uniquement en sortie. Listes du document, associées à l'ID de liste. |
namedRanges |
Uniquement en sortie. Plages nommées dans le document, associées par nom. |
revisionId |
Uniquement en sortie. ID de révision du document. Ce paramètre peut être utilisé 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. 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. La validité d'un ID de révision renvoyé est garantie uniquement 24 heures à compter de l'envoi. Elle ne peut pas être partagée entre plusieurs utilisateurs. Si l'ID de révision reste le même entre les appels, le document n'a pas été modifié. À l'inverse, la modification d'un identifiant (pour le même document et le même utilisateur) signifie généralement que le document a été mis à jour. Toutefois, une modification de l'ID peut également être due à des facteurs internes, tels que des modifications du format de l'ID. |
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 comportant |
inlineObjects |
Uniquement en sortie. Objets intégrés dans le document, associés à l'ID d'objet. |
positionedObjects |
Uniquement en sortie. Objets positionnés dans le document, associés à leur ID. |
Body
Corps du document.
Le corps contient généralement le contenu complet 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 de structure
Un élément StructuralElement décrit du contenu qui structure le document.
Représentation JSON |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
Champs | |
---|---|
startIndex |
Indice de départ de base zéro de cet élément structurel, en unités de code UTF-16. |
endIndex |
Index de fin basé sur 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 |
Élément structurel de type paragraphe. |
sectionBreak |
Type de saut de section d'élément structurel. |
table |
Type d'élément de structure de tableau. |
tableOfContents |
Type d'élément structurel de table des matières. |
Paragraphe
StructuralElement
représentant un paragraphe. Un paragraphe est une plage de contenu qui se termine par un retour à la ligne.
Représentation JSON |
---|
{ "elements": [ { object ( |
Champs | |
---|---|
elements[] |
Contenu du paragraphe décomposé en différentes parties. |
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 est absent, le paragraphe n'appartient pas à une liste. |
suggestedBulletChanges |
Les modifications suggérées pour la puce de ce paragraphe. |
positionedObjectIds[] |
Les identifiants des objets positionnés reliés à ce paragraphe. |
suggestedPositionedObjectIds |
Les ID des objets positionnés suggérés à associer à ce paragraphe, regroupés par ID de suggestion. |
Élément de paragraphe
Un élément 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 à base zéro 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 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 faisant référence à une 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 à une personne ou à une adresse e-mail. |
richLink |
Élément de paragraphe qui renvoie à une ressource Google (par exemple, un fichier dans Google Drive, une vidéo YouTube ou un événement d'agenda) |
Exécution de texte
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 non textuels sont remplacés par le caractère Unicode U+E907. |
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 cette exécution. |
suggestedTextStyleChanges |
Le style de texte suggéré est modifié 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ù il est défini:
- Le TextStyle du texte d'un
Paragraph
hérite dunamed style type
correspondant au 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 de celui du style de tableau.
Si le style de texte n'hérite pas d'un parent, le fait de désactiver des champs rétablit la valeur par défaut du style 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. |
italic |
Indique si le texte est en italique. |
underline |
Indique si le texte est souligné ou non. |
strikethrough |
Indique si le texte est rayé. |
smallCaps |
Indique si le texte est en minuscules. |
backgroundColor |
Couleur d'arrière-plan du texte. Si cette option est définie, la couleur peut être une couleur RVB ou transparente, selon le champ |
foregroundColor |
Couleur de premier plan du texte. Si cette option est définie, la couleur peut être une couleur RVB ou transparente, selon le champ |
fontSize |
Taille de la police du texte. |
weightedFontFamily |
Famille de polices et épaisseur de rendu du texte. Si une requête de mise à jour spécifie des valeurs à la fois 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 texte sous forme de lien hypertexte. Si cette règle n'est pas configurée, aucun lien ne s'affiche. Les liens ne sont pas hérités du texte parent. La modification du lien dans une requête de mise à jour entraîne d'autres modifications du style de texte de la plage:
|
Couleur facultative
Couleur qui peut être totalement opaque ou totalement transparente.
Représentation JSON |
---|
{
"color": {
object ( |
Champs | |
---|---|
color |
Si cette option est définie, elle est utilisée comme couleur opaque. Si cette valeur n'est pas définie, elle représente 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, compris entre 0.0 et 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 un sens unique, dans les unités spécifiées.
Représentation JSON |
---|
{
"magnitude": number,
"unit": enum ( |
Champs | |
---|---|
magnitude |
L’ampleur. |
unit |
Unités de la magnitude. |
Unité
Unités de mesure.
Enums | |
---|---|
UNIT_UNSPECIFIED |
Les unités sont inconnues. |
PT |
Un point, 1/72 de pouce. |
WeightedFontFamily (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. Vous pouvez choisir n'importe quelle famille de polices dans le menu "Police" de Docs ou depuis Google Fonts. Si le nom de la police n'est pas reconnu, le texte s'affiche en |
weight |
Épaisseur de la police. La valeur de ce champ peut être un multiple de La valeur par défaut est L'épaisseur de la police ne constitue qu'un composant de l'épaisseur de la police affichée. Une combinaison de
|
Début de ligne (BaselineOffset)
Façons dont le texte peut être décalé verticalement par rapport à sa position normale.
Enums | |
---|---|
BASELINE_OFFSET_UNSPECIFIED |
Le décalage de référence du texte est hérité de celui du 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 |
Identifiant d'un favori dans ce document. |
headingId |
ID d'un titre dans ce document. |
Style de texte suggéré
Suggestion de modification d'un élément TextStyle
.
Représentation JSON |
---|
{ "textStyle": { object ( |
Champs | |
---|---|
textStyle |
Un élément |
textStyleSuggestionState |
Masque qui indique quels champs de l'élément |
État de la suggestion de style de texte
Masque qui indique quels champs de l'élément TextStyle
de base ont été modifiés dans cette suggestion. Une nouvelle valeur est suggérée pour chaque champ défini sur "true".
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 |
Texte automatique
ParagraphElement
représentant une partie du texte qui est remplacée dynamiquement par du contenu pouvant 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 ce texte automatique. |
suggestedTextStyleChanges |
Le style de texte suggéré est remplacé par 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 |
Saisissez du texte automatique représentant le numéro de la page actuelle. |
PAGE_COUNT |
Saisissez du texte automatique représentant le nombre total de pages du document. |
Saut de page
ParagraphElement
représentant un saut de page. Un saut de page fait commencer le texte suivant au début 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 textes et les références à des notes de bas de page, le style d'un saut de page 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 modifié pour ce saut de page, associé à l'ID de suggestion. |
Saut de colonne
ParagraphElement
représentant un saut de colonne. Un saut de colonne fait commencer le texte suivant au début 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 textes et les références à des notes de bas de page, le style 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é change pour ce ColumnBreak, associé à l'ID de suggestion. |
Référence de 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 est le contenu intégré rendu avec un numéro. Elle 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 |
footnoteNumber |
Numéro de rendu de cette note de bas de page. |
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 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, associée à l'ID de suggestion. |
Règle horizontale
ParagraphElement
représentant une ligne horizontale.
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 cette HorizontalRule. Comme pour le contenu textuel, comme les exécutions de texte et les références à des notes 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é est remplacé par cette HorizontalRule, associé à 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 du |
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 InlineObjectElement. Comme pour le contenu textuel, comme les exécutions de texte et les références à des notes 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é à l'ID de suggestion. |
Person
Personne ou 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[] |
Identifiants des suggestions qui insèrent le lien de cette personne dans le document. Un élément |
suggestedDeletionIds[] |
Identifiants des suggestions qui suppriment le lien de cette personne du document. Une |
textStyle |
Style de texte de cet élément |
suggestedTextStyleChanges |
Le style de texte suggéré est remplacé par ce |
personProperties |
Uniquement en sortie. Propriétés de ce |
Propriétéspersonnes
Propriétés spécifiques à un Person
associé.
Représentation JSON |
---|
{ "name": string, "email": string } |
Champs | |
---|---|
name |
Uniquement en sortie. Nom de la personne s'il apparaît dans le texte du lien plutôt que dans son adresse e-mail. |
email |
Uniquement en sortie. Adresse e-mail associée à ce |
Lien enrichi
Lien vers une ressource Google (fichier dans Drive, vidéo YouTube ou événement d'agenda, par exemple).
Représentation JSON |
---|
{ "richLinkId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Champs | |
---|---|
richLinkId |
Uniquement en sortie. Identifiant de cette association. |
suggestedInsertionIds[] |
ID des suggestions qui insèrent ce lien dans le document. Un élément |
suggestedDeletionIds[] |
ID des suggestions qui suppriment ce lien du document. Une |
textStyle |
Style de texte de cet élément |
suggestedTextStyleChanges |
Le style de texte suggéré est remplacé par ce |
richLinkProperties |
Uniquement en sortie. Propriétés de ce |
Propriétés d'un lien enrichi
Propriétés spécifiques à un élément RichLink
.
Représentation JSON |
---|
{ "title": string, "uri": string, "mimeType": string } |
Champs | |
---|---|
title |
Uniquement en sortie. Titre du |
uri |
Uniquement en sortie. L'URI de |
mimeType |
Uniquement en sortie. Type MIME du fichier |
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'endroit où il est défini:
- Le ParagraphStyle sur 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 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 être hérité du style de paragraphe du style de tableau.
Si le style de paragraphe n'hérite pas d'un parent, le fait de désactiver des champs rétablit la valeur par défaut du style dans l'éditeur Docs.
Représentation JSON |
---|
{ "headingId": string, "namedStyleType": enum ( |
Champs | |
---|---|
headingId |
ID de titre du paragraphe. S'il est vide, ce paragraphe n'est pas un en-tête. 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é affecte les autres propriétés de ParagraphStyle, le type de style nommé est appliqué avant la mise à jour des autres propriétés. |
alignment |
Alignement du texte pour ce paragraphe. |
lineSpacing |
Quantité d'espace entre les lignes, exprimée en pourcentage de la normale, où la valeur normale est représentée par 100,0. Si cette valeur n'est pas définie, la valeur est héritée du parent. |
direction |
Sens du texte de ce paragraphe. Si cette valeur n'est pas définie, la valeur par défaut est |
spacingMode |
Mode d'espacement du paragraphe. |
spaceAbove |
Quantité d'espace supplémentaire au-dessus du paragraphe. Si cette valeur n'est pas définie, la valeur est héritée du parent. |
spaceBelow |
Quantité d'espace supplémentaire sous le paragraphe. Si cette valeur n'est pas définie, la valeur est héritée du parent. |
borderBetween |
La bordure entre ce paragraphe et les paragraphes suivant et précédent. Si cette valeur n'est pas définie, la valeur est héritée du parent. La bordure entre les éléments est affichée lorsque le paragraphe adjacent a les mêmes propriétés de bordure et de retrait. 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é. |
borderTop |
Bordure en haut de ce paragraphe. Si cette valeur n'est pas définie, la valeur est héritée du parent. La bordure supérieure est affichée lorsque le paragraphe ci-dessus 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, la nouvelle bordure doit être spécifiée dans son intégralité. |
borderBottom |
Bordure en bas de ce paragraphe. Si cette valeur n'est pas définie, la valeur est héritée du parent. La bordure inférieure s'affiche 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, la nouvelle bordure doit être spécifiée dans son intégralité. |
borderLeft |
Bordure à gauche de ce paragraphe. Si cette valeur n'est pas définie, 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, 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é. |
indentFirstLine |
Quantité de retrait pour la première ligne du paragraphe. Si cette valeur n'est pas définie, la valeur est héritée du parent. |
indentStart |
Quantité de retrait du paragraphe sur le côté correspondant au début du texte, en fonction de l'orientation actuelle du paragraphe. Si cette valeur n'est pas définie, la valeur est héritée du parent. |
indentEnd |
Quantité de retrait du paragraphe sur le côté correspondant à la fin du texte, en fonction de l'orientation actuelle du paragraphe. Si cette valeur n'est pas définie, la valeur est héritée du parent. |
tabStops[] |
Liste des tabulations 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 colonne, si possible. Si cette valeur n'est pas définie, la valeur est héritée du parent. |
keepWithNext |
Indique si au moins une partie de ce paragraphe doit être affichée sur la même page ou colonne que le paragraphe suivant, si possible. Si cette valeur n'est pas définie, la valeur est héritée du parent. |
avoidWidowAndOrphan |
Indique s'il faut éviter les veuves et les orphelins pour le paragraphe. Si cette valeur n'est pas définie, la valeur est héritée du parent. |
shading |
Ombre du paragraphe. Si cette valeur n'est pas définie, 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 valeur n'est pas définie, la valeur est héritée du parent. Toute tentative de mise à jour de |
Type de style nommé
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-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 de texte pour un paragraphe.
Enums | |
---|---|
ALIGNMENT_UNSPECIFIED |
L'alignement de 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é par rapport à la fin de la ligne. Aligné à droite pour le texte de gauche à droite. Sinon, aligné à gauche. |
JUSTIFIED |
Le paragraphe est justifié. |
ContentDirection
Le contenu de l'itinéraire peut s'intégrer.
Enums | |
---|---|
CONTENT_DIRECTION_UNSPECIFIED |
La direction du contenu n'est pas spécifiée. |
LEFT_TO_RIGHT |
Le contenu va de gauche à droite. |
RIGHT_TO_LEFT |
Le contenu va de droite à gauche. |
Mode Espace
Différents modes d'espacement entre les paragraphes.
Enums | |
---|---|
SPACING_MODE_UNSPECIFIED |
Le mode d'espacement est hérité du parent. |
NEVER_COLLAPSE |
L'espacement des paragraphes est toujours affiché. |
COLLAPSE_LISTS |
L'espacement entre les éléments de la liste est ignoré. |
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 tableau
Types de tirets avec lesquels la géométrie linéaire peut être affichée. Ces valeurs sont basées sur le type simple "ST_PresetLineDashVal" décrit dans la section 20.1.10.48 du document "Office Open XML File Formats - Fundamentals and Markup Language Reference", partie 1 d'ECMA-376 4e édition.
Enums | |
---|---|
DASH_STYLE_UNSPECIFIED |
Style de tiret non spécifié. |
SOLID |
Ligne continue. Correspond à la valeur ECMA-376 ST_PresetLineDashVal ("solide"). Il s'agit du style de tiret par défaut. |
DOT |
Ligne pointillée. Correspond à la valeur "point" ST_PresetLineDashVal de ECMA-376. |
DASH |
Ligne en pointillés. Correspond à la valeur "tiret" ECMA-376 ST_PresetLineDashVal. |
Arrêt de tabulation
Tabulation dans un paragraphe.
Représentation JSON |
---|
{ "offset": { object ( |
Champs | |
---|---|
offset |
Décalage entre ce taquet de tabulation et la marge de début. |
alignment |
Alignement de ce taquet de tabulation. Si cette valeur n'est pas configurée, la valeur par défaut est |
TabStopAlignment
Alignement du taquet de tabulation.
Enums | |
---|---|
TAB_STOP_ALIGNMENT_UNSPECIFIED |
L'alignement de la tabulation n'est pas spécifié. |
START |
La tabulation est alignée par rapport au début de la ligne. Il s'agit de la valeur par défaut. |
CENTER |
La tabulation est alignée par rapport au centre de la ligne. |
END |
La tabulation est alignée par rapport à la fin de la ligne. |
Ombre
Ombrage d'un paragraphe.
Représentation JSON |
---|
{
"backgroundColor": {
object ( |
Champs | |
---|---|
backgroundColor |
Couleur d'arrière-plan de ce ombrage de paragraphe. |
SuggestedParagraphStyle (Style de paragraphe suggéré)
Suggestion de modification d'un élément ParagraphStyle
.
Représentation JSON |
---|
{ "paragraphStyle": { object ( |
Champs | |
---|---|
paragraphStyle |
Un élément |
paragraphStyleSuggestionState |
Masque qui indique quels champs de l'élément |
ParagraphStyleSuggestionState
Masque qui indique quels champs de l'élément ParagraphStyle
de base ont été modifiés dans cette suggestion. Une nouvelle valeur est suggérée pour chaque champ défini sur "true".
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 qui indique quels champs de |
pageBreakBeforeSuggested |
Indique si une modification a été suggérée pour |
ShadingSuggestionState
Masque indiquant quels champs de l'élément Shading
de base 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 suggestion de modification a été apportée à |
Puces
Décrit la puce d'un paragraphe.
Représentation JSON |
---|
{
"listId": string,
"nestingLevel": integer,
"textStyle": {
object ( |
Champs | |
---|---|
listId |
ID de la liste à laquelle appartient ce paragraphe. |
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 élément Bullet
.
Représentation JSON |
---|
{ "bullet": { object ( |
Champs | |
---|---|
bullet |
Un élément |
bulletSuggestionState |
Masque qui indique quels champs de l'élément |
BulletSuggestionState
Masque qui indique quels champs de l'élément Bullet
de base 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 suggestion de modification a été apportée à |
nestingLevelSuggested |
Indique si une suggestion de modification a été apportée à |
textStyleSuggestionState |
Masque qui indique quels champs de |
Références d'objets
Collection 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 contenu 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. 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. |
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 elle est vide, la section contient une colonne avec les propriétés par défaut dans l'éditeur Docs. Une section peut être mise à jour de sorte qu'elle ne comporte pas plus de trois colonnes. Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. Si vous annulez cette propriété, une erreur 400 de requête incorrecte sera générée. |
columnSeparatorStyle |
Style des séparateurs de colonnes. Vous pouvez définir ce style même si la section ne comporte qu'une colonne. Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. Si vous annulez la définition de cette propriété, une erreur 400 de requête incorrecte est générée. |
contentDirection |
Sens du contenu de cette section. Si cette valeur n'est pas configurée, la valeur par défaut est Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. Si vous annulez la définition de cette propriété, une erreur 400 de requête incorrecte est générée. |
marginTop |
Marge supérieure de la section. Si cette valeur 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. Si vous annulez la définition de cette propriété, une erreur 400 de requête incorrecte est générée. |
marginBottom |
Marge inférieure de la section. Si cette valeur 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. Si vous annulez la définition de cette propriété, une erreur 400 de requête incorrecte est générée. |
marginRight |
Marge de droite de la section. Si cette valeur 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. Si vous annulez la définition de cette propriété, une erreur 400 de requête incorrecte est générée. |
marginLeft |
Marge gauche de la section. Si cette valeur 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. Si vous annulez la définition de cette propriété, une erreur 400 de requête incorrecte est générée. |
marginHeader |
Marge de l'en-tête de la section. Si cette valeur 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. Si vous annulez la définition de cette propriété, une erreur 400 de requête incorrecte est générée. |
marginFooter |
Marge du pied de page de la section. Si cette valeur 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. Si vous annulez la définition de cette propriété, une erreur 400 de requête incorrecte est générée. |
sectionType |
Uniquement en sortie. Type de section. |
defaultHeaderId |
ID de l'en-tête par défaut. Si cette valeur n'est pas définie, la valeur hérite du style de section précédent Cette propriété est en lecture seule. |
defaultFooterId |
ID du pied de page par défaut. Si cette valeur n'est pas définie, la valeur hérite du style de section précédent 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 |
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 l'attribut Cette propriété est en lecture seule. |
evenPageFooterId |
Identifiant du pied de page utilisé uniquement pour les pages paires. Si la valeur de l'attribut Cette propriété est en lecture seule. |
useFirstPageHeaderFooter |
Indique si les ID d'en-tête / de pied de page de la première page doivent être utilisés pour la première page de la section. Si cette valeur n'est pas définie, elle hérite du Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. Si vous annulez la définition de cette propriété, une erreur 400 de requête incorrecte est générée. |
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 reprend à 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. Si vous annulez la définition de cette propriété, une erreur 400 de requête incorrecte est générée. |
flipPageOrientation |
Facultatif. Indique s'il faut inverser les dimensions de l'attribut Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. Si vous annulez la définition de cette propriété, une erreur 400 de requête incorrecte est générée. |
Propriétés de la colonne de section
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. |
Style de la fonction ColumnSeparatorStyle
Style des séparateurs entre les colonnes.
Enums | |
---|---|
COLUMN_SEPARATOR_STYLE_UNSPECIFIED |
Style de séparateur de colonne 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 la position 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. |
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. Il est possible qu'un tableau ne soit pas rectangulaire, donc certaines lignes peuvent avoir un nombre différent de cellules. |
tableRows[] |
Contenu et style de chaque ligne |
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. |
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[] |
Contenu et style de chaque cellule de cette ligne. Il est possible qu'un tableau ne soit pas rectangulaire. Ainsi, certaines lignes peuvent avoir un nombre de cellules différent de celui d'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é est modifié pour cette ligne, associé à l'ID de suggestion. |
TableCell
Contenu et style d'une cellule dans une Table
.
Représentation JSON |
---|
{ "startIndex": integer, "endIndex": integer, "content": [ { object ( |
Champs | |
---|---|
startIndex |
Index de départ de base zéro de cette cellule, en unités de code UTF-16. |
endIndex |
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 é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. |
suggestedTableCellStyleChanges |
Suggestions de modifications du style de cellule du tableau, associées à l'ID de suggestion. |
StyleCell type de table
Style d'un TableCell
.
Dans ce message, les styles de cellules hérités sont représentés par des champs non définis. Un style de 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 |
Étendue de la colonne 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 dans la cellule du tableau. L'alignement par défaut correspond à celui des nouvelles cellules du tableau dans l'éditeur Docs. |
BordureTableCellBorder
Bordure autour d'une cellule du tableau.
Les bordures des cellules du tableau ne peuvent pas être transparentes. Pour masquer la bordure d'une cellule du 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. |
Alignement du contenu
Types d'alignements de contenu.
Dérivé d'un sous-ensemble de valeurs du type simple "ST_TextAnchoringType" indiqué dans la section 20.1.10.59 de "Office Open XML File Formats - Fundamentals and Markup Language Reference" (documentation de référence sur le langage de balisage et les principes de base d'Office), partie 1 d'ECMA-376 4e édition.
Enums | |
---|---|
CONTENT_ALIGNMENT_UNSPECIFIED |
Alignement du contenu non spécifié. L'alignement du contenu est hérité du parent, le cas échéant. |
CONTENT_ALIGNMENT_UNSUPPORTED |
Alignement de contenu non compatible. |
TOP |
Alignement permettant d'aligner le contenu par rapport à la partie supérieure 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 à ECMA-376 ST_TextAnchoringType "b". |
SuggestionTableCellStyle (Style de cellule de table suggérée)
Suggestion de modification d'un élément TableCellStyle
.
Représentation JSON |
---|
{ "tableCellStyle": { object ( |
Champs | |
---|---|
tableCellStyle |
Un élément |
tableCellStyleSuggestionState |
Masque qui indique quels champs de l'élément |
TableCellStyleSuggestionState
Masque qui indique quels champs de l'élément TableCellStyle
de base 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 |
Style de la ligne de table
Styles qui s'appliquent à une ligne du tableau
Représentation JSON |
---|
{
"minRowHeight": {
object ( |
Champs | |
---|---|
minRowHeight |
Hauteur minimale de la ligne. La hauteur de la ligne affichée dans l'éditeur Docs est supérieure ou égale à cette valeur afin d'afficher tout le contenu des cellules de la ligne. |
tableHeader |
Indique si la ligne est un en-tête de tableau. |
preventOverflow |
Indique si la ligne ne peut pas dépasser des limites de la page ou de la colonne. |
Style de la ligne de table suggérée
Suggestion de modification d'un élément TableRowStyle
.
Représentation JSON |
---|
{ "tableRowStyle": { object ( |
Champs | |
---|---|
tableRowStyle |
Un élément |
tableRowStyleSuggestionState |
Masque qui indique quels champs de l'élément |
TableRowStyleSuggestionState
Masque qui indique quels champs de l'élément TableRowStyle
de base 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 |
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 des lignes des cellules, comme au format HTML. Ainsi, les propriétés d'une ligne se trouvent dans l'élément |
TableColumnProperties
Propriétés d'une colonne d'un tableau.
Représentation JSON |
---|
{ "widthType": enum ( |
Champs | |
---|---|
widthType |
Type de largeur de la colonne. |
width |
Largeur de la colonne. Définissez ce paramètre lorsque la valeur de |
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épartie uniformément entre les autres colonnes distribuées uniformément. La largeur de la colonne est déterminée automatiquement et elle aura une proportion égale à la largeur restante du tableau après avoir pris en compte 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. |
Sommaire
Élément 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
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 |
Arrière-plan du document. L'arrière-plan des documents ne peut pas être transparent. |
defaultHeaderId |
ID de l'en-tête par défaut. Si ce champ n'est pas défini, 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, 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 valeur n'est pas définie, aucun en-tête unique n'existe 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, la première page ne dispose pas de pied de page unique. La valeur de Cette propriété est en lecture seule. |
useFirstPageHeaderFooter |
Indique si les ID d'en-tête / de pied de page de la première page doivent être utilisés pour la première page. |
useEvenPageHeaderFooter |
Indique s'il faut utiliser les ID d'en-tête / de pied de page des pages paires pour les pages paires. |
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 du document, cette dernière sera effacée de 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 du document, cette dernière sera effacée de tous les styles de section. |
marginRight |
Marge de droite de la page. Si vous modifiez la marge de droite de la page dans le style de document, la marge de droite est effacée de 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. Si vous modifiez la marge gauche de la page dans le style du document, elle est effacée de 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 |
Quantité d'espace entre le bas de la page et le contenu du pied de page. |
useCustomHeaderFooterMargins |
Indique si DocumentStyle Cette propriété est en lecture seule. |
flipPageOrientation |
Facultatif. Indique s'il faut inverser les dimensions de l'élément |
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. |
Style de document suggéré
Suggestion de modification de DocumentStyle
.
Représentation JSON |
---|
{ "documentStyle": { object ( |
Champs | |
---|---|
documentStyle |
Un élément |
documentStyleSuggestionState |
Masque qui indique quels champs de l'élément |
État de la suggestion de style de document
Masque qui indique quels champs de l'élément DocumentStyle
de base 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 qui indique quels 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 indiquant quels champs de [size] [google.apps.docs.v1.DocumentStyle.size] ont été modifiés 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 |
Arrière-planSuggestionState
Masque qui indique quels champs de l'élément Background
de base ont été modifiés dans cette suggestion. Pour tout champ défini sur "true", Backgound
propose 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 qui indique quels champs de l'élément Size
de base ont été modifiés dans cette suggestion. Pour tout champ défini sur "true", Size
propose une nouvelle valeur suggérée.
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 |
Styles nommés
Styles nommés. Les paragraphes d'un document peuvent hériter de leur TextStyle
et de leur ParagraphStyle
de ces styles nommés.
Représentation JSON |
---|
{
"styles": [
{
object ( |
Champs | |
---|---|
styles[] |
Styles nommés. Il existe une entrée pour chacun des |
Style nommé
Style nommé. Les paragraphes du document peuvent hériter de leur TextStyle
et de leur ParagraphStyle
de ce style nommé s'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é. |
StylesNoms suggérés
Suggestion de modification de NamedStyles
.
Représentation JSON |
---|
{ "namedStyles": { object ( |
Champs | |
---|---|
namedStyles |
Un élément |
namedStylesSuggestionState |
Masque qui indique quels champs de l'élément |
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 à celui du style nommé correspondant dans la suggestion |
NamedStyleSuggestionState (État de suggestion de style nommé)
É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 le |
textStyleSuggestionState |
Masque qui indique quels champs de |
paragraphStyleSuggestionState |
Masque qui indique quels champs de |
Liste
Une liste représente les attributs de liste d'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 bullet
.
Représentation JSON |
---|
{ "listProperties": { object ( |
Champs | |
---|---|
listProperties |
Propriétés de la liste. |
suggestedListPropertiesChanges |
Modifications suggérées pour les propriétés de la liste, associées à l'ID de suggestion. |
suggestedInsertionId |
ID d'insertion suggéré. Si ce champ est vide, il ne s'agit pas d'une insertion 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 de la liste)
Propriétés d'un élément 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 9 niveaux d'imbrication, 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 dans l'ordre croissant, le moins imbriqué étant renvoyé en premier. |
Niveau d'imbrication
Contient des propriétés décrivant l'apparence d'une puce de liste à un niveau d'imbrication donné.
Représentation JSON |
---|
{ "bulletAlignment": enum ( |
Champs | |
---|---|
bulletAlignment |
Alignement de la puce dans l'espace réservé à son rendu. |
glyphFormat |
Chaîne de format utilisée par les puces à ce niveau d'imbrication. Le format des glyphes 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 du 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 parent. Par exemple, une liste peut avoir le format de glyphe
Pour les niveaux imbriqué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 |
Quantité 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é au 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. Une valeur de 0 est traitée comme une valeur de 1 pour les listes de lettres et de chiffres romains. Pour les valeurs 0 et 1, les listes de chiffres romains et lettres commencent 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. Ce champ 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 à ce niveau d'imbrication sont ordonnés. Le type de glyphe détermine le type de glyphe utilisé pour remplacer les espaces réservés dans |
glyphSymbol |
Symbole glyphe personnalisé utilisé par les puces lorsque les paragraphes à ce niveau d'imbrication ne sont pas ordonnés. Le glyphe remplace les espaces réservés dans |
BulletAlignment
Types d'alignement d'une puce.
Enums | |
---|---|
BULLET_ALIGNMENT_UNSPECIFIED |
L'alignement de la puce n'est pas spécifié. |
START |
La puce est alignée par rapport au début de l'espace alloué pour son rendu. Aligné à gauche pour le texte de gauche à droite. Sinon, aligné à droite. |
CENTER |
La puce est alignée par rapport au centre de l'espace alloué pour son rendu. |
END |
La puce est alignée avec la fin de l'espace alloué pour son rendu. Aligné à droite pour le texte de gauche à droite. Sinon, aligné à gauche. |
Type de Glyph
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 dont les numéros à un chiffre sont précédés d'un zéro (par exemple, 01 , 02 ou 03 ). Les numéros de plus d'un chiffre ne commencent pas par 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, comme i , ii ou iii . |
SuggestionListProperties
Suggestion de modification pour ListProperties
.
Représentation JSON |
---|
{ "listProperties": { object ( |
Champs | |
---|---|
listProperties |
Un élément |
listPropertiesSuggestionState |
Masque qui indique quels champs de l'élément |
ListPropertiesSuggestionState
Masque qui indique quels champs de l'élément ListProperties
de base ont été modifiés dans cette suggestion. Une nouvelle valeur est suggérée pour chaque champ défini sur "true".
Représentation JSON |
---|
{
"nestingLevelsSuggestionStates": [
{
object ( |
Champs | |
---|---|
nestingLevelsSuggestionStates[] |
Masque qui indique quels champs du Les états de suggestion au niveau d'imbrication sont renvoyés dans l'ordre croissant du niveau d'imbrication, le niveau le moins imbriqué étant renvoyé en premier. |
Niveau de suggestion
Masque qui indique quels champs de l'élément NestingLevel
de base ont été modifiés dans cette suggestion. Une nouvelle valeur est suggérée pour chaque champ défini sur "true".
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 quels champs de |
startNumberSuggested |
Indique si une modification a été suggérée pour |
Plages nommées
Collection de tous les éléments NamedRange
du document qui partagent un nom donné.
Représentation JSON |
---|
{
"name": string,
"namedRanges": [
{
object ( |
Champs | |
---|---|
name |
Nom partagé par tous les |
namedRanges[] |
Les |
PlageNommée
Collection de Range
ayant le même ID de plage nommé.
Les plages nommées permettent aux développeurs d'associer des parties d'un document à un libellé arbitraire défini par l'utilisateur afin que leur contenu puisse être lu ou modifié ultérieurement par programmation. 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 Range
, et le contenu inséré dans une plage nommée élargit généralement cette plage. Cependant, 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 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 } |
Champs | |
---|---|
segmentId |
ID de l'en-tête, du pied de page ou de la note de bas de page dans lequel cette plage est contenue. Un ID de segment vide correspond au corps du document. |
startIndex |
Indice de départ de base zéro de cette plage, en unités de code UTF-16. Pour toutes les utilisations actuelles, vous devez indiquer un index de départ. Ce champ est une valeur Int32Value permettant de prendre en charge les futurs cas d'utilisation avec des plages ouvertes. |
endIndex |
Index de fin de base zéro de cette plage, exclusif, en unités de code UTF-16. Pour toutes les utilisations actuelles, vous devez indiquer un index de fin. Ce champ est une valeur Int32Value permettant de prendre en charge les futurs cas d'utilisation avec des plages ouvertes. |
Mode d'affichage des suggestions
Mode d'affichage des suggestions appliqué au document, qui indique comment les modifications suggérées sont représentées. Elle fournit des options permettant 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 de suggestions appliqué au document affiché 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 d'affichage des suggestions par défaut. |
SUGGESTIONS_INLINE |
Le document renvoyé contient des suggestions intégrées. Les modifications proposées seront différenciées du contenu de base du 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 modifications suggérées. |
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 modifications suggérées. |
PREVIEW_WITHOUT_SUGGESTIONS |
Le document renvoyé est un aperçu avec toutes les modifications suggérées refusées si le document en contient. |
Objet intégré
Objet qui s'affiche au même niveau du texte. Un InlineObject contient un 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 pour les propriétés de l'objet intégré, associées à l'ID de suggestion. |
suggestedInsertionId |
ID d'insertion suggéré. Si ce champ est vide, il ne s'agit pas d'une insertion 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 élément InlineObject
.
Représentation JSON |
---|
{
"embeddedObject": {
object ( |
Champs | |
---|---|
embeddedObject |
Objet intégré de cet objet intégré. |
Objet intégré
Objet intégré au document.
Représentation JSON |
---|
{ "title": string, "description": string, "embeddedObjectBorder": { object ( |
Champs | |
---|---|
title |
Titre de l'objet intégré. Les éléments |
description |
Description de l'objet intégré. Les éléments |
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 de la source externe associée. Par exemple, il contient une référence au graphique source Google Sheets lorsque l'objet intégré est un graphique lié. Si cette valeur n'est pas définie, l'objet intégré n'est pas lié. |
Champ d'union properties . Propriétés propres à 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 incorporé et utilisées pour différencier le type d'objet. Un dessin intégré est un dessin créé et modifié dans un document. Notez que de nombreux détails ne sont pas pris en charge.
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. Cette URI est associée au compte du demandeur. Toute personne disposant de l'URI accède à l'image en tant que demandeur d'origine. L'accès à l'image risque d'ê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 se situer 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 se situer dans l'intervalle [-1,0, 1,0], où 0 signifie qu'il n'y a aucun effet. |
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. |
Propriétés de recadrage
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 est positionné en dehors du rectangle de délimitation d'origine de l'image.
- Si tous les décalages et tous les angles 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 spécifie la distance entre le bord gauche du rectangle de recadrage et le bord gauche du contenu d'origine, sous la forme d'une fraction de la largeur du contenu d'origine. |
offsetRight |
Le décalage spécifie 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 spécifie 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 spécifie la distance entre le bord inférieur du rectangle de recadrage et le bord inférieur du contenu d'origine, sous la forme d'une 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
Une bordure autour d'un élément 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é border. |
PropertyState
Les différents é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. |
RéférenceContenuLinkedIn
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 lié. reference ne peut être qu'un des éléments suivants : |
|
sheetsChartReference |
Référence au graphique lié. |
SheetsChartReference
Référence à un graphique lié 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 figurant dans la feuille de calcul Google Sheets intégrée. |
SuggestionInlineObjectProperties
Suggestion de modification pour InlineObjectProperties
.
Représentation JSON |
---|
{ "inlineObjectProperties": { object ( |
Champs | |
---|---|
inlineObjectProperties |
|
inlineObjectPropertiesSuggestionState |
Masque qui indique quels champs de l'élément |
InlineObjectPropertiesSuggestionState
Masque qui indique quels champs de l'élément InlineObjectProperties
de base 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 quels champs de |
EmbeddedObjectSuggestionState
Masque qui indique quels champs de l'élément EmbeddedObject
de base 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 qui indique quels champs de |
imagePropertiesSuggestionState |
Masque qui indique quels 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 qui indique quels champs de |
sizeSuggestionState |
Masque qui indique quels 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 quels champs de |
EmbeddedDrawingPropertiesSuggestionState
Ce type ne comporte aucun champ.
Masque qui indique quels champs de l'élément EmbeddedDrawingProperties
de base 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 l'élément ImageProperties
de base 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 dans [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri]. |
brightnessSuggested |
Indique si une modification a été suggérée pour [luminosité] [google.apps.docs.v1.EmbeddedObject.brightness]. |
contrastSuggested |
Indique si une modification a été suggérée dans [contrast] [google.apps.docs.v1.EmbeddedObject.contrast]. |
transparencySuggested |
Indique si une modification a été suggérée pour [transparency] [google.apps.docs.v1.EmbeddedObject.transparency]. |
cropPropertiesSuggestionState |
Masque qui indique quels champs de |
angleSuggested |
Indique si une modification a été suggérée pour [angle] [google.apps.docs.v1.EmbeddedObject.angle]. |
RecadragePropertiesSuggestionState
Masque qui indique quels champs de l'élément CropProperties
de base 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 l'élément EmbeddedObjectBorder
de base 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 dans [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 dans [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 qui indique quels champs de l'élément LinkedContentReference
de base ont été modifiés dans cette suggestion. Une nouvelle valeur est suggérée pour chaque champ défini sur "true".
Représentation JSON |
---|
{
"sheetsChartReferenceSuggestionState": {
object ( |
Champs | |
---|---|
sheetsChartReferenceSuggestionState |
Masque qui indique quels champs de |
SheetsChartReferenceSuggestionState
Masque qui indique quels champs de l'élément SheetsChartReference
de base 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 |
Objet Positionné
Objet relié à un élément Paragraph
et positionné par rapport au début du paragraphe. Un PositionedObject contient un 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 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, il ne s'agit pas d'une insertion 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 élément PositionedObject
.
Représentation JSON |
---|
{ "positioning": { object ( |
Champs | |
---|---|
positioning |
Positionnement de cet objet positionné par rapport à la nouvelle ligne de la |
embeddedObject |
Objet intégré de cet objet positionné. |
PositionedObjectPositioning
Positionnement d'un élément PositionedObject
. L'objet positionné est positionné par rapport au début de la Paragraph
avec laquelle 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'affiche autour de l'objet positionné. |
BREAK_LEFT |
Coupe 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é se trouve à 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. |
SuggestionPositionedObjectProperties
Suggestion de modification pour PositionedObjectProperties
.
Représentation JSON |
---|
{ "positionedObjectProperties": { object ( |
Champs | |
---|---|
positionedObjectProperties |
Un élément |
positionedObjectPropertiesSuggestionState |
Masque qui indique quels champs de l'élément |
PositionedObjectPropertiesSuggestionState
Masque qui indique quels champs de l'élément PositionedObjectProperties
de base ont été modifiés dans cette suggestion. Une nouvelle valeur est suggérée pour chaque champ défini sur "true".
Représentation JSON |
---|
{ "positioningSuggestionState": { object ( |
Champs | |
---|---|
positioningSuggestionState |
Masque qui indique quels champs de |
embeddedObjectSuggestionState |
Masque qui indique quels champs de |
PositionedObjectPositioningSuggestionState
Masque qui indique quels champs de l'élément PositionedObjectPositioning
de base ont été modifiés dans cette suggestion. Une nouvelle valeur est suggérée pour chaque champ défini sur "true".
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 |
Méthodes |
|
---|---|
|
Applique une ou plusieurs mises à jour au document. |
|
Crée un document vierge en utilisant le titre fourni dans la requête. |
|
Récupère la dernière version du document spécifié. |