Feuille
Feuille d'une 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 grille.
Le nombre d'objets GridData renvoyés dépend du nombre de plages demandées sur cette feuille. Par exemple, si cela représente
Pour une feuille |
merges[]
|
Plages fusionnées. |
conditionalFormats[]
|
Règles de mise en forme conditionnelle de cette feuille. |
filterViews[]
|
Vues filtrées de cette feuille. |
protectedRanges[]
|
Plages protégées de cette feuille. |
basicFilter
|
Le filtre de cette feuille, le cas échéant. |
charts[]
|
Spécifications de chaque graphique de cette feuille. |
bandedRanges[]
|
Les plages de bandes (en option) apparaissent sur cette feuille. |
developerMetadata[]
|
Métadonnées développeur associées à une feuille. |
rowGroups[]
|
Tous les groupes de lignes de cette feuille, classés par ordre croissant de plage de début, puis par profondeur de groupe. |
columnGroups[]
|
Tous les groupes de colonnes de cette feuille, classés par ordre croissant de début de plage, puis par profondeur de groupe. |
slicers[]
|
Les segments de cette feuille. |
Propriétés de la feuille
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 défini, ce champ ne peut plus être modifié. |
title
|
Nom de la feuille. |
index
|
Index de la feuille dans la feuille de calcul. Lors de l'ajout ou de la mise à jour des propriétés de la feuille, si ce champ est exclu, la feuille est ajoutée ou déplacée en fin de liste. Lorsque vous mettez à jour des index de feuilles ou que vous en insérez, les mouvements sont pris en compte dans les index "avant le déplacement". Par exemple, si vous aviez trois feuilles (S1, S2, S3) afin de déplacer S1 avant S2, l'index devra être défini sur 2. Une requête de mise à jour de l'index de la feuille de calcul est ignorée si l'index demandé est identique à l'index actuel de Sheets ou si le nouvel index demandé est égal à l'index de feuille actuel + 1. |
sheetType
|
Type de feuille. La valeur par défaut est |
gridProperties
|
Propriétés supplémentaires de la feuille si celle-ci est une grille. (Si la feuille est une feuille d'objets contenant un graphique ou une image, ce champ sera manquant.) Lors de l'écriture, une erreur se produit lorsque vous définissez des propriétés de grille sur des feuilles qui ne sont pas en mode grille.
Si cette feuille est une feuille |
tabColor
|
Couleur de l'onglet dans l'interface utilisateur. Obsolète: utilisez |
tabColorStyle
|
Couleur de l'onglet dans l'interface utilisateur. Si |
rightToLeft
|
Défini sur "true" si la feuille est une feuille de droite à gauche au lieu d'une feuille de gauche à droite. |
dataSourceSheetProperties
|
Uniquement en sortie. S'il est présent, le champ contient des propriétés spécifiques à la feuille |
Type de feuille
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 contient un objet (graphique ou image, par exemple). |
DATA_SOURCE
|
La feuille se connecte à un DataSource externe et affiche un aperçu des données.
|
Propriétés de la grille
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
|
Vraie si la grille n'affiche pas de quadrillages dans l'interface utilisateur. |
rowGroupControlAfter
|
Définie sur "True" si la commande de regroupement des lignes est affichée après le groupe. |
columnGroupControlAfter
|
Critère : bouton d'activation du regroupement de colonnes 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 du |
columns[]
|
Colonnes affichées sur la feuille, correspondant aux valeurs de |
dataExecutionStatus
|
État d'exécution des données. |
Grille de données
Données dans la grille, ainsi que les métadonnées liées aux dimensions.
Représentation JSON |
---|
{ "startRow": integer, "startColumn": integer, "rowData": [ { object ( |
Champs | |
---|---|
startRow
|
La première ligne à laquelle ce GridData fait référence, est basée sur zéro. |
startColumn
|
Première colonne à laquelle ce DataGrid fait référence, basée sur zéro. |
rowData[]
|
Données de la grille, une entrée par ligne, commençant par la ligne dans startRow. Les valeurs dans RowData correspondent aux colonnes commençant par |
rowMetadata[]
|
Les métadonnées sur les lignes demandées dans la grille, en commençant par la ligne dans |
columnMetadata[]
|
Métadonnées sur les colonnes demandées dans la grille, commençant par la colonne dans |
RowData
Données concernant 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 (si une ligne) ou largeur (si une colonne) de la dimension en pixels. |
developerMetadata[]
|
Métadonnées relatives au développeur associées à une seule ligne ou colonne. |
dataSourceColumnReference
|
Uniquement en sortie. S'il est défini, il s'agit d'une colonne dans la feuille d'une 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 . Vous devez définir exactement la règle qui contrôle ce format conditionnel.
rule ne peut être que l'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 variera en fonction des dégradés dans la règle. |
Règle booléenne
Règle qui peut correspondre ou non, en fonction de la condition.
Représentation JSON |
---|
{ "condition": { object ( |
Champs | |
---|---|
condition
|
Condition de la règle. Si la condition est définie sur "true", le format est appliqué. |
format
|
Format à appliquer. La mise en forme conditionnelle ne peut appliquer qu'un sous-ensemble de mise en forme : |
GradientRule
Règle qui applique un format de dégradé de couleurs en fonction des points d'interpolation indiqué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 d'interpolation de départ. |
midpoint
|
Point d'interpolation facultatif à mi-parcours. |
maxpoint
|
Point d'interpolation final. |
Point d'interpolation
Point d'interpolation unique sur un format conditionnel de gradient. Ils dégradent la couleur du dégradé 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
|
Mode d'interprétation de la valeur. |
value
|
Valeur utilisée par ce point d'interpolation. Peut être une formule. Non utilisé si |
Type de point d'interpolation
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 sur la plage du format conditionnel. |
MAX
|
Le point d'interpolation utilise la valeur maximale des cellules sur la plage du format conditionnel. |
NUMBER
|
Le point d'interpolation utilise exactement la valeur contenue dans InterpolationPoint.value .
|
PERCENT
|
Le point d'interpolation correspond au pourcentage donné sur toutes les cellules compris dans la plage du format conditionnel. Cela équivaut à |
PERCENTILE
|
Le point d'interpolation correspond au centile donné sur l'ensemble des cellules de la plage du format conditionnel. Cela équivaut à NUMBER si la valeur était =PERCENTILE(FLATTEN(range), value / 100) (où les erreurs de la plage sont ignorées lors de l'aplatissement).
|
Vue filtrée
Une vue filtrée
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, vous ne pouvez définir qu'un seul |
namedRangeId
|
Plage nommée sur laquelle se trouve cette vue filtrée, le cas échéant.
Lors de l'écriture, vous ne pouvez définir qu'un seul |
sortSpecs[]
|
Ordre de tri par colonne. Les spécifications ultérieures sont utilisées lorsque les valeurs sont égales aux spécifications précédentes. |
criteria
|
Critères d'affichage et de masquage des valeurs par colonne. La clé de la map correspond à l'index de colonne et la valeur aux critères de cette colonne.
Ce champ a été abandonné et remplacé par |
filterSpecs[]
|
Critères de filtre pour afficher/masquer les valeurs par colonne.
Les champs |
Plage protégée
Une 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 qui est protégée. La plage peut être entièrement illimitée. Dans ce cas, elle est considérée comme une feuille protégée.
Lors de l'écriture, vous ne pouvez définir qu'un seul |
namedRangeId
|
Plage nommée sur laquelle se trouve cette plage protégée, le cas échéant.
Lors de l'écriture, vous ne pouvez définir qu'un seul |
description
|
Description de cette plage protégée. |
warningOnly
|
Vraie si cette plage protégée affiche un avertissement lors de la modification. Avec la protection basée sur des avertissements, tous les utilisateurs sont autorisés à modifier les données de la plage protégée. Un avertissement s'affiche alors pour leur demander de confirmer la modification.
Lors de l'écriture: si ce champ est défini sur "true", les |
requestingUserCanEdit
|
Défini sur "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 compatibles qu'avec les feuilles protégées. |
editors
|
Utilisateurs et groupes autorisés à modifier la plage protégée. Seuls les utilisateurs autorisés à modifier la plage protégée et le document peuvent voir ce champ. Les éditeurs ne sont pas compatibles avec la protection |
Éditeurs
Éditeurs d'une plage protégée.
Représentation JSON |
---|
{ "users": [ string ], "groups": [ string ], "domainUsersCanEdit": boolean } |
Champs | |
---|---|
users[]
|
Adresses e-mail des utilisateurs autorisés à modifier la plage protégée. |
groups[]
|
Adresses e-mail des groupes disposant d'un accès en modification à la plage protégée. |
domainUsersCanEdit
|
Défini sur "true" si un utilisateur du domaine du document est autorisé à modifier la plage protégée. La protection d'un domaine n'est disponible que pour les documents d'un domaine. |
Filtre de base
Filtre par défaut associé à une feuille.
Représentation JSON |
---|
{ "range": { object ( |
Champs | |
---|---|
range
|
Plage couverte par le filtre. |
sortSpecs[]
|
Ordre de tri par colonne. Les spécifications ultérieures sont utilisées lorsque les valeurs sont égales aux spécifications précédentes. |
criteria
|
Critères d'affichage et de masquage des valeurs par colonne. La clé de la map correspond à l'index de colonne et la valeur aux critères de cette colonne.
Ce champ a été abandonné et remplacé par |
filterSpecs[]
|
Critères de filtre par colonne.
Les champs |
Portée en bande
Plage de couleurs à bandes (alternantes) dans une feuille.
Représentation JSON |
---|
{ "bandedRangeId": integer, "range": { object ( |
Champs | |
---|---|
bandedRangeId
|
ID de la plage rayée. |
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 sur toutes les lignes de la plage. Vous devez spécifier au moins |
columnProperties
|
Propriétés des bandes de colonnes. Ces propriétés sont appliquées au cas par cas à toutes les colonnes de la plage. Vous devez spécifier au moins |
Propriétés du banding
Propriétés faisant référence à une seule dimension (ligne ou colonne). Si les valeurs BandedRange.row_properties
et BandedRange.column_properties
sont définies, les couleurs de remplissage sont appliquées aux cellules conformément aux règles suivantes:
-
headerColor
etfooterColor
sont prioritaires sur les couleurs du bracelet. -
firstBandColor
est prioritaire par rapport àsecondBandColor
. -
rowProperties
est prioritaire par rapport àcolumnProperties
.
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 celui de la colonne dans la cellule supérieure 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 qui alterne. (Obligatoire) Obsolète: utilisez |
firstBandColorStyle
|
Première couleur qui alterne. (Obligatoire) Si |
secondBandColor
|
La deuxième couleur qui alterne. (Obligatoire) Obsolète: utilisez |
secondBandColorStyle
|
La deuxième couleur qui alterne. (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 |
Groupe de dimensions
Groupe sur un intervalle de lignes ou de colonnes dans une feuille, qui peut être contenu dans d'autres groupes. Un groupe peut être réduit ou développé en tant qu'unité de la feuille.
Représentation JSON |
---|
{
"range": {
object (
|
Champs | |
---|---|
range
|
Plage sur laquelle ce groupe existe. |
depth
|
La profondeur du groupe, qui représente le nombre total de groupes incluant une plage du groupe. |
collapsed
|
Ce champ est "true" si ce groupe est réduit. Un groupe réduit reste réduit si un groupe qui se chevauche avec une profondeur moindre est développé. Une valeur "true" ne signifie 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 masquées si ce champ est défini sur "true" ou visibles si ce champ est défini sur "false". |
Segment
Un segment dans une feuille.
Représentation JSON |
---|
{ "slicerId": integer, "spec": { object ( |
Champs | |
---|---|
slicerId
|
ID du segment. |
spec
|
Spécification du segment. |
position
|
Position du segment. Notez que le segment ne peut être positionné que sur une feuille existante. De plus, la largeur et la hauteur du segment peuvent être ajustées automatiquement pour respecter les limites autorisées. |
Spécifications des segments
Spécifications d'un segment.
Représentation JSON |
---|
{ "dataRange": { object ( |
Champs | |
---|---|
dataRange
|
Plage de données du segment. |
filterCriteria
|
Critères de filtrage du segment. |
columnIndex
|
L'index de colonne basé sur zéro dans la table de données à laquelle le filtre est appliqué. |
applyToPivotTables
|
Critère : filtre appliqué aux tableaux croisés dynamiques. Si ce n'est pas le cas, la valeur par défaut est |
title
|
Titre du segment. |
textFormat
|
Format texte du titre dans le segment. Le champ "Lien" n'est pas accepté. |
backgroundColor
|
Couleur d'arrière-plan du segment. Obsolète: utilisez |
backgroundColorStyle
|
Couleur d'arrière-plan du segment. Si |
horizontalAlignment
|
Alignement horizontal du titre dans le segment. Si aucune valeur n'est spécifiée, la valeur par défaut est |