Cells

CellData

Données sur une cellule spécifique.

Représentation JSON
{
  "userEnteredValue": {
    object (ExtendedValue)
  },
  "effectiveValue": {
    object (ExtendedValue)
  },
  "formattedValue": string,
  "userEnteredFormat": {
    object (CellFormat)
  },
  "effectiveFormat": {
    object (CellFormat)
  },
  "hyperlink": string,
  "note": string,
  "textFormatRuns": [
    {
      object (TextFormatRun)
    }
  ],
  "dataValidation": {
    object (DataValidationRule)
  },
  "pivotTable": {
    object (PivotTable)
  },
  "dataSourceTable": {
    object (DataSourceTable)
  },
  "dataSourceFormula": {
    object (DataSourceFormula)
  }
}
Champs
userEnteredValue

object (ExtendedValue)

Valeur saisie par l'utilisateur dans la cellule (par exemple, 1234, 'Hello' ou =NOW() Remarque: Les dates, heures et dates/heures sont représentées sous forme de doubles au format serial number.

effectiveValue

object (ExtendedValue)

Valeur effective de la cellule. Pour les cellules contenant des formules, il s'agit de la valeur calculée. Pour les cellules contenant des littéraux, cette valeur est identique à userEnteredValue. Ce champ est en lecture seule.

formattedValue

string

Valeur formatée de la cellule. Il s'agit de la valeur telle qu'elle est présentée à l'utilisateur. Ce champ est en lecture seule.

userEnteredFormat

object (CellFormat)

Format saisi par l'utilisateur pour la cellule.

Lors de la rédaction, le nouveau format sera fusionné avec le format existant.

effectiveFormat

object (CellFormat)

Format effectif utilisé par la cellule. Cela inclut les résultats de l'application d'une mise en forme conditionnelle et, si la cellule contient une formule, le format de nombre calculé. Si le format effectif est le format par défaut, il ne sera pas écrit. Ce champ est en lecture seule.

note

string

Toute note associée à la cellule.

textFormatRuns[]

object (TextFormatRun)

Extraits de texte enrichi appliqués à des sous-sections de la cellule. Les exécutions ne sont valides que pour les chaînes saisies par l'utilisateur, pas pour les formules, les chiffres ou les chiffres. Les propriétés d'une exécution commencent à un indice spécifique dans le texte et se poursuivent jusqu'à l'exécution suivante. Les séries héritent des propriétés de la cellule, sauf si elles sont modifiées explicitement.

Lors de l'écriture, les nouvelles exécutions remplacent les exécutions précédentes. Lorsque vous écrivez un nouveau userEnteredValue, les exécutions précédentes sont effacées.

dataValidation

object (DataValidationRule)

Une règle de validation des données sur la cellule, le cas échéant.

Lors de l'écriture, la nouvelle règle de validation des données remplace toute règle précédente.

pivotTable

object (PivotTable)

Tableau croisé dynamique ancré sur cette cellule. La taille du tableau croisé dynamique lui-même est calculée dynamiquement en fonction de ses données, de son regroupement, de ses filtres, de ses valeurs, etc. Seule la cellule en haut à gauche du tableau croisé dynamique contient sa définition. Les autres cellules contiennent les valeurs calculées des résultats du tableau croisé dynamique dans leurs champs effectiveValue.

dataSourceTable

object (DataSourceTable)

Tableau de la source de données ancré à cette cellule. La taille de la table de la source de données elle-même est calculée de manière dynamique en fonction de sa configuration. Seule la première cellule de ce tableau contient la définition du tableau. Les autres cellules contiennent les valeurs d'affichage du résultat du tableau de la source de données dans leurs champs effectiveValue.

dataSourceFormula

object (DataSourceFormula)

Uniquement en sortie. Informations sur une formule de source de données dans la cellule. Le champ est défini si userEnteredValue est une formule faisant référence à une feuille DATA_SOURCE, par exemple =SUM(DataSheet!Column).

CellFormat

Format d'une cellule.

Représentation JSON
{
  "numberFormat": {
    object (NumberFormat)
  },
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },
  "borders": {
    object (Borders)
  },
  "padding": {
    object (Padding)
  },
  "horizontalAlignment": enum (HorizontalAlign),
  "verticalAlignment": enum (VerticalAlign),
  "wrapStrategy": enum (WrapStrategy),
  "textDirection": enum (TextDirection),
  "textFormat": {
    object (TextFormat)
  },
  "hyperlinkDisplayType": enum (HyperlinkDisplayType),
  "textRotation": {
    object (TextRotation)
  }
}
Champs
numberFormat

object (NumberFormat)

Format décrivant comment les valeurs numériques doivent être représentées à l'utilisateur.

backgroundColor
(deprecated)

object (Color)

Couleur d'arrière-plan de la cellule. Obsolète: utilisez backgroundColorStyle.

backgroundColorStyle

object (ColorStyle)

Couleur d'arrière-plan de la cellule. Si backgroundColor est également défini, ce champ est prioritaire.

borders

object (Borders)

Bordures de la cellule.

padding

object (Padding)

Marge intérieure de la cellule.

horizontalAlignment

enum (HorizontalAlign)

Alignement horizontal de la valeur dans la cellule.

verticalAlignment

enum (VerticalAlign)

Alignement vertical de la valeur dans la cellule.

wrapStrategy

enum (WrapStrategy)

Stratégie de retour automatique à la ligne pour la valeur de la cellule.

textDirection

enum (TextDirection)

Sens du texte dans la cellule.

textFormat

object (TextFormat)

Format du texte dans la cellule (sauf si un format est appliqué). Si vous définissez un lien au niveau de la cellule, les liens existants de la cellule sont effacés. La définition du champ de lien dans un TextFormatRun précède le lien au niveau de la cellule.

textRotation

object (TextRotation)

Rotation appliquée au texte de la cellule.

NumberFormat

Format numérique d'une cellule.

Représentation JSON
{
  "type": enum (NumberFormatType),
  "pattern": string
}
Champs
type

enum (NumberFormatType)

Type de format numérique. Lors de l'écriture, ce champ doit être défini.

pattern

string

Chaîne de modèle utilisée pour la mise en forme. Si ce paramètre n'est pas défini, un format par défaut basé sur les paramètres régionaux de l'utilisateur est utilisé si nécessaire pour le type donné. Pour en savoir plus sur les formats acceptés, consultez le guide des formats de date et de nombre.

NumberFormatType

Format numérique de la cellule. Dans cette documentation, les paramètres régionaux sont supposés être en_US, mais le format réel dépend des paramètres régionaux de la feuille de calcul.

Enums
NUMBER_FORMAT_TYPE_UNSPECIFIED Le format numérique n'est pas spécifié et est basé sur le contenu de la cellule. N'utilisez pas cette méthode explicitement.
TEXT Mise en forme du texte, par exemple 1000.12
NUMBER Format numérique, par exemple 1,000.12
PERCENT Formatage au format pourcentage, par exemple : 10.12%
CURRENCY Mise en forme de la devise (par exemple, $1,000.12)
DATE Mise en forme de la date, par exemple 9/26/2008
TIME Formatage de l'heure, par exemple : 3:59:00 PM
DATE_TIME Format de date et d'heure, par exemple : 9/26/08 15:59:00
SCIENTIFIC Mise en forme des nombres scientifiques, par exemple 1.01E+03

Bordures

Bordures de la cellule.

Représentation JSON
{
  "top": {
    object (Border)
  },
  "bottom": {
    object (Border)
  },
  "left": {
    object (Border)
  },
  "right": {
    object (Border)
  }
}
Champs
top

object (Border)

Bordure supérieure de la cellule.

bottom

object (Border)

Bordure inférieure de la cellule.

left

object (Border)

Bordure gauche de la cellule.

right

object (Border)

Bordure droite de la cellule.

Border

Bordure le long d'une cellule.

Représentation JSON
{
  "style": enum (Style),
  "width": integer,
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  }
}
Champs
style

enum (Style)

Style de la bordure.

width
(deprecated)

integer

Largeur de la bordure, en pixels. Obsolète. La largeur est déterminée par le champ "style".

color
(deprecated)

object (Color)

Couleur de la bordure. Obsolète: utilisez colorStyle.

colorStyle

object (ColorStyle)

Couleur de la bordure. Si color est également défini, ce champ prévaut.

Style

Style de bordure.

Enums
STYLE_UNSPECIFIED Le style n'est pas spécifié. Ne l'utilisez pas.
DOTTED La bordure est en pointillés.
DASHED La bordure est en pointillés.
SOLID La bordure est composée d'une fine ligne continue.
SOLID_MEDIUM La bordure est composée d'une ligne continue moyenne.
SOLID_THICK La bordure est une ligne continue épaisse.
NONE Aucune bordure. Utilisé uniquement lors de la mise à jour d'une bordure pour l'effacer.
DOUBLE La bordure est constituée de deux lignes pleines.

Marge intérieure

Marge intérieure autour de la cellule, en pixels. Lorsque vous mettez à jour la marge intérieure, vous devez spécifier tous les champs.

Représentation JSON
{
  "top": integer,
  "right": integer,
  "bottom": integer,
  "left": integer
}
Champs
top

integer

Marge intérieure supérieure de la cellule.

right

integer

Marge intérieure droite de la cellule.

bottom

integer

Marge intérieure inférieure de la cellule.

left

integer

Marge intérieure gauche de la cellule.

VerticalAlign

Alignement vertical du texte dans une cellule.

Enums
VERTICAL_ALIGN_UNSPECIFIED L'alignement vertical n'est pas spécifié. Ne l'utilisez pas.
TOP Le texte est explicitement aligné en haut de la cellule.
MIDDLE Le texte est explicitement aligné au milieu de la cellule.
BOTTOM Le texte est explicitement aligné en bas de la cellule.

WrapStrategy

Insérer un retour automatique à la ligne dans une cellule

Enums
WRAP_STRATEGY_UNSPECIFIED Valeur par défaut, ne pas utiliser.
OVERFLOW_CELL

Les lignes plus longues que la largeur de la cellule seront écrites dans la cellule suivante, tant que cette cellule est vide. Si la cellule suivante n'est pas vide, le comportement est le même que CLIP. Le texte ne s'affichera jamais sur la ligne suivante, sauf si l'utilisateur insère manuellement une nouvelle ligne. Exemple :

| First sentence. |
| Manual newline that is very long. <- Text continues into next cell
| Next newline.   |
LEGACY_WRAP

Cette stratégie de retour à la ligne correspond à l'ancienne stratégie de retour à la ligne de Google Sheets, dans laquelle les mots plus longs qu'une ligne sont tronqués au lieu d'être rompus. Cette stratégie n'est pas compatible avec toutes les plates-formes et sera bientôt supprimée. Exemple :

| Cell has a |
| loooooooooo| <- Word is clipped.
| word.      |
CLIP

Les lignes plus longues que la largeur de la cellule sont coupées. Le texte ne sera jamais renvoyé à la ligne suivante, sauf si l'utilisateur n'insère pas manuellement une nouvelle ligne. Exemple :

| First sentence. |
| Manual newline t| <- Text is clipped
| Next newline.   |
WRAP

Les mots qui sont plus longs qu'une ligne sont mis en retour à la ligne au niveau des caractères plutôt que coupés. Exemple :

| Cell has a |
| loooooooooo| <- Word is broken.
| ong word.  |

TextDirection

Sens du texte dans une cellule.

Enums
TEXT_DIRECTION_UNSPECIFIED Le sens du texte n'est pas spécifié. Ne l'utilisez pas.
LEFT_TO_RIGHT L'orientation du texte de gauche à droite a été définie par l'utilisateur.
RIGHT_TO_LEFT L'orientation du texte a été définie de droite à gauche par l'utilisateur.

HyperlinkDisplayType

Indique si un lien hypertexte doit être affiché explicitement. S'il n'est pas spécifié, le lien hypertexte est lié.

Enums
LINKED Un lien hypertexte doit être affiché explicitement.
PLAIN_TEXT Un lien hypertexte ne doit pas être affiché.

TextRotation

Rotation appliquée au texte d'une cellule.

Représentation JSON
{

  // Union field type can be only one of the following:
  "angle": integer,
  "vertical": boolean
  // End of list of possible types for union field type.
}
Champs
Champ d'union type. Type de rotation (verticale ou inclinée). type ne peut être qu'un des éléments suivants :
angle

integer

Angle entre l'orientation standard et l'orientation souhaitée. Mesurée en degrés. Les valeurs valides sont comprises entre -90 et 90. Les angles positifs sont inclinés vers le haut, les angles négatifs vers le bas.

Remarque: Les angles positifs de l'orientation de gauche à droite sont dans le sens inverse des aiguilles d'une montre, tandis que pour RTL, les angles positifs sont dans le sens des aiguilles d'une montre.

vertical

boolean

Si la valeur est "true", le texte se lit de haut en bas, mais l'orientation des caractères individuels reste inchangée. Exemple :

| V |
| e |
| r |
| t |
| i |
| c |
| a |
| l |

TextFormatRun

Exécution d'un format de texte. Le format de cette exécution continue jusqu'à l'index de début de la prochaine exécution. Lors de la mise à jour, tous les champs doivent être définis.

Représentation JSON
{
  "startIndex": integer,
  "format": {
    object (TextFormat)
  }
}
Champs
startIndex

integer

Index de caractère de base zéro où commence l'exécution, en unités de code UTF-16.

format

object (TextFormat)

Format de cette exécution. Les valeurs manquantes héritent du format de la cellule.

DataValidationRule

Règle de validation des données.

Représentation JSON
{
  "condition": {
    object (BooleanCondition)
  },
  "inputMessage": string,
  "strict": boolean,
  "showCustomUi": boolean
}
Champs
condition

object (BooleanCondition)

Condition à laquelle les données de la cellule doivent répondre.

inputMessage

string

Message à afficher à l'utilisateur lorsqu'il ajoute des données à la cellule.

strict

boolean

"True" si les données non valides doivent être rejetées.

showCustomUi

boolean

"True" si l'UI doit être personnalisée en fonction du type de condition. Si la valeur est "true", les conditions "List" (Liste) affichent une liste déroulante.

DataSourceTable

Table de source de données, qui permet à l'utilisateur d'importer une table statique de données depuis DataSource dans Sheets. Cette fonctionnalité est également appelée "Extraire" dans l'éditeur Sheets.

Représentation JSON
{
  "dataSourceId": string,
  "columnSelectionType": enum (DataSourceTableColumnSelectionType),
  "columns": [
    {
      object (DataSourceColumnReference)
    }
  ],
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ],
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "rowLimit": integer,
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
Champs
dataSourceId

string

ID de la source de données à laquelle la table de la source de données est associée.

columnSelectionType

enum (DataSourceTableColumnSelectionType)

Type de colonnes à sélectionner pour le tableau de la source de données. La valeur par défaut est SELECTED.

columns[]

object (DataSourceColumnReference)

Colonnes sélectionnées pour le tableau de la source de données. columnSelectionType doit être SELECTED.

filterSpecs[]

object (FilterSpec)

Spécifications de filtrage dans le tableau des sources de données.

sortSpecs[]

object (SortSpec)

Spécifications de tri dans le tableau de la source de données. Le résultat du tableau de la source de données est trié en fonction des spécifications de tri, dans l'ordre.

rowLimit

integer

Limite de lignes à renvoyer. Si cette règle n'est pas configurée, une limite par défaut est appliquée. Pour connaître la limite par défaut et la limite maximale, consultez l'éditeur Sheets.

dataExecutionStatus

object (DataExecutionStatus)

Uniquement en sortie. État de l'exécution des données.

DataSourceTableColumnSelectionType

Types de sélection de colonnes dans le tableau de la source de données.

Enums
DATA_SOURCE_TABLE_COLUMN_SELECTION_TYPE_UNSPECIFIED Type de sélection de colonnes par défaut, à ne pas utiliser.
SELECTED Sélectionner les colonnes spécifiées par le champ columns.
SYNC_ALL

Synchronisez toutes les colonnes actuelles et futures de la source de données.

Si cette valeur est définie, la table de la source de données récupère toutes les colonnes de la source de données au moment de l'actualisation.

DataSourceFormula

Formule de source de données.

Représentation JSON
{
  "dataSourceId": string,
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
Champs
dataSourceId

string

ID de la source de données à laquelle la formule est associée.

dataExecutionStatus

object (DataExecutionStatus)

Uniquement en sortie. État de l'exécution des données.