Sheets
Feuille de calcul.
| Représentation JSON |
|---|
{ "properties": { object ( |
| Champs | |
|---|---|
properties
|
Propriétés de la feuille. |
data[]
|
Données de la grille, s'il s'agit d'une feuille de grille.
Le nombre d'objets GridData renvoyés dépend du nombre de plages demandées dans cette feuille. Par exemple, si cela représente
Pour une feuille |
merges[]
|
Plages fusionnées. |
conditionalFormats[]
|
Règles de mise en forme conditionnelle dans cette feuille. |
filterViews[]
|
Vues filtrées dans cette feuille. |
protectedRanges[]
|
Plages protégées dans cette feuille. |
basicFilter
|
Filtre appliqué à cette feuille, le cas échéant. |
charts[]
|
Spécifications de chaque graphique de cette feuille. |
bandedRanges[]
|
Plages avec bandes (couleurs alternées) de cette feuille. |
developerMetadata[]
|
Métadonnées du développeur associées à une feuille. |
rowGroups[]
|
Tous les groupes de lignes de cette feuille, classés par ordre croissant de l'index de début de plage, puis par profondeur de groupe. |
columnGroups[]
|
Tous les groupes de colonnes de cette feuille, classés par ordre croissant de l'index de début de plage, puis par profondeur de groupe. |
slicers[]
|
Les sélecteurs de cette feuille. |
tables[]
|
Les tableaux de cette feuille. |
SheetProperties
Propriétés d'une feuille.
| Représentation JSON |
|---|
{ "sheetId": integer, "title": string, "index": integer, "sheetType": enum ( |
| Champs | |
|---|---|
sheetId
|
ID de la feuille. Cette valeur ne doit pas être négative Une fois ce champ défini, il ne peut plus être modifié. |
title
|
Nom de la feuille. |
index
|
Index de la feuille dans la feuille de calcul. Lorsque vous ajoutez ou mettez à jour les propriétés d'une feuille, si ce champ est exclu, la feuille est ajoutée ou déplacée à la fin de la liste des feuilles. Lorsque vous mettez à jour les index de feuilles ou que vous insérez des feuilles, le déplacement est pris en compte dans les index "avant le déplacement". Par exemple, si vous avez trois feuilles (S1, S2, S3) et que vous souhaitez déplacer S1 avant S2, l'index doit être défini sur 2. Une demande de mise à jour de l'index de feuille est ignorée si l'index demandé est identique à l'index actuel de la feuille ou si le nouvel index demandé est égal à l'index actuel de la feuille + 1. |
sheetType
|
Type de feuille. La valeur par défaut est |
gridProperties
|
Propriétés supplémentaires de la feuille si elle est une grille. (Si la feuille est une feuille d'objet contenant un graphique ou une image, ce champ sera absent.) Lors de l'écriture, il est interdit de définir des propriétés de grille sur des feuilles non associées à une grille.
Si cette feuille est une feuille |
tabColor
|
Couleur de l'onglet dans l'UI. Obsolète : utilisez |
tabColorStyle
|
Couleur de l'onglet dans l'UI. Si |
rightToLeft
|
"True" si la feuille est une feuille RTL au lieu d'une feuille LTR. |
dataSourceSheetProperties
|
Uniquement en sortie. Si ce champ est présent, il contient les propriétés spécifiques à la feuille |
SheetType
Type de feuille.
| Enums | |
|---|---|
SHEET_TYPE_UNSPECIFIED
|
Valeur par défaut, ne pas utiliser. |
GRID
|
La feuille est une grille. |
OBJECT
|
La feuille ne comporte pas de grille, mais un objet tel qu'un graphique ou une image. |
DATA_SOURCE
|
La feuille se connecte à une source de données externe
DataSource
et affiche un aperçu des données.
|
GridProperties
Propriétés d'une grille.
| Représentation JSON |
|---|
{ "rowCount": integer, "columnCount": integer, "frozenRowCount": integer, "frozenColumnCount": integer, "hideGridlines": boolean, "rowGroupControlAfter": boolean, "columnGroupControlAfter": boolean } |
| Champs | |
|---|---|
rowCount
|
Nombre de lignes dans la grille. |
columnCount
|
Nombre de colonnes dans la grille. |
frozenRowCount
|
Nombre de lignes figées dans la grille. |
frozenColumnCount
|
Nombre de colonnes figées dans la grille. |
hideGridlines
|
"True" si la grille n'affiche pas de lignes dans l'UI. |
rowGroupControlAfter
|
"True" si le bouton d'activation/de désactivation de la commande de regroupement de lignes est affiché après le groupe. |
columnGroupControlAfter
|
"True" si le bouton d'activation/de désactivation du contrôle du regroupement de colonnes est affiché après le groupe. |
DataSourceSheetProperties
Propriétés supplémentaires d'une feuille DATA_SOURCE.
| Représentation JSON |
|---|
{ "dataSourceId": string, "columns": [ { object ( |
| Champs | |
|---|---|
dataSourceId
|
ID de la feuille |
columns[]
|
Les colonnes affichées dans la feuille, correspondant aux valeurs de |
dataExecutionStatus
|
État d'exécution des données. |
GridData
Données de la grille et métadonnées sur les dimensions.
| Représentation JSON |
|---|
{ "startRow": integer, "startColumn": integer, "rowData": [ { object ( |
| Champs | |
|---|---|
startRow
|
Première ligne à laquelle cette GridData fait référence (sur la base zéro). |
startColumn
|
Première colonne à laquelle cette GridData fait référence (sur base zéro). |
rowData[]
|
Données de la grille, une entrée par ligne, en commençant par la ligne startRow. Les valeurs de RowData correspondent aux colonnes commençant par |
rowMetadata[]
|
Métadonnées sur les lignes demandées dans la grille, en commençant par la ligne à l'index |
columnMetadata[]
|
Métadonnées sur les colonnes demandées dans la grille, en commençant par la colonne dans |
RowData
Données sur chaque cellule d'une ligne.
| Représentation JSON |
|---|
{
"values": [
{
object ( |
| Champs | |
|---|---|
values[]
|
Valeurs de la ligne, une par colonne. |
DimensionProperties
Propriétés d'une dimension.
| Représentation JSON |
|---|
{ "hiddenByFilter": boolean, "hiddenByUser": boolean, "pixelSize": integer, "developerMetadata": [ { object ( |
| Champs | |
|---|---|
pixelSize
|
Hauteur (s'il s'agit d'une ligne) ou largeur (s'il s'agit d'une colonne) de la dimension en pixels. |
developerMetadata[]
|
Métadonnées de développement associées à une seule ligne ou colonne. |
dataSourceColumnReference
|
Uniquement en sortie. Si cette option est définie, il s'agit d'une colonne dans une feuille de source de données. |
ConditionalFormatRule
Règle décrivant un format conditionnel.
| Représentation JSON |
|---|
{ "ranges": [ { object ( |
| Champs | |
|---|---|
ranges[]
|
Plages mises en forme si la condition est vraie. Toutes les plages doivent se trouver sur la même grille. |
Champ d'union
rule. La règle qui contrôle ce format conditionnel. Une seule règle doit être définie.
rule
ne peut être qu'un des éléments suivants :
|
|
booleanRule
|
La mise en forme est "activée" ou "désactivée" selon la règle. |
gradientRule
|
La mise en forme varie en fonction des dégradés de la règle. |
BooleanRule
Règle qui peut correspondre ou non, selon la condition.
| Représentation JSON |
|---|
{ "condition": { object ( |
| Champs | |
|---|---|
condition
|
Condition de la règle. Si la condition renvoie la valeur "true", le format est appliqué. |
format
|
Format à appliquer. La mise en forme conditionnelle ne peut appliquer qu'un sous-ensemble de la mise en forme :
|
GradientRule
Règle qui applique un format de dégradé de couleurs en fonction des points d'interpolation listés. Le format d'une cellule varie en fonction de son contenu par rapport aux valeurs des points d'interpolation.
| Représentation JSON |
|---|
{ "minpoint": { object ( |
| Champs | |
|---|---|
minpoint
|
Point de départ de l'interpolation. |
midpoint
|
Point d'interpolation intermédiaire facultatif. |
maxpoint
|
Point d'interpolation final. |
InterpolationPoint
Point d'interpolation unique dans une mise en forme conditionnelle avec dégradé. Ces options permettent d'épingler le dégradé de couleurs en fonction de la couleur, du type et de la valeur choisis.
| Représentation JSON |
|---|
{ "color": { object ( |
| Champs | |
|---|---|
color
|
Couleur que ce point d'interpolation doit utiliser. Obsolète : utilisez |
colorStyle
|
Couleur que ce point d'interpolation doit utiliser. Si |
type
|
Indique comment la valeur doit être interprétée. |
value
|
Valeur utilisée par ce point d'interpolation. Peut être une formule. Non utilisé si |
InterpolationPointType
Type de point d'interpolation.
| Enums | |
|---|---|
INTERPOLATION_POINT_TYPE_UNSPECIFIED
|
Valeur par défaut, ne pas utiliser. |
MIN
|
Le point d'interpolation utilise la valeur minimale des cellules dans la plage du format conditionnel. |
MAX
|
Le point d'interpolation utilise la valeur maximale des cellules dans la plage du format conditionnel. |
NUMBER
|
Le point d'interpolation utilise exactement la valeur de InterpolationPoint.value.
|
PERCENT
|
Le point d'interpolation correspond au pourcentage donné sur toutes les cellules de la plage du format conditionnel. Cela équivaut à |
PERCENTILE
|
Le point d'interpolation correspond au centile donné pour toutes les cellules de la plage du format conditionnel. Cela équivaut à NUMBER si la valeur était =PERCENTILE(FLATTEN(range), value / 100) (où les erreurs dans la plage sont ignorées lors de l'aplatissement).
|
FilterView
Une vue filtrée. Pour en savoir plus, consultez Gérer la visibilité des données avec des filtres.
| Représentation JSON |
|---|
{ "filterViewId": integer, "title": string, "range": { object ( |
| Champs | |
|---|---|
filterViewId
|
ID de la vue filtrée. |
title
|
Nom de la vue filtrée. |
range
|
Plage couverte par cette vue filtrée.
Lors de l'écriture, une seule des options |
namedRangeId
|
Plage nommée sur laquelle repose cette vue filtrée, le cas échéant.
Lors de l'écriture, une seule des options |
tableId
|
Table sur laquelle repose cette vue filtrée, le cas échéant.
Lors de l'écriture, une seule des options |
sortSpecs[]
|
Ordre de tri par colonne. Les spécifications ultérieures sont utilisées lorsque les valeurs sont égales dans les spécifications précédentes. |
criteria
|
Critères permettant d'afficher/masquer les valeurs par colonne. La clé de la carte est l'index de la colonne, et la valeur correspond au critère de cette colonne.
Ce champ a été abandonné et remplacé par |
filterSpecs[]
|
Critères de filtrage permettant d'afficher ou de masquer des valeurs par colonne.
Les deux valeurs |
ProtectedRange
Plage protégée.
| Représentation JSON |
|---|
{ "protectedRangeId": integer, "range": { object ( |
| Champs | |
|---|---|
protectedRangeId
|
ID de la plage protégée. Ce champ est en lecture seule. |
range
|
Plage à protéger. La plage peut être entièrement illimitée, auquel cas elle est considérée comme une feuille protégée.
Lors de l'écriture, un seul des éléments suivants peut être défini : |
namedRangeId
|
Plage nommée sur laquelle repose cette plage protégée, le cas échéant.
Lors de l'écriture, un seul des éléments suivants peut être défini : |
tableId
|
Table sur laquelle repose cette plage protégée, le cas échéant.
Lors de l'écriture, un seul des éléments suivants peut être défini : |
description
|
Description de cette plage protégée. |
warningOnly
|
"True" si un avertissement s'affiche lors de la modification de cette plage protégée. La protection basée sur des avertissements signifie que chaque utilisateur peut modifier les données dans la plage protégée, mais qu'un avertissement lui demandera de confirmer la modification.
Lors de l'écriture : si ce champ est défini sur "true", alors
|
requestingUserCanEdit
|
True si l'utilisateur qui a demandé cette plage protégée peut modifier la zone protégée. Ce champ est en lecture seule. |
unprotectedRanges[]
|
Liste des plages non protégées dans une feuille protégée. Les plages non protégées ne sont acceptées que sur les feuilles protégées. |
editors
|
Les utilisateurs et les groupes disposant d'un accès en modification à la plage protégée. Ce champ n'est visible que par les utilisateurs disposant d'un accès en modification à la plage protégée et au document. Les éditeurs ne sont pas compatibles avec la protection |
Éditeurs
Les éditeurs d'une plage protégée.
| Représentation JSON |
|---|
{ "users": [ string ], "groups": [ string ], "domainUsersCanEdit": boolean } |
| Champs | |
|---|---|
users[]
|
Adresses e-mail des utilisateurs ayant accès en modification à la plage protégée. |
groups[]
|
Adresses e-mail des groupes ayant accès en modification à la plage protégée. |
domainUsersCanEdit
|
True si une personne du domaine du document a accès à la modification de la plage protégée. La protection de domaine n'est disponible que pour les documents d'un domaine. |
BasicFilter
Filtre par défaut associé à une feuille. Pour en savoir plus, consultez Gérer la visibilité des données avec des filtres.
| Représentation JSON |
|---|
{ "range": { object ( |
| Champs | |
|---|---|
range
|
Plage couverte par le filtre. |
tableId
|
Table sur laquelle ce filtre est basé, le cas échéant. Lors de l'écriture, vous ne pouvez définir qu'un seul des éléments suivants :
|
sortSpecs[]
|
Ordre de tri par colonne. Les spécifications ultérieures sont utilisées lorsque les valeurs sont égales dans les spécifications précédentes. |
criteria
|
Critères permettant d'afficher/masquer les valeurs par colonne. La clé de la carte est l'index de la colonne, et la valeur correspond au critère de cette colonne.
Ce champ a été abandonné et remplacé par |
filterSpecs[]
|
Critères de filtrage par colonne.
Les deux valeurs |
BandedRange
Plage à bandes (couleurs alternées) dans une feuille.
| Représentation JSON |
|---|
{ "bandedRangeId": integer, "bandedRangeReference": string, "range": { object ( |
| Champs | |
|---|---|
bandedRangeId
|
ID de la plage avec bande. Si cette valeur n'est pas définie, consultez |
bandedRangeReference
|
Uniquement en sortie. Référence de la plage avec bandes, utilisée pour identifier l'ID non compatible avec |
range
|
Plage sur laquelle ces propriétés sont appliquées. |
rowProperties
|
Propriétés des bandes de lignes. Ces propriétés sont appliquées ligne par ligne à toutes les lignes de la plage. Vous devez spécifier au moins l'une des valeurs suivantes : |
columnProperties
|
Propriétés des bandes de colonnes. Ces propriétés sont appliquées colonne par colonne à toutes les colonnes de la plage. Vous devez spécifier au moins l'une des valeurs suivantes : |
BandingProperties
Propriétés faisant référence à une seule dimension (ligne ou colonne). Si BandedRange.row_properties et BandedRange.column_properties sont définis, les couleurs de remplissage sont appliquées aux cellules selon les règles suivantes :
-
headerColoretfooterColorsont prioritaires sur les couleurs de bande. -
firstBandColorest prioritaire sursecondBandColor. -
rowPropertiesest prioritaire surcolumnProperties.
Par exemple, la couleur de la première ligne est prioritaire sur celle de la première colonne, mais la couleur de la première colonne est prioritaire sur celle de la deuxième ligne. De même, l'en-tête de ligne est prioritaire sur l'en-tête de colonne dans la cellule en haut à gauche, mais l'en-tête de colonne est prioritaire sur la couleur de la première ligne si l'en-tête de ligne n'est pas défini.
| Représentation JSON |
|---|
{ "headerColor": { object ( |
| Champs | |
|---|---|
headerColor
|
Couleur de la première ligne ou colonne. Si ce champ est défini, la première ligne ou colonne est remplie avec cette couleur, et les couleurs alternent entre
|
headerColorStyle
|
Couleur de la première ligne ou colonne. Si ce champ est défini, la première ligne ou colonne est remplie avec cette couleur, et les couleurs alternent entre
|
firstBandColor
|
Première couleur alternée. (Obligatoire) Obsolète : utilisez |
firstBandColorStyle
|
Première couleur alternée. (Obligatoire) Si |
secondBandColor
|
Deuxième couleur utilisée en alternance. (Obligatoire) Obsolète : utilisez |
secondBandColorStyle
|
Deuxième couleur utilisée en alternance. (Obligatoire) Si |
footerColor
|
Couleur de la dernière ligne ou colonne. Si ce champ n'est pas défini, la dernière ligne ou colonne est remplie avec |
footerColorStyle
|
Couleur de la dernière ligne ou colonne. Si ce champ n'est pas défini, la dernière ligne ou colonne est remplie avec |
DimensionGroup
Groupe sur un intervalle de lignes ou de colonnes d'une feuille, qui peut contenir d'autres groupes ou être contenu dans d'autres groupes. Un groupe peut être réduit ou développé en tant qu'unité dans la feuille.
| Représentation JSON |
|---|
{
"range": {
object ( |
| Champs | |
|---|---|
range
|
Plage sur laquelle ce groupe existe. |
depth
|
Profondeur du groupe, représentant le nombre de groupes dont la plage contient entièrement la plage de ce groupe. |
collapsed
|
La valeur de ce champ est "true" si ce groupe est réduit. Un groupe réduit le reste si un groupe chevauchant à une profondeur inférieure est développé. Une valeur "true" n'implique pas que toutes les dimensions du groupe sont masquées, car la visibilité d'une dimension peut changer indépendamment de cette propriété de groupe. Toutefois, lorsque cette propriété est mise à jour, toutes les dimensions qu'elle contient sont définies sur "masquées" si ce champ est défini sur "true", ou sur "visibles" si ce champ est défini sur "false". |
Segment
Un sélecteur dans une feuille.
| Représentation JSON |
|---|
{ "slicerId": integer, "spec": { object ( |
| Champs | |
|---|---|
slicerId
|
ID du sélecteur. |
spec
|
Spécification du sélecteur. |
position
|
Position du sélecteur. Notez que le sélecteur ne peut être positionné que sur une feuille existante. De plus, la largeur et la hauteur du sélecteur peuvent être ajustées automatiquement pour respecter les limites autorisées. |
SlicerSpec
Spécifications d'un sélecteur.
| Représentation JSON |
|---|
{ "dataRange": { object ( |
| Champs | |
|---|---|
dataRange
|
Plage de données du sélecteur. |
filterCriteria
|
Critères de filtrage du sélecteur. |
columnIndex
|
Index de colonne (base zéro) dans le tableau de données auquel le filtre est appliqué. |
applyToPivotTables
|
True si le filtre doit s'appliquer aux tableaux croisés dynamiques. Si ce champ n'est pas défini, la valeur par défaut est |
title
|
Titre du sélecteur. |
textFormat
|
Format de texte du titre dans le sélecteur. Le champ "Lien" n'est pas disponible. |
backgroundColor
|
Couleur d'arrière-plan du sélecteur. Obsolète : utilisez |
backgroundColorStyle
|
Couleur d'arrière-plan du sélecteur. Si |
horizontalAlignment
|
Alignement horizontal du titre dans le sélecteur. Si aucune valeur n'est spécifiée, la valeur définie par défaut est |
Tableau
Table.
| Représentation JSON |
|---|
{ "tableId": string, "name": string, "range": { object ( |
| Champs | |
|---|---|
tableId
|
ID de la table. |
name
|
Nom de la table. Cette valeur est unique pour toutes les tables d'une même feuille de calcul. |
range
|
Plage du tableau. |
rowsProperties
|
Propriétés des lignes du tableau. |
columnProperties[]
|
Propriétés de la colonne du tableau. |
TableRowsProperties
Propriétés de la ligne du tableau.
| Représentation JSON |
|---|
{ "headerColorStyle": { object ( |
| Champs | |
|---|---|
headerColorStyle
|
Couleur de la ligne d'en-tête. Si ce champ est défini, la ligne d'en-tête est remplie avec la couleur spécifiée. Sinon, la ligne d'en-tête est remplie d'une couleur par défaut. |
firstBandColorStyle
|
Première couleur alternée. Si ce champ est défini, la première ligne à bandes est remplie avec la couleur spécifiée. Sinon, la première ligne à bandes est remplie d'une couleur par défaut. |
secondBandColorStyle
|
Deuxième couleur utilisée en alternance. Si ce champ est défini, la deuxième ligne à bandes est remplie avec la couleur spécifiée. Sinon, la deuxième ligne à bandes est remplie d'une couleur par défaut. |
footerColorStyle
|
Couleur de la dernière ligne. Si ce champ n'est pas défini, aucun pied de page n'est ajouté. La dernière ligne est remplie avec |
TableColumnProperties
Colonne du tableau.
| Représentation JSON |
|---|
{ "columnIndex": integer, "columnName": string, "columnType": enum ( |
| Champs | |
|---|---|
columnIndex
|
Index de colonne basé sur zéro. Cet index est relatif à sa position dans le tableau et n'est pas nécessairement le même que l'index de colonne dans la feuille. |
columnName
|
Nom de la colonne. |
columnType
|
Type de colonne. |
dataValidationRule
|
Règle de validation des données de la colonne. Défini uniquement pour le type de colonne "menu déroulant". |
ColumnType
Type de colonne pour une colonne donnée dans un tableau.
| Enums | |
|---|---|
COLUMN_TYPE_UNSPECIFIED
|
Type de colonne non spécifié. |
DOUBLE
|
Type de colonne numérique. |
CURRENCY
|
Type de colonne "Devise". |
PERCENT
|
Type de colonne "pourcentage". |
DATE
|
Type de colonne de date. |
TIME
|
Type de colonne de date/heure. |
DATE_TIME
|
Type de colonne "Date et heure". |
TEXT
|
Type de colonne "Texte". |
BOOLEAN
|
Type de colonne booléen. |
DROPDOWN
|
Type de colonne "menu déroulant". |
FILES_CHIP
|
Type de colonne "chip de fichier" |
PEOPLE_CHIP
|
Type de colonne "chip de contact" |
FINANCE_CHIP
|
Type de colonne "chip Finance" |
PLACE_CHIP
|
Type de colonne "chip de lieu" |
RATINGS_CHIP
|
Type de colonne "chip de note" |
TableColumnDataValidationRule
Règle de validation des données pour une colonne d'un tableau.
| Représentation JSON |
|---|
{
"condition": {
object ( |
| Champs | |
|---|---|
condition
|
Condition à laquelle les données de la cellule doivent correspondre. Valide uniquement si [BooleanCondition.type] est défini sur ONE_OF_LIST. |