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. L'ID 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 à un ID d'en-tête.

footers

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

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

footnotes

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

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

documentStyle

object (DocumentStyle)

Uniquement en sortie. Style du document.

suggestedDocumentStyleChanges

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

Uniquement en sortie. Les modifications proposées pour le style du document sont associées à un ID de suggestion.

namedStyles

object (NamedStyles)

Uniquement en sortie. Styles nommés du document.

suggestedNamedStylesChanges

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

Uniquement en sortie. Les modifications suggérées aux styles nommés du document sont associées à un ID de suggestion.

lists

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

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

namedRanges

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

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

revisionId

string

Uniquement en sortie. ID de révision du document. Peut être utilisée dans les demandes de mise à jour pour spécifier la révision d'un document à laquelle appliquer les mises à jour et le comportement de la requête si le document a été modifié depuis cette révision. N'est renseigné que si l'utilisateur est autorisé à modifier le document.

L'ID de révision n'est pas un nombre séquentiel, mais une chaîne opaque. Le format de l'ID de révision peut changer au fil du temps. La validité d'un ID de révision renvoyé n'est garantie que pendant 24 heures après son envoi. Il ne peut pas être partagé entre les utilisateurs. Si l'ID de révision n'est pas modifié entre les appels, cela signifie que le document n'a pas changé. À l'inverse, si l'ID a changé (pour le même document et le même utilisateur), cela signifie généralement que le document a été mis à jour. Toutefois, un changement d'identifiant peut également être dû à des facteurs internes, tels que les changements de format.

suggestionsViewMode

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 portant l'attribut SUGGESTIONS_INLINE.

inlineObjects

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

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

positionedObjects

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

Uniquement en sortie. Objets positionnés dans le document, associés à un ID d'objet.

Corps

Corps du document.

Le corps contient généralement l'intégralité du contenu du document, à l'exception de headers, footers et footnotes.

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

object (StructuralElement)

Contenu du corps.

Les index du contenu du corps commencent à zéro.

Élément structurel

"StructuralElement" décrit le contenu qui structure le document.

Représentation JSON
{
  "startIndex": integer,
  "endIndex": integer,

  // Union field 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

Index de départ basé sur zéro de cet élément structurel, en unités de code UTF-16.

endIndex

integer

Index de fin de base zéro de cet élément structurel, exclusif, en unités de code UTF-16.

Champ d'union content. Contenu de l'élément structurel. content ne peut être qu'un des éléments suivants :
paragraph

object (Paragraph)

Type de paragraphe de l'élément structurel.

sectionBreak

object (SectionBreak)

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

table

object (Table)

Type de table de l'élément structurel.

tableOfContents

object (TableOfContents)

Table des matières du type d'élément structurel.

Paragraph

StructuralElement représentant un paragraphe. Un paragraphe est une plage de contenu se terminant par un caractère de nouvelle ligne.

Représentation JSON
{
  "elements": [
    {
      object (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, divisé en plusieurs parties qui la composent.

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 n'est pas présent, le paragraphe n'appartient pas à une liste.

suggestedBulletChanges

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

La modification suggérée dans la puce de ce paragraphe

positionedObjectIds[]

string

ID des objets positionnés partageant ce paragraphe.

suggestedPositionedObjectIds

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

ID des objets positionnés qui doivent être associés au paragraphe, avec un ID de suggestion.

Élément de paragraphe

Un ParagraphElement décrit le contenu d'un élément Paragraph.

Représentation JSON
{
  "startIndex": integer,
  "endIndex": integer,

  // Union field 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 zéro base de cet élément de paragraphe, exclusif, en unités de code UTF-16.

Champ d'union content. Contenu de l'élément de paragraphe. content ne peut être qu'un des éléments suivants :
textRun

object (TextRun)

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

autoText

object (AutoText)

Élément de paragraphe avec texte automatique.

pageBreak

object (PageBreak)

Élément de paragraphe avec saut de page.

columnBreak

object (ColumnBreak)

Élément de paragraphe avec saut de colonne

footnoteReference

object (FootnoteReference)

Élément de paragraphe de référence de 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 vers une personne ou une adresse e-mail.

Exécution de texte

ParagraphElement qui représente une exécution de texte ayant le même style.

Représentation JSON
{
  "content": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Champs
content

string

Texte de cette exécution.

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

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu ne sera 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é change pour cette exécution, associé à l'ID de suggestion.

TextStyle

Représente le style qui peut être appliqué au texte.

Les styles de texte hérités sont représentés par des champs non définis dans ce message. Le parent d'un style de texte dépend de l'emplacement du style de texte:

  • Le TextStyle du texte dans un Paragraph hérite du named style type correspondant du paragraphe.
  • Le TextStyle sur un named style hérite du style nommé normal text.
  • Le style de texte du style nommé normal text hérite du style de texte par défaut de l'éditeur Docs.
  • Le style de texte d'un élément Paragraph contenu dans un tableau peut hériter du style de texte du style de tableau.

Si le style de texte n'hérite pas d'un élément parent, la réinitialisation des champs rétablit le style et rétablit la valeur par défaut dans l'éditeur Docs.

Représentation JSON
{
  "bold": boolean,
  "italic": boolean,
  "underline": boolean,
  "strikethrough": boolean,
  "smallCaps": boolean,
  "backgroundColor": {
    object (OptionalColor)
  },
  "foregroundColor": {
    object (OptionalColor)
  },
  "fontSize": {
    object (Dimension)
  },
  "weightedFontFamily": {
    object (WeightedFontFamily)
  },
  "baselineOffset": enum (BaselineOffset),
  "link": {
    object (Link)
  }
}
Champs
bold

boolean

Indique si le texte est en gras.

italic

boolean

Mettre le texte en italique

underline

boolean

Indique si le texte est souligné.

strikethrough

boolean

Indique si le texte est barré.

smallCaps

boolean

Indique si le texte est en petits caractères.

backgroundColor

object (OptionalColor)

Couleur d'arrière-plan du texte. Si elle est définie, la couleur est RVB ou transparente, en fonction du champ color.

foregroundColor

object (OptionalColor)

Couleur de premier plan du texte. Si elle est définie, la couleur est RVB ou transparente, en fonction du champ color.

fontSize

object (Dimension)

Taille de la police du texte.

weightedFontFamily

object (WeightedFontFamily)

Famille de polices et épaisseur du texte affiché

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

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

Si weightedFontFamily est défini, 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 SUPERSCRIPT ou SUBSCRIPT est automatiquement affiché dans une taille de police plus petite. Il est calculé en fonction du champ fontSize. Les modifications apportées à ce champ n'affectent pas le fontSize.

Couleur facultative

Couleur pouvant être soit opaque, soit totalement transparente.

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

object (Color)

S'il est défini, il sera utilisé comme couleur opaque. Si la valeur n'est pas définie, il s'agit d'une couleur transparente.

Couleur

Couleur unie.

Représentation JSON
{
  "rgbColor": {
    object (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, de 0 à 1.

green

number

Composant vert de la couleur, de 0,0 à 1,0.

blue

number

Composant bleu de la couleur, de 0,0 à 1,0.

Dimension

Magnitude dans une seule direction, dans les unités spécifiées.

Représentation JSON
{
  "magnitude": number,
  "unit": enum (Unit)
}
Champs
magnitude

number

Magnitude.

unit

enum (Unit)

Unités pour la magnitude.

Unité

Unités de mesure.

Enums
UNIT_UNSPECIFIED Les unités sont inconnues.
PT Un point, 1/72 de pouce.

Famille de polices pondérées

Représente une famille de polices et l'épaisseur du texte.

Représentation JSON
{
  "fontFamily": string,
  "weight": integer
}
Champs
fontFamily

string

Famille de polices du texte.

La famille de polices peut être n'importe quelle police depuis le menu Police de Docs ou Google Fonts. Si le nom de la police n'est pas reconnu, le texte est affiché dans Arial.

weight

integer

Épaisseur de la police. Ce champ peut contenir n'importe quelle valeur multiple d'une valeur de 100 comprise entre 100 et 900 inclus. Cette plage correspond aux valeurs numériques décrites dans la spécification CSS 2.1, section 15.6, avec les valeurs non numériques non autorisées.

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

L'épaisseur de la police ne représente qu'un seul de ses composants. Une combinaison de weight et de la valeur bold résolue du style de texte détermine l'épaisseur de rendu, après prise en compte de l'héritage:

  • Si le texte est en gras et l'épaisseur inférieure à 400, l'épaisseur affichée est 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 la pondération est supérieure ou égale à 700, la pondération affichée est égale à la pondération.
  • Si le texte n'est pas en gras, la pondération est égale à la pondération.

BaselineOffset

Manières dont le texte peut être décalé verticalement de sa position normale.

Enums
BASELINE_OFFSET_UNSPECIFIED Le décalage de référence du texte est hérité de l'élément parent.
NONE Le texte n'est pas décalé verticalement.
SUPERSCRIPT Le texte est décalé verticalement vers le haut (en exposant).
SUBSCRIPT Le texte est décalé verticalement vers le bas (indice).

Style de texte suggéré

Suggestion de modification d'un TextStyle.

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

object (TextStyle)

TextStyle qui n'inclut que les modifications apportées à cette suggestion. Vous pouvez l'utiliser avec textStyleSuggestionState pour identifier les champs modifiés et leurs nouvelles valeurs.

textStyleSuggestionState

object (TextStyleSuggestionState)

Masque indiquant quels champs de la base TextStyle ont été modifiés dans cette suggestion.

Suggestion de style du texte

Masque indiquant quels champs de la base TextStyle ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.

Représentation JSON
{
  "boldSuggested": boolean,
  "italicSuggested": boolean,
  "underlineSuggested": boolean,
  "strikethroughSuggested": boolean,
  "smallCapsSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "foregroundColorSuggested": boolean,
  "fontSizeSuggested": boolean,
  "weightedFontFamilySuggested": boolean,
  "baselineOffsetSuggested": boolean,
  "linkSuggested": boolean
}
Champs
boldSuggested

boolean

Indique s'il y a eu une suggestion de modification de bold.

italicSuggested

boolean

Indique s'il y a eu une suggestion de modification de italic.

underlineSuggested

boolean

Indique s'il y a eu une suggestion de modification de underline.

strikethroughSuggested

boolean

Indique s'il y a eu une suggestion de modification de strikethrough.

smallCapsSuggested

boolean

Indique s'il y a eu une suggestion de modification de smallCaps.

backgroundColorSuggested

boolean

Indique s'il y a eu une suggestion de modification de backgroundColor.

foregroundColorSuggested

boolean

Indique s'il y a eu une suggestion de modification de foregroundColor.

fontSizeSuggested

boolean

Indique s'il y a eu une suggestion de modification de fontSize.

weightedFontFamilySuggested

boolean

Indique s'il y a eu une suggestion de modification de weightedFontFamily.

baselineOffsetSuggested

boolean

Indique s'il y a eu une suggestion de modification de baselineOffset.

Texte automatique

ParagraphElement représentant une zone du texte qui est remplacée de façon dynamique par du contenu qui peut changer au fil du temps, comme un numéro de page.

Représentation JSON
{
  "type": enum (Type),
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Champs
type

enum (Type)

Type de texte automatique.

suggestedInsertionIds[]

string

ID d'insertion suggérés. Un 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 suggestion d'insertion.

suggestedDeletionIds[]

string

ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu ne sera 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 le texte automatique, associé à l'ID de suggestion.

Type

Types de texte automatique.

Enums
TYPE_UNSPECIFIED Type de texte automatique non spécifié.
PAGE_NUMBER Saisissez du texte automatique qui représente le numéro de page actuel.
PAGE_COUNT Saisissez un texte automatique qui représente le nombre total de pages du document.

Saut de page

Élément ParagraphElement représentant un saut de page. Un saut de page fait débuter le texte suivant en haut de la page suivante.

Représentation JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Champs
suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

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

textStyle

object (TextStyle)

Style de texte de ce saut de page.

À l'instar du contenu textuel, comme les exécutions de texte et les références à une note de bas de page, le style de texte d'un saut de page peut avoir une incidence sur la mise en page, ainsi que sur le style du texte inséré à côté.

suggestedTextStyleChanges

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

Le style de texte suggéré est remplacé par cet extrait de page, associé à l'ID de suggestion.

Saut de colonne

ParagraphElement représentant un saut de colonne. Le saut de colonne fait apparaître le texte suivant en haut de la colonne suivante.

Représentation JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Champs
suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

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

textStyle

object (TextStyle)

Style de texte de cet ColumnBreak.

Comme pour le contenu textuel, comme les exécutions de texte et les références à une note de bas de page, le style de texte d'un saut de colonne peut avoir une incidence sur la mise en page, ainsi que sur le style du texte inséré à côté.

suggestedTextStyleChanges

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

Le style de texte suggéré est remplacé par cet élément ColumnBreak, associé à l'ID de suggestion.

Référence à la note de bas de page

ParagraphElement représentant une référence à une note de bas de page. Une référence à une note de bas de page correspond au contenu intégré affiché avec un nombre et permet d'identifier la note de bas de page.

Représentation JSON
{
  "footnoteId": string,
  "footnoteNumber": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Champs
footnoteId

string

ID de la propriété footnote comportant le contenu de cette référence de note de bas de page.

footnoteNumber

string

Nombre de rendus de cette note de bas de page.

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

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

textStyle

object (TextStyle)

Style de texte de cette note de bas de page.

suggestedTextStyleChanges

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

Le style de texte suggéré est remplacé par cette note de bas de page, associée à l'ID de la suggestion.

Règle horizontale

Élément ParagraphElement représentant une ligne horizontale.

Représentation JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Champs
suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu ne sera 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 à une note de bas de page, le style de texte d'une règle horizontale peut affecter la mise en page du contenu, ainsi que le style du texte inséré à côté.

suggestedTextStyleChanges

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

Le style de texte suggéré devient HorizontalRule, associé à un ID de suggestion.

Équation

ParagraphElement représentant une équation.

Représentation JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
Champs
suggestedInsertionIds[]

string

ID d'insertion suggérés. Un 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 suggestion d'insertion.

suggestedDeletionIds[]

string

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

Élément intégré

Un ParagraphElement contenant un InlineObject.

Représentation JSON
{
  "inlineObjectId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Champs
inlineObjectId

string

ID de l'élément InlineObject contenant cet élément.

suggestedInsertionIds[]

string

ID d'insertion suggérés. Un 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 suggestion d'insertion.

suggestedDeletionIds[]

string

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

textStyle

object (TextStyle)

Style de texte de cet élément InlineObjectElement.

Comme pour le contenu textuel, comme les exécutions de texte et les références de note de bas de page, le style de texte d'un élément d'objet intégré peut avoir une incidence sur la mise en page du contenu, ainsi que sur le style du texte inséré à côté.

suggestedTextStyleChanges

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

Le style de texte suggéré est remplacé par cet objet InlineObject, associé à un ID de suggestion.

Person

Une personne ou une adresse e-mail mentionnées dans un document Ces mentions se comportent comme un élément immuable unique contenant le nom ou l'adresse e-mail de la personne concernée.

Représentation JSON
{
  "personId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  },
  "personProperties": {
    object (PersonProperties)
  }
}
Champs
personId

string

Uniquement en sortie. Identifiant unique de cette association.

suggestedInsertionIds[]

string

Les ID des suggestions permettent d'insérer cette personne dans le document. Un élément Person peut avoir plusieurs ID d'insertion s'il s'agit d'une suggestion imbriquée (une suggestion émise par un autre utilisateur, par exemple). Si ce champ est vide, le lien de cette personne n'est pas une suggestion d'insertion.

suggestedDeletionIds[]

string

ID des suggestions de suppression du lien de cette personne du document. Un Person peut avoir plusieurs ID de suppression si, par exemple, plusieurs utilisateurs suggèrent de le supprimer. Si ce champ est vide, sa suppression n'est pas proposée.

textStyle

object (TextStyle)

Style de texte de ce Person.

suggestedTextStyleChanges

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

Le style de texte suggéré passe à 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és personnelles

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, si celui-ci est affiché dans le texte du lien plutôt que dans l'adresse e-mail de la personne.

email

string

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

Propriétés des liens enrichis

Propriétés spécifiques à un RichLink.

Représentation JSON
{
  "title": string,
  "uri": string,
  "mimeType": string
}
Champs
title

string

Uniquement en sortie. Titre de l'élément RichLink tel qu'il apparaît dans le lien. Ce titre correspond au titre de la ressource associée lors de l'insertion ou de la dernière mise à jour de l'association. Ce champ est toujours présent.

uri

string

Uniquement en sortie. L'URI vers RichLink. C'est toujours le cas.

mimeType

string

Uniquement en sortie. Type MIME du 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'emplacement du style de paragraphe:

  • Le ParagraphStyle dans 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 Style normal text du style hérité hérite du style de paragraphe par défaut dans l'éditeur Docs.
  • Le style de paragraphe défini sur un élément Paragraph contenu dans un tableau peut hériter de son style de paragraphe du style de tableau.

Si le style de paragraphe n'hérite pas d'un élément parent, la réinitialisation des champs rétablit le style et rétablit une valeur correspondant aux valeurs par défaut dans l'éditeur Docs.

Représentation JSON
{
  "headingId": string,
  "namedStyleType": enum (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 du titre du paragraphe. Si ce champ est vide, il ne s'agit pas d'un titre.

Cette propriété est en lecture seule.

namedStyleType

enum (NamedStyleType)

Type de style nommé du paragraphe.

Étant donné que la mise à jour du type de style nommé a une incidence sur les autres propriétés de ParagraphStyle, il est appliqué avant les autres propriétés.

alignment

enum (Alignment)

Alignement du texte pour ce paragraphe.

lineSpacing

number

Quantité d'espace entre des lignes, sous la forme d'un pourcentage de normal, le normal étant représenté par 100.0. Si cette règle n'est pas configurée, la valeur est héritée du parent.

direction

enum (ContentDirection)

Sens du texte de ce paragraphe. Si cette règle n'est pas configurée, la valeur par défaut est LEFT_TO_RIGHT, car l'orientation du paragraphe n'est pas héritée.

spacingMode

enum (SpacingMode)

Mode d'espacement pour le paragraphe.

spaceAbove

object (Dimension)

Il s'agit de la quantité d'espace supplémentaire au-dessus du paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent.

spaceBelow

object (Dimension)

Il s'agit de la quantité d'espace supplémentaire sous le paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent.

borderBetween

object (ParagraphBorder)

Bordure entre ce paragraphe et les paragraphes suivants et précédents. Si cette règle n'est pas configurée, la valeur est héritée du parent.

La bordure "entre" s'affiche lorsque le paragraphe adjacent présente les mêmes propriétés de bordure et de retrait.

Impossible de modifier partiellement les bordures des paragraphes. Lorsque vous modifiez la bordure d'un paragraphe, vous devez spécifier la nouvelle bordure dans son intégralité.

borderTop

object (ParagraphBorder)

Bordure en haut de ce paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent.

La bordure supérieure s'affiche lorsque les propriétés de bordure et de retrait de ce paragraphe sont différentes.

Impossible de modifier partiellement les bordures des paragraphes. Lorsque vous modifiez la bordure d'un paragraphe, vous devez spécifier la nouvelle bordure dans son intégralité.

borderBottom

object (ParagraphBorder)

Bordure en bas de ce paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent.

La bordure inférieure s'affiche lorsque les propriétés de bordure et de retrait du paragraphe ci-dessous sont différentes.

Impossible de modifier partiellement les bordures des paragraphes. Lorsque vous modifiez la bordure d'un paragraphe, vous devez spécifier la nouvelle bordure dans son intégralité.

borderLeft

object (ParagraphBorder)

Bordure à gauche de ce paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent.

Impossible de modifier partiellement les bordures des paragraphes. Lorsque vous modifiez la bordure d'un paragraphe, vous devez spécifier la nouvelle bordure dans son intégralité.

borderRight

object (ParagraphBorder)

Bordure à droite de ce paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent.

Impossible de modifier partiellement les bordures des paragraphes. Lorsque vous modifiez la bordure d'un paragraphe, vous devez spécifier la nouvelle bordure dans son intégralité.

indentFirstLine

object (Dimension)

Niveau de retrait de la première ligne du paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent.

indentStart

object (Dimension)

La quantité de retrait pour le paragraphe sur le côté qui correspond au début du texte, en fonction de la direction actuelle du paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent.

indentEnd

object (Dimension)

La quantité de retrait pour le paragraphe sur le côté qui correspond à la fin du texte, en fonction de la direction actuelle du paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent.

tabStops[]

object (TabStop)

La liste des onglets s'arrête pour ce paragraphe. La liste des tabulations n'est pas héritée.

Cette propriété est en lecture seule.

keepLinesTogether

boolean

Indique si toutes les lignes du paragraphe doivent être disposées sur la même page ou colonne si possible. Si cette règle n'est pas configurée, la valeur est héritée du parent.

keepWithNext

boolean

Indique si une partie ou la fin de ce paragraphe doit être disposée sur la même page ou colonne que le paragraphe suivant, si possible. Si cette règle n'est pas configurée, la valeur est héritée du parent.

avoidWidowAndOrphan

boolean

Indique s'il faut éviter les veuves et les orphelins pour le paragraphe. Si cette règle n'est pas configurée, la valeur est héritée du parent.

shading

object (Shading)

Nuance du paragraphe. Si cette règle n'est pas configurée, 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 règle n'est pas configurée, la valeur est héritée du parent.

Si vous essayez de modifier pageBreakBefore pour les paragraphes dans des régions non compatibles, y compris Table, Header, Footer et Footnote, vous pouvez obtenir un état de document non valide, qui renvoie une erreur 400 de requête incorrecte.

TypeStyleStyle

Types de styles nommés.

Enums
NAMED_STYLE_TYPE_UNSPECIFIED Le type de style nommé n'est pas spécifié.
NORMAL_TEXT Texte normal.
TITLE Titre.
SUBTITLE Sous-titres.
HEADING_1 Titre 1.
HEADING_2 Titre 2.
HEADING_3 Titre 3.
HEADING_4 Titre 4.
HEADING_5 Titre 5.
HEADING_6 Titre 6.

Alignement

Types d'alignement du texte d'un paragraphe.

Enums
ALIGNMENT_UNSPECIFIED L'alignement du paragraphe est hérité de l'élément parent.
START Le paragraphe est aligné par rapport au début de la ligne. Aligné à gauche pour le texte de gauche à droite, sinon aligné à droite.
CENTER Le paragraphe est centré.
END Le paragraphe est aligné à la fin de la ligne. Aligné à droite pour le texte de gauche à droite, ou à gauche dans le cas contraire.
JUSTIFIED Le paragraphe est justifié.

Direction du contenu

Le contenu de l'itinéraire peut circuler.

Enums
CONTENT_DIRECTION_UNSPECIFIED La direction du contenu n'est pas spécifiée.
LEFT_TO_RIGHT Le contenu s'affiche de gauche à droite.
RIGHT_TO_LEFT Le contenu va de droite à gauche.

Mode espacement

Les différents modes d'espacement des paragraphes

Enums
SPACING_MODE_UNSPECIFIED Le mode d'espacement est hérité de l'élément parent.
NEVER_COLLAPSE L'espacement des paragraphes est toujours affiché.
COLLAPSE_LISTS L'espacement des paragraphes est ignoré entre les éléments de liste.

Bordure de paragraphe

Bordure autour d'un paragraphe

Représentation JSON
{
  "color": {
    object (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 tirets

Types de tirets permettant d'afficher la géométrie linéaire. Ces valeurs sont basées sur le type simple "ST_PresetLineDashVal", décrit à la section 20.1.10.48 de l'article "Office Open XML File Formats - Fundamentals and Markup Language Reference" (Partie 1 de la 4e édition ECMA-376).

Enums
DASH_STYLE_UNSPECIFIED Style de tiret non spécifié.
SOLID Ligne continue. Correspond à la valeur "solide" ECMA-376 ST_PresetLineDashVal. Il s'agit du style de tiret par défaut.
DOT Ligne pointillée. Correspond à la valeur "dot" de ECMA-376 ST_PresetLineDashVal.
DASH Ligne en pointillés Correspond à la valeur "dash" de ECMA-376 ST_PresetLineDashVal.

TabTab

Une tabulation dans un paragraphe.

Représentation JSON
{
  "offset": {
    object (Dimension)
  },
  "alignment": enum (TabStopAlignment)
}
Champs
offset

object (Dimension)

Décalage entre cet arrêt et la marge de début.

alignment

enum (TabStopAlignment)

L'alignement de cet onglet s'arrête. Si cette règle n'est pas configurée, elle est définie par défaut sur START.

TabStopAlignment

Alignement de la tabulation.

Enums
TAB_STOP_ALIGNMENT_UNSPECIFIED L'alignement de la tabulation n'est pas spécifié.
START Le taquet de tabulation est aligné au début de la ligne. Il s'agit de la valeur par défaut.
CENTER La tabulation est alignée au centre de la ligne.
END La tabulation est alignée à la fin de la ligne.

Ombrage

Nuance d'un paragraphe.

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

object (OptionalColor)

Couleur d'arrière-plan de cette ombre de paragraphe.

Style de paragraphe suggéré

Suggestion de modification d'un ParagraphStyle.

Représentation JSON
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
Champs
paragraphStyle

object (ParagraphStyle)

ParagraphStyle qui n'inclut que les modifications apportées à cette suggestion. Vous pouvez l'utiliser avec paragraphStyleSuggestionState pour identifier les champs modifiés et leurs nouvelles valeurs.

paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

Masque indiquant quels champs de la base ParagraphStyle ont été modifiés dans cette suggestion.

ParagraphStyleSuggestionState

Masque indiquant quels champs de la base ParagraphStyle ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.

Représentation JSON
{
  "headingIdSuggested": boolean,
  "namedStyleTypeSuggested": boolean,
  "alignmentSuggested": boolean,
  "lineSpacingSuggested": boolean,
  "directionSuggested": boolean,
  "spacingModeSuggested": boolean,
  "spaceAboveSuggested": boolean,
  "spaceBelowSuggested": boolean,
  "borderBetweenSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "indentEndSuggested": boolean,
  "keepLinesTogetherSuggested": boolean,
  "keepWithNextSuggested": boolean,
  "avoidWidowAndOrphanSuggested": boolean,
  "shadingSuggestionState": {
    object (ShadingSuggestionState)
  },
  "pageBreakBeforeSuggested": boolean
}
Champs
headingIdSuggested

boolean

Indique s'il y a eu une suggestion de modification de headingId.

namedStyleTypeSuggested

boolean

Indique s'il y a eu une suggestion de modification de namedStyleType.

alignmentSuggested

boolean

Indique s'il y a eu une suggestion de modification de alignment.

lineSpacingSuggested

boolean

Indique s'il y a eu une suggestion de modification de lineSpacing.

directionSuggested

boolean

Indique s'il y a eu une suggestion de modification de direction.

spacingModeSuggested

boolean

Indique s'il y a eu une suggestion de modification de spacingMode.

spaceAboveSuggested

boolean

Indique s'il y a eu une suggestion de modification de spaceAbove.

spaceBelowSuggested

boolean

Indique s'il y a eu une suggestion de modification de spaceBelow.

borderBetweenSuggested

boolean

Indique s'il y a eu une suggestion de modification de borderBetween.

borderTopSuggested

boolean

Indique s'il y a eu une suggestion de modification de borderTop.

borderBottomSuggested

boolean

Indique s'il y a eu une suggestion de modification de borderBottom.

borderLeftSuggested

boolean

Indique s'il y a eu une suggestion de modification de borderLeft.

borderRightSuggested

boolean

Indique s'il y a eu une suggestion de modification de borderRight.

indentFirstLineSuggested

boolean

Indique s'il y a eu une suggestion de modification de indentFirstLine.

indentStartSuggested

boolean

Indique s'il y a eu une suggestion de modification de indentStart.

indentEndSuggested

boolean

Indique s'il y a eu une suggestion de modification de indentEnd.

keepLinesTogetherSuggested

boolean

Indique s'il y a eu une suggestion de modification de keepLinesTogether.

keepWithNextSuggested

boolean

Indique s'il y a eu une suggestion de modification de keepWithNext.

avoidWidowAndOrphanSuggested

boolean

Indique s'il y a eu une suggestion de modification de avoidWidowAndOrphan.

shadingSuggestionState

object (ShadingSuggestionState)

Masque indiquant les champs qui ont été modifiés dans cette suggestion dans shading.

pageBreakBeforeSuggested

boolean

Indique s'il y a eu une suggestion de modification de pageBreakBefore.

ShadingSuggestionState

Masque indiquant quels champs de la base Shading ont été modifiés dans cette suggestion de modification. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.

Représentation JSON
{
  "backgroundColorSuggested": boolean
}
Champs
backgroundColorSuggested

boolean

Indique s'il y a eu une suggestion de modification de la Shading.

Puces

Décrit une puce de paragraphe.

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

string

ID de la liste à laquelle ce paragraphe appartient.

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

Représentation JSON
{
  "bullet": {
    object (Bullet)
  },
  "bulletSuggestionState": {
    object (BulletSuggestionState)
  }
}
Champs
bullet

object (Bullet)

Bullet qui n'inclut que les modifications apportées à cette suggestion. Vous pouvez l'utiliser avec bulletSuggestionState pour identifier les champs modifiés et leurs nouvelles valeurs.

bulletSuggestionState

object (BulletSuggestionState)

Masque indiquant quels champs de la base Bullet ont été modifiés dans cette suggestion.

BulletSuggestionState

Masque indiquant quels champs de la base Bullet ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.

Représentation JSON
{
  "listIdSuggested": boolean,
  "nestingLevelSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
Champs
listIdSuggested

boolean

Indique s'il y a eu une suggestion de modification de la listId.

nestingLevelSuggested

boolean

Indique s'il y a eu une suggestion de modification de la nestingLevel.

textStyleSuggestionState

object (TextStyleSuggestionState)

Masque indiquant les champs qui ont été modifiés dans cette suggestion dans text style.

Références d'objet

Un ensemble 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 contenus ayant le même SectionStyle. Un saut de section représente le début d'une nouvelle section. Le style de section s'applique à la section qui suit le saut de section.

Le corps du document commence toujours par un saut de section.

Représentation JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "sectionStyle": {
    object (SectionStyle)
  }
}
Champs
suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu ne sera 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
}
Champs
columnProperties[]

object (SectionColumnProperties)

Propriétés des colonnes de la section.

Si ce champ est vide, la section contient une colonne avec les propriétés par défaut dans l'éditeur Docs. Vous pouvez modifier une section pour qu'elle n'ait pas plus de trois colonnes.

Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. La désactivation de cette propriété entraînera une erreur 400 de requête incorrecte.

columnSeparatorStyle

enum (ColumnSeparatorStyle)

Style des séparateurs de colonnes.

Vous pouvez définir ce style même si la section ne comporte qu'une seule colonne.

Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. La désactivation de cette propriété génère une erreur 400 "Requête incorrecte".

contentDirection

enum (ContentDirection)

Direction du contenu de cette section. Si cette règle n'est pas configurée, elle est définie par défaut sur LEFT_TO_RIGHT.

Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. La désactivation de cette propriété génère une erreur 400 "Requête incorrecte".

marginTop

object (Dimension)

Marge supérieure de la page. Si cette règle n'est pas configurée, elle est définie par défaut sur marginTop dans DocumentStyle.

Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. La désactivation de cette propriété génère une erreur 400 "Requête incorrecte".

marginBottom

object (Dimension)

Marge de la page en bas. Si cette règle n'est pas configurée, elle est définie par défaut sur marginBottom dans DocumentStyle.

Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. La désactivation de cette propriété génère une erreur 400 "Requête incorrecte".

marginRight

object (Dimension)

Marge de la page de droite de la section. Si cette règle n'est pas configurée, elle est définie par défaut sur marginRight dans DocumentStyle. Si vous modifiez la marge de droite, les colonnes de cette section seront 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. La désactivation de cette propriété génère une erreur 400 "Requête incorrecte".

marginLeft

object (Dimension)

Marge de la page sur la gauche. Si cette règle n'est pas configurée, elle est définie par défaut sur marginLeft dans DocumentStyle. Si vous modifiez la marge de gauche, les colonnes de cette section seront 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. La désactivation de cette propriété génère une erreur 400 "Requête incorrecte".

marginHeader

object (Dimension)

Marge de l'en-tête de la section. Si cette règle n'est pas configurée, elle est définie par défaut sur marginHeader dans DocumentStyle. En cas de modification, useCustomHeaderFooterMargins est défini sur "true" dans DocumentStyle. La valeur de useCustomHeaderPiedMargins 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. La désactivation de cette propriété génère une erreur 400 "Requête incorrecte".

sectionType

enum (SectionType)

Uniquement en sortie. Type de section.

defaultHeaderId

string

ID de l'en-tête par défaut. Si cette règle n'est pas configurée, la valeur hérite de l'élément "StyleStyle" SectionBreak's précédent. Si la valeur n'est pas définie dans la première section Break, elle hérite de la propriété 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 la valeur de 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 la propriété defaultHeaderId. Si cette règle n'est pas configurée, la valeur hérite de l'élément "StyleStyle" SectionBreak's précédent. Si la valeur n'est pas définie dans la première section Break, elle hérite de la propriété 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 useEvenPageHeaderFooter pour 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 sur les pages paires utilisent defaultHeaderId. Si cette règle n'est pas configurée, la valeur hérite de l'élément "StyleStyle" SectionBreak's précédent. Si la valeur n'est pas définie dans la première section Break, elle hérite de la propriété evenPageHeaderId de DocumentStyle.

Cette propriété est en lecture seule.

pageNumberStart

integer

Numéro de la page à partir de laquelle commencer à comptabiliser le nombre de pages pour cette section. Si cette règle n'est pas configurée, la numérotation des pages continue à partir de la section précédente. Si la valeur n'est pas définie dans le premier SectionBreak, reportez-vous à la pageNumberStart de DocumentStyle.

Lorsque vous mettez à jour cette propriété, vous devez définir une valeur concrète. La désactivation de cette propriété génère une erreur 400 "Requête incorrecte".

Propriétés de la section de colonne

Propriétés qui s'appliquent à la colonne d'une section.

Représentation JSON
{
  "width": {
    object (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.

ColumnSeparatorStyle

Style des séparateurs de colonnes entre les colonnes.

Enums
COLUMN_SEPARATOR_STYLE_UNSPECIFIED Style de séparateur de colonnes non spécifié.
NONE Aucune ligne de séparation entre les colonnes.
BETWEEN_EACH_COLUMN Affiche une ligne de séparation entre chaque colonne.

Type de section

Représente le positionnement de début de la section actuelle par rapport à la section précédente.

Enums
SECTION_TYPE_UNSPECIFIED Le type de section n'est pas spécifié.
CONTINUOUS La section commence immédiatement après le dernier paragraphe de la section précédente.
NEXT_PAGE La section commence sur la page suivante.

Table

StructuralElement représentant une table.

Représentation JSON
{
  "rows": integer,
  "columns": integer,
  "tableRows": [
    {
      object (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.

Un tableau peut être non rectangulaire. Certaines lignes peuvent donc avoir un nombre de cellules différent.

tableRows[]

object (TableRow)

Contenu et style de chaque ligne.

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu ne sera 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)

Le contenu et le style de chaque cellule de cette ligne.

Un tableau peut être non rectangulaire. Il est donc possible que certaines lignes comportent un nombre de cellules différent de celui des autres lignes du même tableau.

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

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

tableRowStyle

object (TableRowStyle)

Style de la ligne du tableau.

suggestedTableRowStyleChanges

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

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

TableCell

Contenu et style d'une cellule dans un élément Table.

Représentation JSON
{
  "startIndex": integer,
  "endIndex": integer,
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "suggestedTableCellStyleChanges": {
    string: {
      object (SuggestedTableCellStyle)
    },
    ...
  }
}
Champs
startIndex

integer

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

endIndex

integer

Index de fin de base 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. Une TableCell peut avoir plusieurs ID d'insertion s'il s'agit d'une suggestion de modification imbriquée. Si ce champ est vide, il ne s'agit pas d'une suggestion d'insertion.

suggestedDeletionIds[]

string

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

suggestedTableCellStyleChanges

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

Modifications suggérées du style des cellules du tableau, associées à l'ID de la suggestion.

Style de cellule

Style d'une propriété TableCell.

Les styles de cellules de tableau hérités sont représentés par des champs non définis dans ce message. Un style de cellule de tableau peut hériter du style de la table.

Représentation JSON
{
  "rowSpan": integer,
  "columnSpan": integer,
  "backgroundColor": {
    object (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 la cellule.

Cette propriété est en lecture seule.

columnSpan

integer

L'étendue de colonnes 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 de la cellule du tableau. L'alignement par défaut correspond à celui des cellules de tableau nouvellement créées dans l'éditeur Docs.

Bordure TableCellBorder

Bordure autour d'une cellule du tableau

Les bordures de cellules du tableau ne peuvent pas être transparentes. Pour masquer la bordure d'une cellule du tableau, définissez la largeur sur 0.

Représentation JSON
{
  "color": {
    object (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'alignement de contenu.

Dérivé d'un sous-ensemble des valeurs du type simple "ST_TextAnchoringType" de la section 20.1.10.59 de la section "Formats de fichiers XML Office ouverts – Principes de base et langage de balisage", partie 1 de la quatrième édition ECMA-376.

Enums
CONTENT_ALIGNMENT_UNSPECIFIED Un alignement de contenu non spécifié. L'alignement de contenu est hérité de l'élément parent, le cas échéant.
CONTENT_ALIGNMENT_UNSUPPORTED Un alignement de contenu non accepté.
TOP Un alignement qui aligne le contenu sur le haut du conteneur Correspond à ECMA-376 ST_TextAnchoringType 't'.
MIDDLE Un alignement qui aligne le contenu au milieu du conteneur. Correspond à ECMA-376 ST_TextAnchoringType 'ctr'.
BOTTOM Alignement qui aligne le contenu sur le bas du conteneur. Correspond à ECMA-376 ST_TextAnchoringType "b".

Style de cellule suggéré

Suggestion de modification d'un TableCellStyle.

Représentation JSON
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "tableCellStyleSuggestionState": {
    object (TableCellStyleSuggestionState)
  }
}
Champs
tableCellStyle

object (TableCellStyle)

TableCellStyle qui n'inclut que les modifications apportées à cette suggestion. Vous pouvez l'utiliser avec tableCellStyleSuggestionState pour identifier les champs modifiés et leurs nouvelles valeurs.

tableCellStyleSuggestionState

object (TableCellStyleSuggestionState)

Masque indiquant quels champs de la base TableCellStyle ont été modifiés dans cette suggestion.

TableCellStyleSuggestionState

Masque indiquant quels champs de la base TableCellStyle ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.

Représentation JSON
{
  "rowSpanSuggested": boolean,
  "columnSpanSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "paddingLeftSuggested": boolean,
  "paddingRightSuggested": boolean,
  "paddingTopSuggested": boolean,
  "paddingBottomSuggested": boolean,
  "contentAlignmentSuggested": boolean
}
Champs
rowSpanSuggested

boolean

Indique s'il y a eu une suggestion de modification de rowSpan.

columnSpanSuggested

boolean

Indique s'il y a eu une suggestion de modification de columnSpan.

backgroundColorSuggested

boolean

Indique s'il y a eu une suggestion de modification de backgroundColor.

borderLeftSuggested

boolean

Indique s'il y a eu une suggestion de modification de borderLeft.

borderRightSuggested

boolean

Indique s'il y a eu une suggestion de modification de borderRight.

borderTopSuggested

boolean

Indique s'il y a eu une suggestion de modification de borderTop.

borderBottomSuggested

boolean

Indique s'il y a eu une suggestion de modification de borderBottom.

paddingLeftSuggested

boolean

Indique s'il y a eu une suggestion de modification de paddingLeft.

paddingRightSuggested

boolean

Indique s'il y a eu une suggestion de modification de paddingRight.

paddingTopSuggested

boolean

Indique s'il y a eu une suggestion de modification de paddingTop.

paddingBottomSuggested

boolean

Indique s'il y a eu une suggestion de modification de paddingBottom.

contentAlignmentSuggested

boolean

Indique s'il y a eu une suggestion de modification de contentAlignment.

TableRowStyle

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 ligne sera affichée dans l'éditeur Docs à une hauteur supérieure ou égale à cette valeur afin d'afficher tout le contenu des cellules de la ligne.

tableHeader

boolean

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

preventOverflow

boolean

Indique si la ligne ne peut pas dépasser par-delà les limites des pages ou des colonnes.

Style de ligne de table suggéré

Suggestion de modification d'un TableRowStyle.

Représentation JSON
{
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "tableRowStyleSuggestionState": {
    object (TableRowStyleSuggestionState)
  }
}
Champs
tableRowStyle

object (TableRowStyle)

TableRowStyle qui n'inclut que les modifications apportées à cette suggestion. Vous pouvez l'utiliser avec tableRowStyleSuggestionState pour identifier les champs modifiés et leurs nouvelles valeurs.

tableRowStyleSuggestionState

object (TableRowStyleSuggestionState)

Masque indiquant quels champs de la base TableRowStyle ont été modifiés dans cette suggestion.

TableRowStyleSuggestionState

Masque indiquant quels champs de la base TableRowStyle ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.

Représentation JSON
{
  "minRowHeightSuggested": boolean
}
Champs
minRowHeightSuggested

boolean

Indique s'il y a eu une suggestion de modification de 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 les lignes contiennent des cellules, comme le code HTML. Les propriétés d'une ligne se trouvent donc dans le tableRowStyle de la ligne.

TableColumnProperties

Propriétés d'une colonne dans une table.

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 cet attribut lorsque le paramètre 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éparties uniformément entre les autres colonnes uniformément réparties.

La largeur de la colonne est automatiquement déterminée et une part égale à celle du tableau reste égale après la prise en compte de toutes les colonnes avec des largeurs spécifiées.

FIXED_WIDTH Largeur de colonne fixe. La propriété [width][google.apps.docs.v1.TableColumnProperties.width contient la largeur de la colonne.

Table des matières

StructuralElement représentant une table des matières.

Représentation JSON
{
  "content": [
    {
      object (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 TableOfContents peut avoir plusieurs ID d'insertion s'il s'agit d'une suggestion de modification imbriquée. Si ce champ est vide, il ne s'agit pas d'une suggestion d'insertion.

suggestedDeletionIds[]

string

ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de ce contenu ne sera 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
}
Champs
background

object (Background)

L'arrière-plan du document La couleur d'arrière-plan des documents ne peut pas être transparente.

defaultHeaderId

string

ID de l'en-tête par défaut. Si cette règle n'est pas configurée, il n'existe pas d'en-tête par défaut.

Cette propriété est en lecture seule.

evenPageHeaderId

string

ID de l'en-tête utilisé uniquement pour les pages paires. La valeur de useEvenPageHeaderFooter détermine si la valeur defaultHeaderId doit être utilisée ou l'en-tête sur des 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 règle n'est pas configurée, il n'existe pas d'en-tête unique pour la première page. La valeur de useFirstPageHeaderFooter détermine si defaultHeaderId doit être utilisé ou non pour l'en-tête de la première page. Si ce paramètre n'est pas défini, il n'y a pas d'en-tête de la première page.

Cette propriété est en lecture seule.

pageNumberStart

integer

Numéro de la page à partir de laquelle commencer à comptabiliser le nombre de pages.

marginTop

object (Dimension)

Marge de la page supérieure.

Si vous modifiez la marge supérieure de la page sur le style du document, elle sera effacée sur tous les styles de section.

marginBottom

object (Dimension)

Marge de la page inférieure.

Si vous modifiez la marge inférieure de la page sur le style du document, elle sera effacée sur tous les styles de section.

marginRight

object (Dimension)

Marge de la page de droite.

Si vous modifiez la marge droite de la page dans le style du document, elle sera effacée sur tous les styles de section. Cela peut également entraîner le redimensionnement des colonnes dans toutes les sections.

marginLeft

object (Dimension)

Marge de la page de gauche.

Si vous modifiez la marge de gauche de la page sur le style du document, elle sera effacée sur tous les styles de section. Cela peut également entraîner le redimensionnement des colonnes dans toutes les sections.

pageSize

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.

Contexte

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

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

object (OptionalColor)

Couleur d'arrière-plan.

Taille

Largeur et 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.

SuggestionDocumentStyle

Une suggestion de modification de la DocumentStyle.

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

object (DocumentStyle)

DocumentStyle qui n'inclut que les modifications apportées à cette suggestion. Vous pouvez l'utiliser avec documentStyleSuggestionState pour identifier les champs modifiés et leurs nouvelles valeurs.

documentStyleSuggestionState

object (DocumentStyleSuggestionState)

Masque indiquant quels champs de la base DocumentStyle ont été modifiés dans cette suggestion.

DocumentStyleSuggestionState

Masque indiquant quels champs de la base DocumentStyle ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.

Représentation JSON
{
  "backgroundSuggestionState": {
    object (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
}
Champs
backgroundSuggestionState

object (BackgroundSuggestionState)

Masque indiquant les champs qui ont été modifiés dans cette suggestion dans background.

defaultHeaderIdSuggested

boolean

Indique s'il y a eu une suggestion de modification de defaultHeaderId.

evenPageHeaderIdSuggested

boolean

Indique s'il y a eu une suggestion de modification de evenPageHeaderId.

firstPageHeaderIdSuggested

boolean

Indique s'il y a eu une suggestion de modification de firstPageHeaderId.

pageNumberStartSuggested

boolean

Indique s'il y a eu une suggestion de modification de pageNumberStart.

marginTopSuggested

boolean

Indique s'il y a eu une suggestion de modification de marginTop.

marginBottomSuggested

boolean

Indique s'il y a eu une suggestion de modification de marginBottom.

marginRightSuggested

boolean

Indique s'il y a eu une suggestion de modification de marginRight.

marginLeftSuggested

boolean

Indique s'il y a eu une suggestion de modification de marginLeft.

pageSizeSuggestionState

object (SizeSuggestionState)

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

marginHeaderSuggested

boolean

Indique s'il y a eu une suggestion de modification de marginHeader.

SuggestionSuggestionState

Masque indiquant quels champs de la base Background ont été modifiés dans cette suggestion. Pour tout champ défini sur "true", Backgound a une nouvelle valeur suggérée.

Représentation JSON
{
  "backgroundColorSuggested": boolean
}
Champs
backgroundColorSuggested

boolean

Indique si la couleur d'arrière-plan actuelle a été modifiée dans cette suggestion.

SizeSuggestionState

Masque indiquant quels champs de la base Size ont été modifiés dans cette suggestion. Pour tout champ défini sur "true", Size a une nouvelle valeur suggérée.

Représentation JSON
{
  "heightSuggested": boolean,
  "widthSuggested": boolean
}
Champs
heightSuggested

boolean

Indique s'il y a eu une suggestion de modification de height.

widthSuggested

boolean

Indique s'il y a eu une suggestion de modification de width.

Styles nommés

Styles nommés Les paragraphes du document peuvent hériter des éléments TextStyle et ParagraphStyle de ces styles nommés.

Représentation JSON
{
  "styles": [
    {
      object (NamedStyle)
    }
  ]
}
Champs
styles[]

object (NamedStyle)

Styles nommés

Il existe une entrée pour chaque named style types possible.

StyleNommé

Style nommé. Les paragraphes du document peuvent hériter des TextStyle et ParagraphStyle de ce style nommé lorsqu'ils ont le même type de style nommé.

Représentation JSON
{
  "namedStyleType": enum (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é.

Suggestions de styles

Une suggestion de modification de la NamedStyles.

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

object (NamedStyles)

NamedStyles qui n'inclut que les modifications apportées à cette suggestion. Vous pouvez l'utiliser avec namedStylesSuggestionState pour identifier les champs modifiés et leurs nouvelles valeurs.

namedStylesSuggestionState

object (NamedStylesSuggestionState)

Masque indiquant quels champs de la base NamedStyles ont été modifiés dans cette suggestion.

Suggestion de styles nommés

État de suggestion d'un message NamedStyles.

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

object (NamedStyleSuggestionState)

Masque indiquant les champs de l'élément NamedStyle correspondant dans styles qui ont été modifiés dans cette suggestion.

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

Suggestion de style du nom

É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 l'NamedStyle correspondant.

textStyleSuggestionState

object (TextStyleSuggestionState)

Masque indiquant les champs qui ont été modifiés dans cette suggestion dans text style.

paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

Masque indiquant les champs qui ont été modifiés dans cette suggestion dans paragraph style.

Liste

Une liste représente les attributs de liste d'un groupe de paragraphes qui appartiennent tous à la même liste. Un paragraphe qui fait partie d'une liste fait référence à l'identifiant de la liste dans sa bullet.

Représentation JSON
{
  "listProperties": {
    object (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 des propriétés de la liste, associées à l'ID de la suggestion.

suggestedInsertionId

string

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

suggestedDeletionIds[]

string

ID de suppression suggérés. Si ce champ est vide, aucune suggestion de suppression de cette liste ne sera proposée.

Propriétés de la liste

Propriétés d'une list qui décrivent l'apparence des puces d'un paragraphe associé à une liste.

Représentation JSON
{
  "nestingLevels": [
    {
      object (NestingLevel)
    }
  ]
}
Champs
nestingLevels[]

object (NestingLevel)

Décrit les propriétés des puces au niveau associé.

Une liste peut comporter jusqu'à neuf niveaux d'imbrication. Le niveau d'imbrication 0 correspond au niveau le plus élevé et le niveau d'imbrication 8 au niveau le plus imbriqué. Les niveaux d'imbrication sont renvoyés par ordre croissant, les moins imbriqués étant renvoyés en premier.

Niveau d'imbrication

Contient des propriétés décrivant l'apparence d'une liste à un niveau d'imbrication donné.

Représentation JSON
{
  "bulletAlignment": enum (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 prévu pour l'affichage de la puce.

glyphFormat

string

Chaîne de format utilisée par les puces à ce niveau d'imbrication.

Le format du glyphe contient un ou plusieurs espaces réservés, qui sont remplacés par les valeurs appropriées en fonction de glyphType ou 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 schéma <prefix>%[nestingLevel]<suffix>. Notez que le préfixe et le suffixe sont facultatifs et peuvent être des chaînes arbitraires.

Par exemple, le format du 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 avec un type de glyphe de UPPER_ALPHA et un format de glyphe de %0. au niveau d'imbrication 0 se traduira par une liste de glyphes affichés.

A.

B.

C.

Le format de glyphe peut contenir des espaces réservés pour le niveau d'imbrication actuel, ainsi que des espaces réservés pour les niveaux d'imbrication parents. Par exemple, une liste peut avoir le format de glyphe %0. au niveau d'imbrication 0 et le format de glyphe %0.%1. au niveau d'imbrication 1. Si les deux niveaux d'imbrication contiennent DECIMAL types de glyphes, une liste de glyphes affichés s'affichera

1.

2.

2.1.

2.2.

3.

Pour les niveaux d'imbrication ordonnés, la chaîne qui remplace un espace réservé au format glyphe pour un paragraphe particulier dépend de l'ordre du paragraphe dans la liste.

indentFirstLine

object (Dimension)

Niveau 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é sur le 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

Nombre du premier élément de la liste à ce niveau d'imbrication.

La valeur 0 correspond à 1 pour les listes numérotées et les listes de chiffres romains. Pour les valeurs à la fois 0 et 1, les listes de lettres et les chiffres romains commenceront à a et à i, respectivement.

Cette valeur est ignorée pour les niveaux d'imbrication comportant des glyphes non ordonnés.

Champ d'union glyph_kind. Genre de glyphe utilisé par les puces. Ce code définit le glyphe à puces qui remplace les espaces réservés dans glyph_format. La glyph_kind ne peut être qu'un des éléments suivants :
glyphType

enum (GlyphType)

Type de glyphe utilisé par les puces lorsque les paragraphes de ce niveau d'imbrication sont classés.

Le type de glyphe détermine le type de glyphe utilisé pour remplacer les espaces réservés dans 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 du glyphe est DECIMAL, le glyphe affiché remplacera l'espace réservé %0 au format du glyphe par un nombre correspondant à l'ordre de l'élément dans la liste.

glyphSymbol

string

Symbole de glyphe personnalisé utilisé par les puces lorsque les paragraphes de ce niveau d'imbrication ne sont pas ordonnés.

Le symbole glyphe remplace les espaces réservés dans glyphFormat. Par exemple, si le glyphSymbole est le cercle plein correspondant au point de code Unicode U+25cf et que glyphFormat est %0, le glyphe affiché sera le cercle plein.

Alignement

Types d'alignement d'une puce.

Enums
BULLET_ALIGNMENT_UNSPECIFIED L'alignement de la puce n'est pas spécifié.
START La puce correspond au début de l'espace alloué à l'affichage de la puce. Aligné à gauche pour le texte de gauche à droite, sinon aligné à droite.
CENTER La puce est alignée au centre de l'espace alloué à son affichage.
END La puce est alignée à la fin de l'espace prévu pour le rendu. Aligné à droite pour le texte de gauche à droite, ou à gauche dans le cas contraire.

Glyphe

Types de glyphes utilisés par les puces lorsque les paragraphes à ce niveau d'imbrication sont ordonnés.

Enums
GLYPH_TYPE_UNSPECIFIED Le type de glyphe n'est pas spécifié ou n'est pas compatible.
NONE Chaîne vide.
DECIMAL Un nombre tel que 1, 2 ou 3
ZERO_DECIMAL Nombre contenant un numéro à un chiffre précédé d'un zéro, tel que 01, 02 ou 03. Les nombres comportant plusieurs chiffres ne sont pas précédés d'un zéro.
UPPER_ALPHA Une lettre majuscule, comme A, B ou C.
ALPHA Une lettre minuscule, comme a, b ou c.
UPPER_ROMAN Un chiffre romain majuscule, comme I, II ou III.
ROMAN Un chiffre romain minuscule, tel que i, ii ou iii.

Suggestions de propriétés de liste

Suggestion de modification : ListProperties.

Représentation JSON
{
  "listProperties": {
    object (ListProperties)
  },
  "listPropertiesSuggestionState": {
    object (ListPropertiesSuggestionState)
  }
}
Champs
listProperties

object (ListProperties)

ListProperties qui n'inclut que les modifications apportées à cette suggestion. Vous pouvez l'utiliser avec listPropertiesSuggestionState pour identifier les champs modifiés et leurs nouvelles valeurs.

listPropertiesSuggestionState

object (ListPropertiesSuggestionState)

Masque indiquant quels champs de la base ListProperties ont été modifiés dans cette suggestion.

ListPropertiesSuggestionState

Masque indiquant quels champs de la base ListProperties ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.

Représentation JSON
{
  "nestingLevelsSuggestionStates": [
    {
      object (NestingLevelSuggestionState)
    }
  ]
}
Champs
nestingLevelsSuggestionStates[]

object (NestingLevelSuggestionState)

Masque indiquant les champs de l'élément NestingLevel correspondant dans nestingLevels qui ont été modifiés dans cette suggestion.

Les états de suggestion de niveau d'imbrication sont renvoyés par ordre croissant du niveau d'imbrication, le moins imbriqué étant renvoyé en premier.

Suggestion de niveau d'imbrication

Masque indiquant quels champs de la base NestingLevel ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.

Représentation JSON
{
  "bulletAlignmentSuggested": boolean,
  "glyphTypeSuggested": boolean,
  "glyphFormatSuggested": boolean,
  "glyphSymbolSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "startNumberSuggested": boolean
}
Champs
bulletAlignmentSuggested

boolean

Indique s'il y a eu une suggestion de modification de bulletAlignment.

glyphTypeSuggested

boolean

Indique s'il y a eu une suggestion de modification de glyphType.

glyphFormatSuggested

boolean

Indique s'il y a eu une suggestion de modification de glyphFormat.

glyphSymbolSuggested

boolean

Indique s'il y a eu une suggestion de modification de glyphSymbol.

indentFirstLineSuggested

boolean

Indique s'il y a eu une suggestion de modification de indentFirstLine.

indentStartSuggested

boolean

Indique s'il y a eu une suggestion de modification de indentStart.

textStyleSuggestionState

object (TextStyleSuggestionState)

Masque indiquant les champs qui ont été modifiés dans cette suggestion dans text style.

startNumberSuggested

boolean

Indique s'il y a eu une suggestion de modification de startNumber.

Plages nommées

Collection de tous les NamedRange du document portant un nom donné.

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

string

Nom partagé par tous les named ranges.

namedRanges[]

object (NamedRange)

NamedRanges portant le même nom.

Plage nommée

Collection de Range comportant le même ID de plage nommé.

Les plages nommées permettent aux développeurs d'associer des parties d'un document à un libellé défini par l'utilisateur de manière arbitraire. Ainsi, leur contenu peut être lu ou modifié par programmation ultérieurement. Un document peut contenir plusieurs plages nommées portant le même nom, mais chaque plage nommée possède un identifiant unique.

Une plage nommée est créée avec une seule valeur Range, et le contenu inséré dans une plage nommée la développe généralement. Cependant, certaines modifications du document peuvent entraîner sa division en plusieurs plages.

Les plages nommées ne sont pas privées. Toutes les applications et tous les collaborateurs qui ont accès au document peuvent voir ses plages nommées.

Représentation JSON
{
  "namedRangeId": string,
  "name": string,
  "ranges": [
    {
      object (Range)
    }
  ]
}
Champs
namedRangeId

string

Identifiant 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 lesquels se trouve cette plage. Un ID de segment vide correspond au corps du document.

startIndex

integer

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

Dans toutes les utilisations actuelles, un index de départ doit être fourni. Ce champ est une valeur Int32 afin de répondre aux futurs cas d'utilisation avec des plages ouvertes.

endIndex

integer

Index de fin basé sur zéro de cette plage, exclusif dans les unités de code UTF-16.

Dans toutes les utilisations actuelles, un index final doit être fourni. Ce champ est une valeur Int32 afin de répondre aux futurs cas d'utilisation avec des plages ouvertes.

Mode VueVue

Mode d'affichage des suggestions appliqué au document, qui indique la façon dont les modifications suggérées sont représentées. Elle permet de lire le document avec toutes les suggestions intégrées, acceptées ou refusées.

Enums
DEFAULT_FOR_CURRENT_ACCESS Le mode d'affichage des suggestions appliqué au document renvoyé dépend du niveau d'accès actuel de l'utilisateur. Si l'utilisateur dispose uniquement d'un accès en lecture, PREVIEW_WITHOUT_SUGGESTIONS est appliqué. Sinon, SUGGESTIONS_INLINE est appliqué. Il s'agit du mode d'affichage des suggestions par défaut.
SUGGESTIONS_INLINE

Le document renvoyé contient des suggestions intégrées. Les modifications proposées diffèrent du contenu de base du document.

Les requêtes permettant de récupérer un document à l'aide de ce mode renvoient une erreur 403 si l'utilisateur n'est pas autorisé à afficher les modifications suggérées.

PREVIEW_SUGGESTIONS_ACCEPTED

Le document renvoyé est un aperçu. Toutes les suggestions de modifications sont acceptées.

Les requêtes permettant de récupérer un document à l'aide de ce mode renvoient une erreur 403 si l'utilisateur n'est pas autorisé à afficher les modifications suggérées.

PREVIEW_WITHOUT_SUGGESTIONS Le document renvoyé contient un aperçu. Toutes les suggestions de modifications sont refusées si le document en contient.

Objet intégré

Objet qui apparaît en ligne. Un objet InlineObject contient un élément EmbeddedObject tel qu'une image.

Représentation JSON
{
  "objectId": string,
  "inlineObjectProperties": {
    object (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 des propriétés d'objet intégrées, associées à un ID de suggestion.

suggestedInsertionId

string

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

suggestedDeletionIds[]

string

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

InlineObjectProperties

Propriétés d'une InlineObject.

Représentation JSON
{
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
Champs
embeddedObject

object (EmbeddedObject)

Objet intégré de cet objet intégré.

Objet intégré

Objet intégré dans le document.

Représentation JSON
{
  "title": string,
  "description": string,
  "embeddedObjectBorder": {
    object (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 valeurs title et description sont combinées pour afficher le texte alternatif.

description

string

Description de l'objet intégré. Les valeurs title et description sont combinées pour afficher le 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 source externe associé. Par exemple, il contient une référence au graphique Google Sheets source lorsque l'objet intégré est un graphique lié.

Si cette règle n'est pas configurée, l'objet intégré n'est pas associé.

Champ d'union properties. Propriétés spécifiques à chaque type d'objet intégré properties ne peut être qu'un des éléments suivants :
embeddedDrawingProperties

object (EmbeddedDrawingProperties)

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

imageProperties

object (ImageProperties)

Propriétés d'une image.

EmbeddedDrawingProperties

Propriétés d'un dessin intégré permettant de différencier le type d'objet. Un dessin intégré est un dessin créé et modifié dans un document. Notez que les informations détaillées ne sont pas acceptées.

ImageProperties

Propriétés d'une image.

Représentation JSON
{
  "contentUri": string,
  "sourceUri": string,
  "brightness": number,
  "contrast": number,
  "transparency": number,
  "cropProperties": {
    object (CropProperties)
  },
  "angle": number
}
Champs
contentUri

string

URI de l'image avec une durée de vie par défaut de 30 minutes. Cet URI est tagué avec le compte du demandeur. Toute personne disposant de l'URI accède efficacement à l'image en tant que demandeur initial. Si les paramètres de partage du document changent, vous risquez de perdre l'accès à l'image.

sourceUri

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 être comprise dans l'intervalle [-1,0, 1,0], où 0 correspond à "aucun effet".

contrast

number

Effet de contraste de l'image. La valeur doit être comprise dans l'intervalle [-1,0, 1,0], où 0 correspond à "aucun effet".

transparency

number

Effet de transparence de l'image. La valeur doit être comprise dans l'intervalle [0,0, 1,0], où 0 correspond à "Aucun effet" et 1 à "Transparence".

cropProperties

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 du cadrage

Propriétés de recadrage d'une image.

Le rectangle de recadrage est représenté par des décalages fractionnés par rapport aux quatre bords du contenu d'origine.

  • Si le décalage est dans l'intervalle (0, 1), le bord correspondant du rectangle de recadrage est positionné dans le rectangle de délimitation d'origine de l'image.
  • Si le décalage est négatif ou supérieur à 1, le bord correspondant du rectangle de recadrage est placé en dehors du rectangle de délimitation d'origine de l'image.
  • Si tous les décalages et l'angle de rotation sont définis sur 0, l'image n'est pas recadrée.
Représentation JSON
{
  "offsetLeft": number,
  "offsetRight": number,
  "offsetTop": number,
  "offsetBottom": number,
  "angle": number
}
Champs
offsetLeft

number

Le décalage indique la distance entre le bord gauche du rectangle de recadrage et le bord gauche du contenu original, par rapport à la largeur du contenu original.

offsetRight

number

Le décalage indique la distance entre le bord droit du rectangle de recadrage et le bord droit du contenu d'origine, par rapport à la largeur du contenu d'origine.

offsetTop

number

Le décalage indique la distance entre le bord supérieur du rectangle de recadrage et le bord supérieur du contenu d'origine, par rapport à la hauteur du contenu original.

offsetBottom

number

Le décalage indique la distance entre le bord inférieur du rectangle de recadrage et le bord inférieur du contenu d'origine, par rapport à la hauteur du contenu original.

angle

number

Angle de rotation du rectangle de recadrage autour de son centre, en radians. La rotation est appliquée après les décalages.

EmbeddedObjectBorder

Bordure autour d'un EmbeddedObject

Représentation JSON
{
  "color": {
    object (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é "bordure".

état de la propriété

États possibles d'une propriété.

Enums
RENDERED Si l'état d'une propriété est RENDERED, l'élément possède la propriété correspondante lorsqu'il est affiché dans le document. Il s'agit de la valeur par défaut.
NOT_RENDERED Si l'état d'une propriété est NOT_RENDERED, l'élément ne possède pas la propriété correspondante lorsqu'il est affiché dans le document.

LinkedContentReference

Référence au contenu source externe associé.

Représentation JSON
{

  // Union field 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 associé. reference ne peut être qu'un des éléments suivants :
sheetsChartReference

object (SheetsChartReference)

Référence au graphique associé.

SheetsChartReference

Référence à un graphique associé intégré à partir de Google Sheets.

Représentation JSON
{
  "spreadsheetId": string,
  "chartId": integer
}
Champs
spreadsheetId

string

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

chartId

integer

ID du graphique spécifique intégré à la feuille de calcul Google Sheets.

SuggestedInlineObjectProperties

Suggestion de modification : 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 inlineObjectPropertiesSuggestionState pour identifier les champs modifiés et leurs nouvelles valeurs.

inlineObjectPropertiesSuggestionState

object (InlineObjectPropertiesSuggestionState)

Masque indiquant quels champs de la base InlineObjectProperties ont été modifiés dans cette suggestion.

InlineObjectPropertiesSuggestionState

Masque indiquant quels champs de la base InlineObjectProperties ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.

Représentation JSON
{
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
Champs
embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

Masque indiquant les champs qui ont été modifiés dans cette suggestion dans embeddedObject.

EmbeddedObjectSuggestionState

Masque indiquant quels champs de la base EmbeddedObject ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.

Représentation JSON
{
  "embeddedDrawingPropertiesSuggestionState": {
    object (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 indiquant les champs qui ont été modifiés dans cette suggestion dans embeddedDrawingProperties.

imagePropertiesSuggestionState

object (ImagePropertiesSuggestionState)

Masque indiquant les champs qui ont été modifiés dans cette suggestion dans imageProperties.

titleSuggested

boolean

Indique s'il y a eu une suggestion de modification de title.

descriptionSuggested

boolean

Indique s'il y a eu une suggestion de modification de description.

embeddedObjectBorderSuggestionState

object (EmbeddedObjectBorderSuggestionState)

Masque indiquant les champs qui ont été modifiés dans cette suggestion dans embeddedObjectBorder.

sizeSuggestionState

object (SizeSuggestionState)

Masque indiquant les champs qui ont été modifiés dans cette suggestion dans size.

marginLeftSuggested

boolean

Indique s'il y a eu une suggestion de modification de marginLeft.

marginRightSuggested

boolean

Indique s'il y a eu une suggestion de modification de marginRight.

marginTopSuggested

boolean

Indique s'il y a eu une suggestion de modification de marginTop.

marginBottomSuggested

boolean

Indique s'il y a eu une suggestion de modification de marginBottom.

linkedContentReferenceSuggestionState

object (LinkedContentReferenceSuggestionState)

Masque indiquant les champs qui ont été modifiés dans cette suggestion dans linkedContentReference.

EmbeddedDrawingPropertiesSuggestionState

Masque indiquant quels champs de la base EmbeddedDrawingProperties ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.

ImagePropertiesSuggestionState

Masque indiquant quels champs de la base ImageProperties ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.

Représentation JSON
{
  "contentUriSuggested": boolean,
  "sourceUriSuggested": boolean,
  "brightnessSuggested": boolean,
  "contrastSuggested": boolean,
  "transparencySuggested": boolean,
  "cropPropertiesSuggestionState": {
    object (CropPropertiesSuggestionState)
  },
  "angleSuggested": boolean
}
Champs
contentUriSuggested

boolean

Indique s'il y a eu une suggestion de modification de contentUri.

sourceUriSuggested

boolean

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

brightnessSuggested

boolean

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

contrastSuggested

boolean

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

transparencySuggested

boolean

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

cropPropertiesSuggestionState

object (CropPropertiesSuggestionState)

Masque indiquant les champs qui ont été modifiés dans cette suggestion dans cropProperties.

angleSuggested

boolean

Indique s'il y a eu une modification suggérée pour [angle] [google.apps.docs.v1.EmbeddedObject.angle].

État des suggestions de recadrage

Masque indiquant quels champs de la base CropProperties ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.

Représentation JSON
{
  "offsetLeftSuggested": boolean,
  "offsetRightSuggested": boolean,
  "offsetTopSuggested": boolean,
  "offsetBottomSuggested": boolean,
  "angleSuggested": boolean
}
Champs
offsetLeftSuggested

boolean

Indique s'il y a eu une suggestion de modification de offsetLeft.

offsetRightSuggested

boolean

Indique s'il y a eu une suggestion de modification de offsetRight.

offsetTopSuggested

boolean

Indique s'il y a eu une suggestion de modification de offsetTop.

offsetBottomSuggested

boolean

Indique s'il y a eu une suggestion de modification de offsetBottom.

angleSuggested

boolean

Indique s'il y a eu une suggestion de modification de angle.

EmbeddedObjectBorderState

Masque indiquant quels champs de la base EmbeddedObjectBorder ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.

Représentation JSON
{
  "colorSuggested": boolean,
  "widthSuggested": boolean,
  "dashStyleSuggested": boolean,
  "propertyStateSuggested": boolean
}
Champs
colorSuggested

boolean

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

widthSuggested

boolean

Indique s'il y a eu une modification suggérée pour [width] [google.apps.docs.v1.EmbeddedBorderObject.width].

dashStyleSuggested

boolean

Indique s'il y a eu une modification suggérée pour le [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style].

propertyStateSuggested

boolean

Indique s'il y a eu une modification suggérée pour [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state].

LinkedContentReferenceSuggestionState

Masque indiquant quels champs de la base LinkedContentReference ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.

Représentation JSON
{
  "sheetsChartReferenceSuggestionState": {
    object (SheetsChartReferenceSuggestionState)
  }
}
Champs
sheetsChartReferenceSuggestionState

object (SheetsChartReferenceSuggestionState)

Masque indiquant les champs qui ont été modifiés dans cette suggestion dans sheetsChartReference.

SheetsChartReferenceSuggestionState

Masque indiquant quels champs de la base SheetsChartReference ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.

Représentation JSON
{
  "spreadsheetIdSuggested": boolean,
  "chartIdSuggested": boolean
}
Champs
spreadsheetIdSuggested

boolean

Indique s'il y a eu une suggestion de modification de spreadsheetId.

chartIdSuggested

boolean

Indique s'il y a eu une suggestion de modification de chartId.

Objet positionné

Objet limité à un Paragraph et positionné par rapport au début du paragraphe. Un objet PositionedObject contient un élément EmbeddedObject tel qu'une image.

Représentation JSON
{
  "objectId": string,
  "positionedObjectProperties": {
    object (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 des propriétés d'objets positionnées, 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 suggestion d'insertion.

suggestedDeletionIds[]

string

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

PositionedObjectProperties

Propriétés d'un PositionedObject.

Représentation JSON
{
  "positioning": {
    object (PositionedObjectPositioning)
  },
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
Champs
positioning

object (PositionedObjectPositioning)

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

embeddedObject

object (EmbeddedObject)

Objet intégré de cet objet positionné.

PositionedObjectPositioning

Positionnement d'un PositionedObject. L'objet positionné est positionné par rapport au début du Paragraph auquel il est partagé.

Représentation JSON
{
  "layout": enum (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 partagé. Le positionnement exact de l'objet peut dépendre d'autres contenus 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 partagé. Le positionnement exact de l'objet peut dépendre d'autres contenus 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'encapsule autour de l'objet positionné.
BREAK_LEFT Divise le texte de sorte que l'objet positionné se trouve à gauche et que le texte se trouve à droite.
BREAK_RIGHT Divise le texte de sorte que l'objet positionné se trouve à droite et le texte à gauche.
BREAK_LEFT_RIGHT Divise le texte de sorte qu'il n'y ait aucun texte à gauche ou à droite de l'objet positionné.
IN_FRONT_OF_TEXT L'objet positionné se trouve devant le texte.
BEHIND_TEXT L'objet positionné se trouve derrière le texte.

SuggestionsPositionedObjectProperties

Suggestion de modification : PositionedObjectProperties.

Représentation JSON
{
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "positionedObjectPropertiesSuggestionState": {
    object (PositionedObjectPropertiesSuggestionState)
  }
}
Champs
positionedObjectProperties

object (PositionedObjectProperties)

PositionedObjectProperties qui n'inclut que les modifications apportées à cette suggestion. Vous pouvez l'utiliser avec positionedObjectPropertiesSuggestionState pour identifier les champs modifiés et leurs nouvelles valeurs.

positionedObjectPropertiesSuggestionState

object (PositionedObjectPropertiesSuggestionState)

Masque indiquant quels champs de la base PositionedObjectProperties ont été modifiés dans cette suggestion.

PositionedObjectPropertiesSuggestionState

Masque indiquant quels champs de la base PositionedObjectProperties ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.

Représentation JSON
{
  "positioningSuggestionState": {
    object (PositionedObjectPositioningSuggestionState)
  },
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
Champs
positioningSuggestionState

object (PositionedObjectPositioningSuggestionState)

Masque indiquant les champs qui ont été modifiés dans cette suggestion dans positioning.

embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

Masque indiquant les champs qui ont été modifiés dans cette suggestion dans embeddedObject.

PositionedObjectPositioningSuggestionState

Masque indiquant quels champs de la base PositionedObjectPositioning ont été modifiés dans cette suggestion. Pour chaque champ défini sur "true", une nouvelle valeur est suggérée.

Représentation JSON
{
  "layoutSuggested": boolean,
  "leftOffsetSuggested": boolean,
  "topOffsetSuggested": boolean
}
Champs
layoutSuggested

boolean

Indique s'il y a eu une suggestion de modification de layout.

leftOffsetSuggested

boolean

Indique s'il y a eu une suggestion de modification de leftOffset.

topOffsetSuggested

boolean

Indique s'il y a eu une suggestion de modification de topOffset.

Méthodes

batchUpdate

Applique une ou plusieurs mises à jour du document.

create

Crée un document vierge à l'aide du titre indiqué dans la requête.

get

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