REST Resource: documents

Ressource : Document

Un document Google Docs.

Représentation JSON
{
  "documentId": string,
  "title": string,
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
Champs
documentId

string

Uniquement en sortie. Identifiant du document.

title

string

Titre du document.

body

object (Body)

Uniquement en sortie. Corps principal du document.

headers

map (key: string, value: object (Header))

Uniquement en sortie. En-têtes du document, associés par ID d'en-tête.

footers

map (key: string, value: object (Footer))

Uniquement en sortie. Pieds de page du document, associés à l'ID de pied de page.

footnotes

map (key: string, value: object (Footnote))

Uniquement en sortie. Notes de bas de page du document, associées à l'ID de la note de bas de page.

documentStyle

object (DocumentStyle)

Uniquement en sortie. Style du document.

suggestedDocumentStyleChanges

map (key: string, value: object (SuggestedDocumentStyle))

Uniquement en sortie. Suggestions de modifications du style du document, associées à l'ID de suggestion.

namedStyles

object (NamedStyles)

Uniquement en sortie. Styles nommés du document.

suggestedNamedStylesChanges

map (key: string, value: object (SuggestedNamedStyles))

Uniquement en sortie. Modifications suggérées pour les styles nommés du document, associées à l'ID de suggestion.

lists

map (key: string, value: object (List))

Uniquement en sortie. Listes du document, associées à l'ID de liste.

namedRanges

map (key: string, value: object (NamedRanges))

Uniquement en sortie. Plages nommées dans le document, associées par nom.

revisionId

string

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

enum (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 SUGGESTIONS_INLINE.

inlineObjects

map (key: string, value: object (InlineObject))

Uniquement en sortie. Objets intégrés dans le document, associés à l'ID d'objet.

positionedObjects

map (key: string, value: object (PositionedObject))

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 (StructuralElement)
    }
  ]
}
Champs
content[]

object (StructuralElement)

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 content can be only one of the following:
  "paragraph": {
    object (Paragraph)
  },
  "sectionBreak": {
    object (SectionBreak)
  },
  "table": {
    object (Table)
  },
  "tableOfContents": {
    object (TableOfContents)
  }
  // End of list of possible types for union field content.
}
Champs
startIndex

integer

Indice de départ de base zéro de cet élément structurel, en unités de code UTF-16.

endIndex

integer

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

object (Paragraph)

Élément structurel de type paragraphe.

sectionBreak

object (SectionBreak)

Type de saut de section d'élément structurel.

table

object (Table)

Type d'élément de structure de tableau.

tableOfContents

object (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 (ParagraphElement)
    }
  ],
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "suggestedParagraphStyleChanges": {
    string: {
      object (SuggestedParagraphStyle)
    },
    ...
  },
  "bullet": {
    object (Bullet)
  },
  "suggestedBulletChanges": {
    string: {
      object (SuggestedBullet)
    },
    ...
  },
  "positionedObjectIds": [
    string
  ],
  "suggestedPositionedObjectIds": {
    string: {
      object (ObjectReferences)
    },
    ...
  }
}
Champs
elements[]

object (ParagraphElement)

Contenu du paragraphe décomposé en différentes parties.

paragraphStyle

object (ParagraphStyle)

Style de ce paragraphe.

suggestedParagraphStyleChanges

map (key: string, value: object (SuggestedParagraphStyle))

Le style de paragraphe suggéré change pour ce paragraphe, associé à l'ID de suggestion.

bullet

object (Bullet)

Puce pour ce paragraphe. S'il est absent, le paragraphe n'appartient pas à une liste.

suggestedBulletChanges

map (key: string, value: object (SuggestedBullet))

Les modifications suggérées pour la puce de ce paragraphe.

positionedObjectIds[]

string

Les identifiants des objets positionnés reliés à ce paragraphe.

suggestedPositionedObjectIds

map (key: string, value: object (ObjectReferences))

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 content can be only one of the following:
  "textRun": {
    object (TextRun)
  },
  "autoText": {
    object (AutoText)
  },
  "pageBreak": {
    object (PageBreak)
  },
  "columnBreak": {
    object (ColumnBreak)
  },
  "footnoteReference": {
    object (FootnoteReference)
  },
  "horizontalRule": {
    object (HorizontalRule)
  },
  "equation": {
    object (Equation)
  },
  "inlineObjectElement": {
    object (InlineObjectElement)
  },
  "person": {
    object (Person)
  },
  "richLink": {
    object (RichLink)
  }
  // End of list of possible types for union field content.
}
Champs
startIndex

integer

Index de début de base zéro de cet élément de paragraphe, en unités de code UTF-16.

endIndex

integer

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

object (TextRun)

Élément de paragraphe d'exécution de texte.

autoText

object (AutoText)

Élément de paragraphe de texte automatique.

pageBreak

object (PageBreak)

Élément de paragraphe de saut de page.

columnBreak

object (ColumnBreak)

Élément de paragraphe de saut de colonne.

footnoteReference

object (FootnoteReference)

Élément de paragraphe faisant référence à une note de bas de page.

horizontalRule

object (HorizontalRule)

Élément de paragraphe de règle horizontale.

equation

object (Equation)

Élément de paragraphe d'équation.

inlineObjectElement

object (InlineObjectElement)

Élément de paragraphe d'objet intégré.

person

object (Person)

Élément de paragraphe qui renvoie à une personne ou à une adresse e-mail.

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 (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Champs
content

string

Texte de cette exécution.

Tous les éléments non textuels sont remplacés par le caractère Unicode U+E907.

suggestedInsertionIds[]

string

ID d'insertion suggérés. Un élément TextRun peut avoir plusieurs ID d'insertion s'il s'agit d'une modification suggérée imbriquée. Si ce champ est vide, il ne s'agit pas d'une insertion suggérée.

suggestedDeletionIds[]

string

ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée.

textStyle

object (TextStyle)

Style de texte de cette exécution.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

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 du named 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 (OptionalColor)
  },
  "foregroundColor": {
    object (OptionalColor)
  },
  "fontSize": {
    object (Dimension)
  },
  "weightedFontFamily": {
    object (WeightedFontFamily)
  },
  "baselineOffset": enum (BaselineOffset),
  "link": {
    object (Link)
  }
}
Champs
bold

boolean

Indique si le texte est affiché en gras.

italic

boolean

Indique si le texte est en italique.

underline

boolean

Indique si le texte est souligné ou non.

strikethrough

boolean

Indique si le texte est rayé.

smallCaps

boolean

Indique si le texte est en minuscules.

backgroundColor

object (OptionalColor)

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

foregroundColor

object (OptionalColor)

Couleur de premier plan du texte. Si cette option est définie, la couleur peut être une couleur RVB ou transparente, selon le champ color.

fontSize

object (Dimension)

Taille de la police du texte.

weightedFontFamily

object (WeightedFontFamily)

Famille de polices et épaisseur de rendu du texte.

Si une requête de mise à jour spécifie des valeurs à la fois pour weightedFontFamily et bold, weightedFontFamily est appliqué en premier, puis bold.

Si weightedFontFamily#weight n'est pas défini, la valeur par défaut est 400.

Si weightedFontFamily est défini, alors weightedFontFamily#fontFamily doit également être défini avec une valeur non vide. Sinon, une erreur 400 de requête incorrecte est renvoyée.

baselineOffset

enum (BaselineOffset)

Décalage vertical du texte par rapport à sa position normale

Le texte avec des décalages de référence de SUPERSCRIPT ou SUBSCRIPT est automatiquement affiché dans une taille de police plus petite, calculée en fonction du champ fontSize. Les modifications apportées à ce champ n'affectent pas le fontSize.

Couleur facultative

Couleur qui peut être totalement opaque ou totalement transparente.

Représentation JSON
{
  "color": {
    object (Color)
  }
}
Champs
color

object (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 (RgbColor)
  }
}
Champs
rgbColor

object (RgbColor)

Valeur de couleur RVB.

Couleur rvb

Couleur RVB.

Représentation JSON
{
  "red": number,
  "green": number,
  "blue": number
}
Champs
red

number

Composant rouge de la couleur, compris entre 0.0 et 1.0.

green

number

Composant vert de la couleur, compris entre 0.0 et 1.0.

blue

number

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 (Unit)
}
Champs
magnitude

number

L’ampleur.

unit

enum (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

string

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

weight

integer

Épaisseur de la police. La valeur de ce champ peut être un multiple de 100 comprise entre 100 et 900 inclus. Cette plage correspond aux valeurs numériques décrites dans la section 15.6 de la spécification CSS 2.1. Les valeurs non numériques sont interdites.

La valeur par défaut est 400 ("normal").

L'épaisseur de la police ne constitue qu'un composant de l'épaisseur de la police affichée. Une combinaison de weight et de la valeur bold résolue du style de texte détermine l'épaisseur de rendu, après avoir pris en compte l'héritage:

  • Si le texte est en gras et que l'épaisseur est inférieure à 400, l'épaisseur de rendu est de 400.
  • Si le texte est en gras et que l'épaisseur est supérieure ou égale à 400, mais inférieure à 700, l'épaisseur affichée est 700.
  • Si l'épaisseur est supérieure ou égale à 700, l'épaisseur affichée est égale à la pondération.
  • Si le texte n'est pas en gras, l'épaisseur de rendu est égale à l'épaisseur.

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

Style de texte suggéré

Suggestion de modification d'un élément TextStyle.

Représentation JSON
{
  "textStyle": {
    object (TextStyle)
  },
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
Champs
textStyle

object (TextStyle)

Un élément TextStyle qui n'inclut que les modifications apportées à cette suggestion. Vous pouvez l'utiliser avec le textStyleSuggestionState pour voir quels champs ont été modifiés et leurs nouvelles valeurs.

textStyleSuggestionState

object (TextStyleSuggestionState)

Masque qui indique quels champs de l'élément TextStyle de base ont été modifiés dans cette suggestion.

É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

boolean

Indique si une modification a été suggérée pour bold.

italicSuggested

boolean

Indique si une modification a été suggérée pour italic.

underlineSuggested

boolean

Indique si une modification a été suggérée pour underline.

strikethroughSuggested

boolean

Indique si une modification a été suggérée pour strikethrough.

smallCapsSuggested

boolean

Indique si une modification a été suggérée pour smallCaps.

backgroundColorSuggested

boolean

Indique si une modification a été suggérée pour backgroundColor.

foregroundColorSuggested

boolean

Indique si une modification a été suggérée pour foregroundColor.

fontSizeSuggested

boolean

Indique si une modification a été suggérée pour fontSize.

weightedFontFamilySuggested

boolean

Indique si une modification a été suggérée pour weightedFontFamily.

baselineOffsetSuggested

boolean

Indique si une modification a été suggérée pour baselineOffset.

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 (Type),
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Champs
type

enum (Type)

Type de ce texte automatique.

suggestedInsertionIds[]

string

ID d'insertion suggérés. Un élément AutoText peut avoir plusieurs ID d'insertion s'il s'agit d'une modification suggérée imbriquée. Si ce champ est vide, il ne s'agit pas d'une insertion suggérée.

suggestedDeletionIds[]

string

ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée.

textStyle

object (TextStyle)

Style de texte de ce texte automatique.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

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 (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Champs
suggestedInsertionIds[]

string

ID d'insertion suggérés. Un élément PageBreak peut avoir plusieurs ID d'insertion s'il s'agit d'une modification suggérée imbriquée. Si ce champ est vide, il ne s'agit pas d'une insertion suggérée.

suggestedDeletionIds[]

string

ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée.

textStyle

object (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

map (key: string, value: object (SuggestedTextStyle))

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 (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Champs
suggestedInsertionIds[]

string

ID d'insertion suggérés. Un élément ColumnBreak peut avoir plusieurs ID d'insertion s'il s'agit d'une modification suggérée imbriquée. Si ce champ est vide, il ne s'agit pas d'une insertion suggérée.

suggestedDeletionIds[]

string

ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée.

textStyle

object (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

map (key: string, value: object (SuggestedTextStyle))

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 (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Champs
footnoteId

string

ID de la footnote incluant le contenu de cette référence à une note de bas de page.

footnoteNumber

string

Numéro de rendu de cette note de bas de page.

suggestedInsertionIds[]

string

ID d'insertion suggérés. Un élément FootnoteReference peut avoir plusieurs ID d'insertion s'il s'agit d'une modification suggérée imbriquée. Si ce champ est vide, il ne s'agit pas d'une insertion suggérée.

suggestedDeletionIds[]

string

ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée.

textStyle

object (TextStyle)

Style de texte de cette référence de note de bas de page.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

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 (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Champs
suggestedInsertionIds[]

string

ID d'insertion suggérés. Un élément HorizontalRule peut avoir plusieurs ID d'insertion s'il s'agit d'une modification suggérée imbriquée. Si ce champ est vide, il ne s'agit pas d'une insertion suggérée.

suggestedDeletionIds[]

string

ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée.

textStyle

object (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

map (key: string, value: object (SuggestedTextStyle))

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[]

string

ID d'insertion suggérés. Un élément Equation peut avoir plusieurs ID d'insertion s'il s'agit d'une modification suggérée imbriquée. Si ce champ est vide, il ne s'agit pas d'une insertion suggérée.

suggestedDeletionIds[]

string

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 (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Champs
inlineObjectId

string

ID du InlineObject que contient cet élément.

suggestedInsertionIds[]

string

ID d'insertion suggérés. Un élément InlineObjectElement peut avoir plusieurs ID d'insertion s'il s'agit d'une modification suggérée imbriquée. Si ce champ est vide, il ne s'agit pas d'une insertion suggérée.

suggestedDeletionIds[]

string

ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée.

textStyle

object (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

map (key: string, value: object (SuggestedTextStyle))

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 (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  },
  "personProperties": {
    object (PersonProperties)
  }
}
Champs
personId

string

Uniquement en sortie. Identifiant unique de cette association.

suggestedInsertionIds[]

string

Identifiants des suggestions qui insèrent le lien de cette personne dans le document. Un élément Person peut avoir plusieurs ID d'insertion s'il s'agit d'une modification suggérée imbriquée (une suggestion contenue dans une suggestion faite par un autre utilisateur, par exemple). Si ce champ est vide, ce lien ne correspond pas à une suggestion d'insertion.

suggestedDeletionIds[]

string

Identifiants des suggestions qui suppriment le lien de cette personne du document. Une Person peut avoir plusieurs ID de suppression si, par exemple, plusieurs utilisateurs suggèrent de la supprimer. Si ce champ est vide, le lien associé à cette personne n'est pas suggéré.

textStyle

object (TextStyle)

Style de texte de cet élément Person.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Le style de texte suggéré est remplacé par ce Person, associé à l'ID de suggestion.

personProperties

object (PersonProperties)

Uniquement en sortie. Propriétés de ce Person. Ce champ est toujours présent.

Propriétéspersonnes

Propriétés spécifiques à un Person associé.

Représentation JSON
{
  "name": string,
  "email": string
}
Champs
name

string

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

string

Uniquement en sortie. Adresse e-mail associée à ce Person. Ce champ est toujours présent.

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

string

Uniquement en sortie. Titre du RichLink tel qu'il est affiché dans le lien. Ce titre correspond à celui de la ressource associée au moment de l'insertion ou de la dernière mise à jour du lien. Ce champ est toujours présent.

uri

string

Uniquement en sortie. L'URI de RichLink. Cette valeur est toujours présente.

mimeType

string

Uniquement en sortie. Type MIME du fichier RichLink, le cas échéant (par exemple, s'il s'agit d'un fichier dans Drive).

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 du named 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 (NamedStyleType),
  "alignment": enum (Alignment),
  "lineSpacing": number,
  "direction": enum (ContentDirection),
  "spacingMode": enum (SpacingMode),
  "spaceAbove": {
    object (Dimension)
  },
  "spaceBelow": {
    object (Dimension)
  },
  "borderBetween": {
    object (ParagraphBorder)
  },
  "borderTop": {
    object (ParagraphBorder)
  },
  "borderBottom": {
    object (ParagraphBorder)
  },
  "borderLeft": {
    object (ParagraphBorder)
  },
  "borderRight": {
    object (ParagraphBorder)
  },
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "indentEnd": {
    object (Dimension)
  },
  "tabStops": [
    {
      object (TabStop)
    }
  ],
  "keepLinesTogether": boolean,
  "keepWithNext": boolean,
  "avoidWidowAndOrphan": boolean,
  "shading": {
    object (Shading)
  },
  "pageBreakBefore": boolean
}
Champs
headingId

string

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

enum (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

enum (Alignment)

Alignement du texte pour ce paragraphe.

lineSpacing

number

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

enum (ContentDirection)

Sens du texte de ce paragraphe. Si cette valeur n'est pas définie, la valeur par défaut est LEFT_TO_RIGHT, car le sens du paragraphe n'est pas hérité.

spacingMode

enum (SpacingMode)

Mode d'espacement du paragraphe.

spaceAbove

object (Dimension)

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

object (Dimension)

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

object (ParagraphBorder)

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

object (ParagraphBorder)

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

object (ParagraphBorder)

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

object (ParagraphBorder)

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

object (ParagraphBorder)

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

object (Dimension)

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

object (Dimension)

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

object (Dimension)

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[]

object (TabStop)

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

boolean

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

boolean

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

boolean

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

object (Shading)

Ombre du paragraphe. Si cette valeur n'est pas définie, la valeur est héritée du parent.

pageBreakBefore

boolean

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 pageBreakBefore pour des paragraphes dans des régions non compatibles, y compris Table, Header, Footer et Footnote, peut entraîner un état du document non valide qui renvoie une erreur 400 de requête incorrecte.

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 (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "padding": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
Champs
color

object (OptionalColor)

Couleur de la bordure.

width

object (Dimension)

Largeur de la bordure.

padding

object (Dimension)

Marge intérieure de la bordure.

dashStyle

enum (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 (Dimension)
  },
  "alignment": enum (TabStopAlignment)
}
Champs
offset

object (Dimension)

Décalage entre ce taquet de tabulation et la marge de début.

alignment

enum (TabStopAlignment)

Alignement de ce taquet de tabulation. Si cette valeur n'est pas configurée, la valeur par défaut est START.

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 (OptionalColor)
  }
}
Champs
backgroundColor

object (OptionalColor)

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 (ParagraphStyle)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
Champs
paragraphStyle

object (ParagraphStyle)

Un élément ParagraphStyle qui n'inclut que les modifications apportées à cette suggestion. Vous pouvez l'utiliser avec le paragraphStyleSuggestionState pour voir quels champs ont été modifiés et leurs nouvelles valeurs.

paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

Masque qui indique quels champs de l'élément ParagraphStyle de base ont été modifiés dans cette suggestion.

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 (ShadingSuggestionState)
  },
  "pageBreakBeforeSuggested": boolean
}
Champs
headingIdSuggested

boolean

Indique si une modification a été suggérée pour headingId.

namedStyleTypeSuggested

boolean

Indique si une modification a été suggérée pour namedStyleType.

alignmentSuggested

boolean

Indique si une modification a été suggérée pour alignment.

lineSpacingSuggested

boolean

Indique si une modification a été suggérée pour lineSpacing.

directionSuggested

boolean

Indique si une modification a été suggérée pour direction.

spacingModeSuggested

boolean

Indique si une modification a été suggérée pour spacingMode.

spaceAboveSuggested

boolean

Indique si une modification a été suggérée pour spaceAbove.

spaceBelowSuggested

boolean

Indique si une modification a été suggérée pour spaceBelow.

borderBetweenSuggested

boolean

Indique si une modification a été suggérée pour borderBetween.

borderTopSuggested

boolean

Indique si une modification a été suggérée pour borderTop.

borderBottomSuggested

boolean

Indique si une modification a été suggérée pour borderBottom.

borderLeftSuggested

boolean

Indique si une modification a été suggérée pour borderLeft.

borderRightSuggested

boolean

Indique si une modification a été suggérée pour borderRight.

indentFirstLineSuggested

boolean

Indique si une modification a été suggérée pour indentFirstLine.

indentStartSuggested

boolean

Indique si une modification a été suggérée pour indentStart.

indentEndSuggested

boolean

Indique si une modification a été suggérée pour indentEnd.

keepLinesTogetherSuggested

boolean

Indique si une modification a été suggérée pour keepLinesTogether.

keepWithNextSuggested

boolean

Indique si une modification a été suggérée pour keepWithNext.

avoidWidowAndOrphanSuggested

boolean

Indique si une modification a été suggérée pour avoidWidowAndOrphan.

shadingSuggestionState

object (ShadingSuggestionState)

Masque qui indique quels champs de shading ont été modifiés dans cette suggestion.

pageBreakBeforeSuggested

boolean

Indique si une modification a été suggérée pour pageBreakBefore.

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

boolean

Indique si une suggestion de modification a été apportée à Shading.

Puces

Décrit la puce d'un paragraphe.

Représentation JSON
{
  "listId": string,
  "nestingLevel": integer,
  "textStyle": {
    object (TextStyle)
  }
}
Champs
listId

string

ID de la liste à laquelle appartient ce paragraphe.

nestingLevel

integer

Niveau d'imbrication de ce paragraphe dans la liste.

textStyle

object (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 (Bullet)
  },
  "bulletSuggestionState": {
    object (BulletSuggestionState)
  }
}
Champs
bullet

object (Bullet)

Un élément Bullet qui n'inclut que les modifications apportées à cette suggestion. Vous pouvez l'utiliser avec le bulletSuggestionState pour voir quels champs ont été modifiés et leurs nouvelles valeurs.

bulletSuggestionState

object (BulletSuggestionState)

Masque qui indique quels champs de l'élément Bullet de base ont été modifiés dans cette suggestion.

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 (TextStyleSuggestionState)
  }
}
Champs
listIdSuggested

boolean

Indique si une suggestion de modification a été apportée à listId.

nestingLevelSuggested

boolean

Indique si une suggestion de modification a été apportée à nestingLevel.

textStyleSuggestionState

object (TextStyleSuggestionState)

Masque qui indique quels champs de text style ont été modifiés dans cette suggestion.

Références d'objets

Collection d'ID d'objets.

Représentation JSON
{
  "objectIds": [
    string
  ]
}
Champs
objectIds[]

string

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 (SectionStyle)
  }
}
Champs
suggestedInsertionIds[]

string

ID d'insertion suggérés. Un élément SectionBreak peut avoir plusieurs ID d'insertion s'il s'agit d'une modification suggérée imbriquée. Si ce champ est vide, il ne s'agit pas d'une insertion suggérée.

suggestedDeletionIds[]

string

ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée.

sectionStyle

object (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 (SectionColumnProperties)
    }
  ],
  "columnSeparatorStyle": enum (ColumnSeparatorStyle),
  "contentDirection": enum (ContentDirection),
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "sectionType": enum (SectionType),
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "pageNumberStart": integer,
  "flipPageOrientation": boolean
}
Champs
columnProperties[]

object (SectionColumnProperties)

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

enum (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

enum (ContentDirection)

Sens du contenu de cette section. Si cette valeur n'est pas configurée, la valeur par défaut est LEFT_TO_RIGHT.

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

object (Dimension)

Marge supérieure de la section. Si cette valeur n'est pas définie, la valeur par défaut est marginTop pour DocumentStyle.

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

object (Dimension)

Marge inférieure de la section. Si cette valeur n'est pas définie, la valeur par défaut est marginBottom pour DocumentStyle.

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

object (Dimension)

Marge de droite de la section. Si cette valeur n'est pas définie, la valeur par défaut est marginRight pour DocumentStyle. Si vous modifiez la marge de droite, les colonnes de cette section sont redimensionnées. Étant donné que la marge affecte la largeur des colonnes, elle est appliquée avant les propriétés de la 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.

marginLeft

object (Dimension)

Marge gauche de la section. Si cette valeur n'est pas définie, la valeur par défaut est marginLeft pour DocumentStyle. Si vous modifiez la marge de gauche, les colonnes de cette section sont redimensionnées. Étant donné que la marge affecte la largeur des colonnes, elle est appliquée avant les propriétés de la 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.

marginHeader

object (Dimension)

Marge de l'en-tête de la section. Si cette valeur n'est pas définie, la valeur par défaut est marginHeader pour DocumentStyle. En cas de mise à jour, useCustomHeaderFooterMargins est défini sur "true" dans DocumentStyle. La valeur useCustomHeaderfooterMargins dans DocumentStyle indique si une marge d'en-tête est respectée pour cette section.

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

enum (SectionType)

Uniquement en sortie. Type de section.

defaultHeaderId

string

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 SectionBreak's. Si la valeur n'est pas définie dans le premier saut de section, elle hérite du defaultHeaderId de DocumentStyle.

Cette propriété est en lecture seule.

firstPageHeaderId

string

ID de l'en-tête utilisé uniquement pour la première page de la section. Si useFirstPageHeaderFooter est "true", cette valeur est utilisée pour l'en-tête de la première page de la section. Si la valeur est "false", l'en-tête de la première page de la section utilise defaultHeaderId. Si cette valeur n'est pas définie, la valeur hérite du style de section précédent SectionBreak's. Si la valeur n'est pas définie dans le premier saut de section, elle hérite du firstPageHeaderId de DocumentStyle.

Cette propriété est en lecture seule.

evenPageHeaderId

string

ID de l'en-tête utilisé uniquement pour les pages paires. Si la valeur de l'attribut useEvenPageHeaderFooter de DocumentStyle est "true", cette valeur est utilisée pour les en-têtes des pages paires de la section. Si la valeur est "false", les en-têtes des pages paires utilisent defaultHeaderId. Si cette valeur n'est pas définie, la valeur hérite du style de section précédent SectionBreak's. Si la valeur n'est pas définie dans le premier saut de section, elle hérite du evenPageHeaderId de DocumentStyle.

Cette propriété est en lecture seule.

pageNumberStart

integer

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 SectionBreak, reportez-vous au pageNumberStart de DocumentStyle.

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

boolean

Facultatif. Indique s'il faut inverser les dimensions de l'attribut pageSize de DocumentStyle pour cette section, ce qui permet de modifier l'orientation de la page en mode portrait ou paysage. Si cette valeur n'est pas définie, la valeur hérite du flipPageOrientation de DocumentStyle.

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 (Dimension)
  },
  "paddingEnd": {
    object (Dimension)
  }
}
Champs
width

object (Dimension)

Uniquement en sortie. Largeur de la colonne.

paddingEnd

object (Dimension)

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 (TableRow)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableStyle": {
    object (TableStyle)
  }
}
Champs
rows

integer

Nombre de lignes dans la table.

columns

integer

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[]

object (TableRow)

Contenu et style de chaque ligne

suggestedInsertionIds[]

string

ID d'insertion suggérés. Un élément Table peut avoir plusieurs ID d'insertion s'il s'agit d'une modification suggérée imbriquée. Si ce champ est vide, il ne s'agit pas d'une insertion suggérée.

suggestedDeletionIds[]

string

ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée.

tableStyle

object (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 (TableCell)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "suggestedTableRowStyleChanges": {
    string: {
      object (SuggestedTableRowStyle)
    },
    ...
  }
}
Champs
startIndex

integer

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

endIndex

integer

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

tableCells[]

object (TableCell)

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[]

string

ID d'insertion suggérés. Un élément TableRow peut avoir plusieurs ID d'insertion s'il s'agit d'une modification suggérée imbriquée. Si ce champ est vide, il ne s'agit pas d'une insertion suggérée.

suggestedDeletionIds[]

string

ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée.

tableRowStyle

object (TableRowStyle)

Style de la ligne du tableau.

suggestedTableRowStyleChanges

map (key: string, value: object (SuggestedTableRowStyle))

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 (StructuralElement)
    }
  ],
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "suggestedTableCellStyleChanges": {
    string: {
      object (SuggestedTableCellStyle)
    },
    ...
  }
}
Champs
startIndex

integer

Index de départ de base zéro de cette cellule, en unités de code UTF-16.

endIndex

integer

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

content[]

object (StructuralElement)

Contenu de la cellule.

tableCellStyle

object (TableCellStyle)

Style de la cellule.

suggestedInsertionIds[]

string

ID d'insertion suggérés. Un élément TableCell peut avoir plusieurs ID d'insertion s'il s'agit d'une modification suggérée imbriquée. Si ce champ est vide, il ne s'agit pas d'une insertion suggérée.

suggestedDeletionIds[]

string

ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée.

suggestedTableCellStyleChanges

map (key: string, value: object (SuggestedTableCellStyle))

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 (OptionalColor)
  },
  "borderLeft": {
    object (TableCellBorder)
  },
  "borderRight": {
    object (TableCellBorder)
  },
  "borderTop": {
    object (TableCellBorder)
  },
  "borderBottom": {
    object (TableCellBorder)
  },
  "paddingLeft": {
    object (Dimension)
  },
  "paddingRight": {
    object (Dimension)
  },
  "paddingTop": {
    object (Dimension)
  },
  "paddingBottom": {
    object (Dimension)
  },
  "contentAlignment": enum (ContentAlignment)
}
Champs
rowSpan

integer

Étendue de lignes de la cellule.

Cette propriété est en lecture seule.

columnSpan

integer

Étendue de la colonne de la cellule.

Cette propriété est en lecture seule.

backgroundColor

object (OptionalColor)

Couleur d'arrière-plan de la cellule.

borderLeft

object (TableCellBorder)

Bordure gauche de la cellule.

borderRight

object (TableCellBorder)

Bordure droite de la cellule.

borderTop

object (TableCellBorder)

Bordure supérieure de la cellule.

borderBottom

object (TableCellBorder)

Bordure inférieure de la cellule.

paddingLeft

object (Dimension)

Marge intérieure gauche de la cellule.

paddingRight

object (Dimension)

Marge intérieure droite de la cellule.

paddingTop

object (Dimension)

Marge intérieure supérieure de la cellule.

paddingBottom

object (Dimension)

Marge intérieure inférieure de la cellule.

contentAlignment

enum (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 (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
Champs
color

object (OptionalColor)

Couleur de la bordure.

Cette couleur ne peut pas être transparente.

width

object (Dimension)

Largeur de la bordure.

dashStyle

enum (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 (TableCellStyle)
  },
  "tableCellStyleSuggestionState": {
    object (TableCellStyleSuggestionState)
  }
}
Champs
tableCellStyle

object (TableCellStyle)

Un élément TableCellStyle qui n'inclut que les modifications apportées à cette suggestion. Vous pouvez l'utiliser avec le tableCellStyleSuggestionState pour voir quels champs ont été modifiés et leurs nouvelles valeurs.

tableCellStyleSuggestionState

object (TableCellStyleSuggestionState)

Masque qui indique quels champs de l'élément TableCellStyle de base ont été modifiés dans cette suggestion.

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

boolean

Indique si une modification a été suggérée pour rowSpan.

columnSpanSuggested

boolean

Indique si une modification a été suggérée pour columnSpan.

backgroundColorSuggested

boolean

Indique si une modification a été suggérée pour backgroundColor.

borderLeftSuggested

boolean

Indique si une modification a été suggérée pour borderLeft.

borderRightSuggested

boolean

Indique si une modification a été suggérée pour borderRight.

borderTopSuggested

boolean

Indique si une modification a été suggérée pour borderTop.

borderBottomSuggested

boolean

Indique si une modification a été suggérée pour borderBottom.

paddingLeftSuggested

boolean

Indique si une modification a été suggérée pour paddingLeft.

paddingRightSuggested

boolean

Indique si une modification a été suggérée pour paddingRight.

paddingTopSuggested

boolean

Indique si une modification a été suggérée pour paddingTop.

paddingBottomSuggested

boolean

Indique si une modification a été suggérée pour paddingBottom.

contentAlignmentSuggested

boolean

Indique si une modification a été suggérée pour contentAlignment.

Style de la ligne de table

Styles qui s'appliquent à une ligne du tableau

Représentation JSON
{
  "minRowHeight": {
    object (Dimension)
  },
  "tableHeader": boolean,
  "preventOverflow": boolean
}
Champs
minRowHeight

object (Dimension)

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

boolean

Indique si la ligne est un en-tête de tableau.

preventOverflow

boolean

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 (TableRowStyle)
  },
  "tableRowStyleSuggestionState": {
    object (TableRowStyleSuggestionState)
  }
}
Champs
tableRowStyle

object (TableRowStyle)

Un élément TableRowStyle qui n'inclut que les modifications apportées à cette suggestion. Vous pouvez l'utiliser avec le tableRowStyleSuggestionState pour voir quels champs ont été modifiés et leurs nouvelles valeurs.

tableRowStyleSuggestionState

object (TableRowStyleSuggestionState)

Masque qui indique quels champs de l'élément TableRowStyle de base ont été modifiés dans cette suggestion.

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

boolean

Indique si une modification a été suggérée pour minRowHeight.

Style de table

Styles qui s'appliquent à un tableau.

Représentation JSON
{
  "tableColumnProperties": [
    {
      object (TableColumnProperties)
    }
  ]
}
Champs
tableColumnProperties[]

object (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 tableRowStyle de la ligne.

TableColumnProperties

Propriétés d'une colonne d'un tableau.

Représentation JSON
{
  "widthType": enum (WidthType),
  "width": {
    object (Dimension)
  }
}
Champs
widthType

enum (WidthType)

Type de largeur de la colonne.

width

object (Dimension)

Largeur de la colonne. Définissez ce paramètre lorsque la valeur de widthType de la colonne est FIXED_WIDTH.

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 (StructuralElement)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
Champs
content[]

object (StructuralElement)

Contenu de la table des matières.

suggestedInsertionIds[]

string

ID d'insertion suggérés. Un élément TableOfContents peut avoir plusieurs ID d'insertion s'il s'agit d'une modification suggérée imbriquée. Si ce champ est vide, il ne s'agit pas d'une insertion suggérée.

suggestedDeletionIds[]

string

ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu n'est proposée.

Note de bas de page

Note de bas de page d'un document.

Représentation JSON
{
  "footnoteId": string,
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
Champs
footnoteId

string

Identifiant de la note de bas de page.

content[]

object (StructuralElement)

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 (Background)
  },
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "useEvenPageHeaderFooter": boolean,
  "pageNumberStart": integer,
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "pageSize": {
    object (Size)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "useCustomHeaderFooterMargins": boolean,
  "flipPageOrientation": boolean
}
Champs
background

object (Background)

Arrière-plan du document. L'arrière-plan des documents ne peut pas être transparent.

defaultHeaderId

string

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.

evenPageHeaderId

string

ID de l'en-tête utilisé uniquement pour les pages paires. La valeur de useEvenPageHeaderFooter détermine si la valeur defaultHeaderId ou cette valeur doit être utilisée pour l'en-tête sur les pages paires. Si cette règle n'est pas configurée, il n'y a pas d'en-tête de page paire.

Cette propriété est en lecture seule.

firstPageHeaderId

string

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 useFirstPageHeaderFooter détermine si defaultHeaderId ou cette valeur doit être utilisée pour l'en-tête de la première page. Si cette règle n'est pas configurée, il n'y a pas d'en-tête de première page.

Cette propriété est en lecture seule.

pageNumberStart

integer

Numéro de page à partir duquel commencer à compter le nombre de pages.

marginTop

object (Dimension)

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

object (Dimension)

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

object (Dimension)

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

object (Dimension)

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

object (Size)

Taille d'une page du document.

marginHeader

object (Dimension)

Quantité d'espace entre le haut de la page et le contenu de l'en-tête.

flipPageOrientation

boolean

Facultatif. Indique s'il faut inverser les dimensions de l'élément pageSize, ce qui permet de modifier l'orientation de la page en mode portrait ou paysage.

Contexte

Représente l'arrière-plan d'un document.

Représentation JSON
{
  "color": {
    object (OptionalColor)
  }
}
Champs
color

object (OptionalColor)

Couleur de l'arrière-plan.

Taille

Une largeur et une hauteur.

Représentation JSON
{
  "height": {
    object (Dimension)
  },
  "width": {
    object (Dimension)
  }
}
Champs
height

object (Dimension)

Hauteur de l'objet.

width

object (Dimension)

Largeur de l'objet.

Style de document suggéré

Suggestion de modification de DocumentStyle.

Représentation JSON
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "documentStyleSuggestionState": {
    object (DocumentStyleSuggestionState)
  }
}
Champs
documentStyle

object (DocumentStyle)

Un élément DocumentStyle qui n'inclut que les modifications apportées à cette suggestion. Vous pouvez l'utiliser avec le documentStyleSuggestionState pour voir quels champs ont été modifiés et leurs nouvelles valeurs.

documentStyleSuggestionState

object (DocumentStyleSuggestionState)

Masque qui indique quels champs de l'élément DocumentStyle de base ont été modifiés dans cette suggestion.

É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 (BackgroundSuggestionState)
  },
  "defaultHeaderIdSuggested": boolean,
  "defaultFooterIdSuggested": boolean,
  "evenPageHeaderIdSuggested": boolean,
  "evenPageFooterIdSuggested": boolean,
  "firstPageHeaderIdSuggested": boolean,
  "firstPageFooterIdSuggested": boolean,
  "useFirstPageHeaderFooterSuggested": boolean,
  "useEvenPageHeaderFooterSuggested": boolean,
  "pageNumberStartSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginLeftSuggested": boolean,
  "pageSizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginHeaderSuggested": boolean,
  "marginFooterSuggested": boolean,
  "useCustomHeaderFooterMarginsSuggested": boolean,
  "flipPageOrientationSuggested": boolean
}
Champs
backgroundSuggestionState

object (BackgroundSuggestionState)

Masque qui indique quels champs de background ont été modifiés dans cette suggestion.

defaultHeaderIdSuggested

boolean

Indique si une modification a été suggérée pour defaultHeaderId.

evenPageHeaderIdSuggested

boolean

Indique si une modification a été suggérée pour evenPageHeaderId.

firstPageHeaderIdSuggested

boolean

Indique si une modification a été suggérée pour firstPageHeaderId.

pageNumberStartSuggested

boolean

Indique si une modification a été suggérée pour pageNumberStart.

marginTopSuggested

boolean

Indique si une modification a été suggérée pour marginTop.

marginBottomSuggested

boolean

Indique si une modification a été suggérée pour marginBottom.

marginRightSuggested

boolean

Indique si une modification a été suggérée pour marginRight.

marginLeftSuggested

boolean

Indique si une modification a été suggérée pour marginLeft.

pageSizeSuggestionState

object (SizeSuggestionState)

Masque indiquant quels champs de [size] [google.apps.docs.v1.DocumentStyle.size] ont été modifiés dans cette suggestion.

marginHeaderSuggested

boolean

Indique si une modification a été suggérée pour marginHeader.

flipPageOrientationSuggested

boolean

Facultatif. Indique si une modification a été suggérée pour flipPageOrientation.

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

boolean

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

boolean

Indique si une modification a été suggérée pour height.

widthSuggested

boolean

Indique si une modification a été suggérée pour width.

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 (NamedStyle)
    }
  ]
}
Champs
styles[]

object (NamedStyle)

Styles nommés.

Il existe une entrée pour chacun des named style types possibles.

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 (NamedStyleType),
  "textStyle": {
    object (TextStyle)
  },
  "paragraphStyle": {
    object (ParagraphStyle)
  }
}
Champs
namedStyleType

enum (NamedStyleType)

Type de ce style nommé.

textStyle

object (TextStyle)

Style de texte de ce style nommé.

paragraphStyle

object (ParagraphStyle)

Style de paragraphe de ce style nommé.

StylesNoms suggérés

Suggestion de modification de NamedStyles.

Représentation JSON
{
  "namedStyles": {
    object (NamedStyles)
  },
  "namedStylesSuggestionState": {
    object (NamedStylesSuggestionState)
  }
}
Champs
namedStyles

object (NamedStyles)

Un élément NamedStyles qui n'inclut que les modifications apportées à cette suggestion. Vous pouvez l'utiliser avec le namedStylesSuggestionState pour voir quels champs ont été modifiés et leurs nouvelles valeurs.

namedStylesSuggestionState

object (NamedStylesSuggestionState)

Masque qui indique quels champs de l'élément NamedStyles de base ont été modifiés dans cette suggestion.

NamedStylesSuggestionState

État de suggestion d'un message NamedStyles.

Représentation JSON
{
  "stylesSuggestionStates": [
    {
      object (NamedStyleSuggestionState)
    }
  ]
}
Champs
stylesSuggestionStates[]

object (NamedStyleSuggestionState)

Masque qui indique quels champs du NamedStyle correspondant dans styles ont été modifiés dans cette suggestion.

L'ordre de ces états de suggestion de style nommé correspond à celui du style nommé correspondant dans la suggestion named styles.

NamedStyleSuggestionState (État de suggestion de style nommé)

État de suggestion d'un message NamedStyle.

Représentation JSON
{
  "namedStyleType": enum (NamedStyleType),
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
Champs
namedStyleType

enum (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 NamedStyle correspondant.

textStyleSuggestionState

object (TextStyleSuggestionState)

Masque qui indique quels champs de text style ont été modifiés dans cette suggestion.

paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

Masque qui indique quels champs de paragraph style ont été modifiés dans cette suggestion.

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 (ListProperties)
  },
  "suggestedListPropertiesChanges": {
    string: {
      object (SuggestedListProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
Champs
listProperties

object (ListProperties)

Propriétés de la liste.

suggestedListPropertiesChanges

map (key: string, value: object (SuggestedListProperties))

Modifications suggérées pour les propriétés de la liste, associées à l'ID de suggestion.

suggestedInsertionId

string

ID d'insertion suggéré. Si ce champ est vide, il ne s'agit pas d'une insertion suggérée.

suggestedDeletionIds[]

string

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 (NestingLevel)
    }
  ]
}
Champs
nestingLevels[]

object (NestingLevel)

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 (BulletAlignment),
  "glyphFormat": string,
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "textStyle": {
    object (TextStyle)
  },
  "startNumber": integer,

  // Union field glyph_kind can be only one of the following:
  "glyphType": enum (GlyphType),
  "glyphSymbol": string
  // End of list of possible types for union field glyph_kind.
}
Champs
bulletAlignment

enum (BulletAlignment)

Alignement de la puce dans l'espace réservé à son rendu.

glyphFormat

string

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 glyphType ou de glyphSymbol. Les espaces réservés suivent le format %[nestingLevel]. De plus, les espaces réservés peuvent avoir des préfixes et des suffixes. Ainsi, le format du glyphe suit le modèle <prefix>%[nestingLevel]<suffix>. Notez que le préfixe et le suffixe sont facultatifs et peuvent correspondre à des chaînes arbitraires.

Par exemple, le format de glyphe %0. indique que le glyphe affiché remplacera l'espace réservé par le glyphe correspondant au niveau d'imbrication 0, suivi d'un point comme suffixe. Ainsi, une liste dont le type de glyphe est UPPER_ALPHA et le format de glyphe %0. au niveau d'imbrication 0 génère une liste avec les glyphes affichés.

A.

B.

C.

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 %0. au niveau d'imbrication 0 et le format de glyphe %0.%1. au niveau d'imbrication 1. En supposant que les deux niveaux d'imbrication aient des types de glyphes DECIMAL, une liste est générée avec les glyphes affichés.

1.

2.

2.1.

2.2.

3.

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

object (Dimension)

Quantité de retrait pour la première ligne de paragraphes à ce niveau d'imbrication.

indentStart

object (Dimension)

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

object (TextStyle)

Style de texte des puces à ce niveau d'imbrication.

startNumber

integer

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 à a et i.

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

enum (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 glyphFormat lorsque les paragraphes à ce niveau d'imbrication sont ordonnés. Par exemple, si le niveau d'imbrication est 0, que glyphFormat est %0. et que le type de glyphe est DECIMAL, le glyphe affiché remplacera l'espace réservé %0 au format glyphe par un nombre correspondant à l'ordre des éléments dans la liste.

glyphSymbol

string

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 glyphFormat. Par exemple, si le glyphe est le cercle plein correspondant au point de code Unicode U+25cf et que l'attribut glyphFormat est %0, le glyphe affiché est le cercle plein.

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 (ListProperties)
  },
  "listPropertiesSuggestionState": {
    object (ListPropertiesSuggestionState)
  }
}
Champs
listProperties

object (ListProperties)

Un élément ListProperties qui n'inclut que les modifications apportées à cette suggestion. Vous pouvez l'utiliser avec le listPropertiesSuggestionState pour voir quels champs ont été modifiés et leurs nouvelles valeurs.

listPropertiesSuggestionState

object (ListPropertiesSuggestionState)

Masque qui indique quels champs de l'élément ListProperties de base ont été modifiés dans cette suggestion.

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 (NestingLevelSuggestionState)
    }
  ]
}
Champs
nestingLevelsSuggestionStates[]

object (NestingLevelSuggestionState)

Masque qui indique quels champs du NestingLevel correspondant dans nestingLevels ont été modifiés dans cette suggestion.

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 (TextStyleSuggestionState)
  },
  "startNumberSuggested": boolean
}
Champs
bulletAlignmentSuggested

boolean

Indique si une modification a été suggérée pour bulletAlignment.

glyphTypeSuggested

boolean

Indique si une modification a été suggérée pour glyphType.

glyphFormatSuggested

boolean

Indique si une modification a été suggérée pour glyphFormat.

glyphSymbolSuggested

boolean

Indique si une modification a été suggérée pour glyphSymbol.

indentFirstLineSuggested

boolean

Indique si une modification a été suggérée pour indentFirstLine.

indentStartSuggested

boolean

Indique si une modification a été suggérée pour indentStart.

textStyleSuggestionState

object (TextStyleSuggestionState)

Masque qui indique quels champs de text style ont été modifiés dans cette suggestion.

startNumberSuggested

boolean

Indique si une modification a été suggérée pour startNumber.

Plages nommées

Collection de tous les éléments NamedRange du document qui partagent un nom donné.

Représentation JSON
{
  "name": string,
  "namedRanges": [
    {
      object (NamedRange)
    }
  ]
}
Champs
name

string

Nom partagé par tous les named ranges.

namedRanges[]

object (NamedRange)

Les NamedRange portant le même nom.

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 (Range)
    }
  ]
}
Champs
namedRangeId

string

ID de la plage nommée.

name

string

Nom de la plage nommée.

ranges[]

object (Range)

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

string

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

integer

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

integer

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 (InlineObjectProperties)
  },
  "suggestedInlineObjectPropertiesChanges": {
    string: {
      object (SuggestedInlineObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
Champs
objectId

string

ID de cet objet intégré. Permet de mettre à jour les propriétés d'un objet.

inlineObjectProperties

object (InlineObjectProperties)

Propriétés de cet objet intégré.

suggestedInlineObjectPropertiesChanges

map (key: string, value: object (SuggestedInlineObjectProperties))

Modifications suggérées pour les propriétés de l'objet intégré, associées à l'ID de suggestion.

suggestedInsertionId

string

ID d'insertion suggéré. Si ce champ est vide, il ne s'agit pas d'une insertion suggérée.

suggestedDeletionIds[]

string

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 (EmbeddedObject)
  }
}
Champs
embeddedObject

object (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 (EmbeddedObjectBorder)
  },
  "size": {
    object (Size)
  },
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "linkedContentReference": {
    object (LinkedContentReference)
  },

  // Union field properties can be only one of the following:
  "embeddedDrawingProperties": {
    object (EmbeddedDrawingProperties)
  },
  "imageProperties": {
    object (ImageProperties)
  }
  // End of list of possible types for union field properties.
}
Champs
title

string

Titre de l'objet intégré. Les éléments title et description sont tous deux combinés pour afficher un texte alternatif.

description

string

Description de l'objet intégré. Les éléments title et description sont tous deux combinés pour afficher un texte alternatif.

embeddedObjectBorder

object (EmbeddedObjectBorder)

Bordure de l'objet intégré.

size

object (Size)

Taille visible de l'image après recadrage.

marginTop

object (Dimension)

Marge supérieure de l'objet intégré.

marginBottom

object (Dimension)

Marge inférieure de l'objet intégré.

marginRight

object (Dimension)

Marge droite de l'objet intégré.

marginLeft

object (Dimension)

Marge gauche de l'objet intégré.

linkedContentReference

object (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

object (EmbeddedDrawingProperties)

Propriétés d'un dessin intégré.

imageProperties

object (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 (CropProperties)
  },
  "angle": number
}
Champs
contentUri

string

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

string

L'URI source est l'URI utilisé pour insérer l'image. L'URI source peut être vide.

brightness

number

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

number

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

number

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

object (CropProperties)

Propriétés de recadrage de l'image.

angle

number

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

number

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

number

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

number

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

number

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

number

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 (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle),
  "propertyState": enum (PropertyState)
}
Champs
color

object (OptionalColor)

Couleur de la bordure.

width

object (Dimension)

Largeur de la bordure.

dashStyle

enum (DashStyle)

Style de tiret de la bordure.

propertyState

enum (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 reference can be only one of the following:
  "sheetsChartReference": {
    object (SheetsChartReference)
  }
  // End of list of possible types for union field reference.
}
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

object (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

string

ID de la feuille de calcul Google Sheets contenant le graphique source.

chartId

integer

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 (InlineObjectProperties)
  },
  "inlineObjectPropertiesSuggestionState": {
    object (InlineObjectPropertiesSuggestionState)
  }
}
Champs
inlineObjectProperties

object (InlineObjectProperties)

InlineObjectProperties qui n'inclut que les modifications apportées à cette suggestion. Vous pouvez l'utiliser avec le inlineObjectPropertiesSuggestionState pour voir quels champs ont été modifiés et leurs nouvelles valeurs.

inlineObjectPropertiesSuggestionState

object (InlineObjectPropertiesSuggestionState)

Masque qui indique quels champs de l'élément InlineObjectProperties de base ont été modifiés dans cette suggestion.

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 (EmbeddedObjectSuggestionState)
  }
}
Champs
embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

Masque qui indique quels champs de embeddedObject ont été modifiés dans cette suggestion.

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 (EmbeddedDrawingPropertiesSuggestionState)
  },
  "imagePropertiesSuggestionState": {
    object (ImagePropertiesSuggestionState)
  },
  "titleSuggested": boolean,
  "descriptionSuggested": boolean,
  "embeddedObjectBorderSuggestionState": {
    object (EmbeddedObjectBorderSuggestionState)
  },
  "sizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginLeftSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "linkedContentReferenceSuggestionState": {
    object (LinkedContentReferenceSuggestionState)
  }
}
Champs
embeddedDrawingPropertiesSuggestionState

object (EmbeddedDrawingPropertiesSuggestionState)

Masque qui indique quels champs de embeddedDrawingProperties ont été modifiés dans cette suggestion.

imagePropertiesSuggestionState

object (ImagePropertiesSuggestionState)

Masque qui indique quels champs de imageProperties ont été modifiés dans cette suggestion.

titleSuggested

boolean

Indique si une modification a été suggérée pour title.

descriptionSuggested

boolean

Indique si une modification a été suggérée pour description.

embeddedObjectBorderSuggestionState

object (EmbeddedObjectBorderSuggestionState)

Masque qui indique quels champs de embeddedObjectBorder ont été modifiés dans cette suggestion.

sizeSuggestionState

object (SizeSuggestionState)

Masque qui indique quels champs de size ont été modifiés dans cette suggestion.

marginLeftSuggested

boolean

Indique si une modification a été suggérée pour marginLeft.

marginRightSuggested

boolean

Indique si une modification a été suggérée pour marginRight.

marginTopSuggested

boolean

Indique si une modification a été suggérée pour marginTop.

marginBottomSuggested

boolean

Indique si une modification a été suggérée pour marginBottom.

linkedContentReferenceSuggestionState

object (LinkedContentReferenceSuggestionState)

Masque qui indique quels champs de linkedContentReference ont été modifiés dans cette suggestion.

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 (CropPropertiesSuggestionState)
  },
  "angleSuggested": boolean
}
Champs
contentUriSuggested

boolean

Indique si une modification a été suggérée pour contentUri.

sourceUriSuggested

boolean

Indique si une modification a été suggérée dans [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri].

brightnessSuggested

boolean

Indique si une modification a été suggérée pour [luminosité] [google.apps.docs.v1.EmbeddedObject.brightness].

contrastSuggested

boolean

Indique si une modification a été suggérée dans [contrast] [google.apps.docs.v1.EmbeddedObject.contrast].

transparencySuggested

boolean

Indique si une modification a été suggérée pour [transparency] [google.apps.docs.v1.EmbeddedObject.transparency].

cropPropertiesSuggestionState

object (CropPropertiesSuggestionState)

Masque qui indique quels champs de cropProperties ont été modifiés dans cette suggestion.

angleSuggested

boolean

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

boolean

Indique si une modification a été suggérée pour offsetLeft.

offsetRightSuggested

boolean

Indique si une modification a été suggérée pour offsetRight.

offsetTopSuggested

boolean

Indique si une modification a été suggérée pour offsetTop.

offsetBottomSuggested

boolean

Indique si une modification a été suggérée pour offsetBottom.

angleSuggested

boolean

Indique si une modification a été suggérée pour angle.

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

boolean

Indique si une modification a été suggérée dans [google.apps.docs.v1.EmbeddedBorderObject.color].

widthSuggested

boolean

Indique si une modification a été suggérée pour [width] [google.apps.docs.v1.EmbeddedBorderObject.width].

dashStyleSuggested

boolean

Indique si une modification a été suggérée dans [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style].

propertyStateSuggested

boolean

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 (SheetsChartReferenceSuggestionState)
  }
}
Champs
sheetsChartReferenceSuggestionState

object (SheetsChartReferenceSuggestionState)

Masque qui indique quels champs de sheetsChartReference ont été modifiés dans cette suggestion.

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

boolean

Indique si une modification a été suggérée pour spreadsheetId.

chartIdSuggested

boolean

Indique si une modification a été suggérée pour chartId.

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 (PositionedObjectProperties)
  },
  "suggestedPositionedObjectPropertiesChanges": {
    string: {
      object (SuggestedPositionedObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
Champs
objectId

string

ID de cet objet positionné.

positionedObjectProperties

object (PositionedObjectProperties)

Propriétés de cet objet positionné.

suggestedPositionedObjectPropertiesChanges

map (key: string, value: object (SuggestedPositionedObjectProperties))

Modifications suggérées pour les propriétés de l'objet positionné, associées à l'ID de suggestion.

suggestedInsertionId

string

ID d'insertion suggéré. Si ce champ est vide, il ne s'agit pas d'une insertion suggérée.

suggestedDeletionIds[]

string

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 (PositionedObjectPositioning)
  },
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
Champs
positioning

object (PositionedObjectPositioning)

Positionnement de cet objet positionné par rapport à la nouvelle ligne de la Paragraph qui le référence.

embeddedObject

object (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 (PositionedObjectLayout),
  "leftOffset": {
    object (Dimension)
  },
  "topOffset": {
    object (Dimension)
  }
}
Champs
layout

enum (PositionedObjectLayout)

Mise en page de cet objet positionné.

leftOffset

object (Dimension)

Décalage du bord gauche de l'objet positionné par rapport au début du Paragraph auquel il est attaché. L'emplacement exact de l'objet peut dépendre du contenu du document et du style du document.

topOffset

object (Dimension)

Décalage du bord supérieur de l'objet positionné par rapport au début du Paragraph auquel il est attaché. L'emplacement exact de l'objet peut dépendre du contenu du document et du style du document.

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 (PositionedObjectProperties)
  },
  "positionedObjectPropertiesSuggestionState": {
    object (PositionedObjectPropertiesSuggestionState)
  }
}
Champs
positionedObjectProperties

object (PositionedObjectProperties)

Un élément PositionedObjectProperties qui n'inclut que les modifications apportées à cette suggestion. Vous pouvez l'utiliser avec le positionedObjectPropertiesSuggestionState pour voir quels champs ont été modifiés et leurs nouvelles valeurs.

positionedObjectPropertiesSuggestionState

object (PositionedObjectPropertiesSuggestionState)

Masque qui indique quels champs de l'élément PositionedObjectProperties de base ont été modifiés dans cette suggestion.

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 (PositionedObjectPositioningSuggestionState)
  },
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
Champs
positioningSuggestionState

object (PositionedObjectPositioningSuggestionState)

Masque qui indique quels champs de positioning ont été modifiés dans cette suggestion.

embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

Masque qui indique quels champs de embeddedObject ont été modifiés dans cette suggestion.

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

boolean

Indique si une modification a été suggérée pour layout.

leftOffsetSuggested

boolean

Indique si une modification a été suggérée pour leftOffset.

topOffsetSuggested

boolean

Indique si une modification a été suggérée pour topOffset.

Méthodes

batchUpdate

Applique une ou plusieurs mises à jour au document.

create

Crée un document vierge en utilisant le titre fourni dans la requête.

get

Récupère la dernière version du document spécifié.