Sheets
Feuille d'une feuille de calcul.
Représentation JSON |
---|
{ "properties": { object ( |
Champs | |
---|---|
properties
|
Propriétés de la feuille. |
data[]
|
Les données de la grille, s'il s'agit d'une feuille de calcul en grille.
Le nombre d'objets GridData renvoyés dépend du nombre de plages demandées sur cette feuille. Par exemple, s'il s'agit de
Pour une feuille |
merges[]
|
Les plages qui sont fusionnées. |
conditionalFormats[]
|
Règles de mise en forme conditionnelle de cette feuille. |
filterViews[]
|
Les vues filtrées de cette feuille. |
protectedRanges[]
|
Plages protégées de cette feuille. |
basicFilter
|
Filtre appliqué à cette feuille, le cas échéant. |
charts[]
|
Spécifications de chaque graphique de cette feuille. |
bandedRanges[]
|
Les plages à 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, triés par ordre croissant de l'indice de début de la plage, puis par profondeur de groupe. |
columnGroups[]
|
Tous les groupes de colonnes de cette feuille, triés par ordre croissant de l'indice de début de la 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 défini, ce champ ne peut plus être modifié. |
title
|
Nom de la feuille. |
index
|
Indice de la feuille dans la feuille de calcul. Lorsque vous ajoutez ou mettez à jour des propriétés de 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 indices de feuille ou insérez des feuilles, le déplacement est pris en compte dans les indices "avant le déplacement". Par exemple, si vous disposez de trois feuilles (S1, S2 et S3), vous devez définir l'index sur 2 pour placer S1 avant S2. Une requête de mise à jour de l'index de la 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 celle-ci est une grille. (Si la feuille est une feuille d'objet, contenant un graphique ou une image, ce champ n'est pas présent.) Lors de l'écriture, il est impossible de définir des propriétés de grille sur des feuilles sans 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
|
"True" si la feuille est au format RTL au lieu d'être au format LTR. |
dataSourceSheetProperties
|
Uniquement en sortie. Si ce champ est présent, il contient des 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 à un DataSource externe 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'interface utilisateur. |
rowGroupControlAfter
|
"True" si le bouton d'activation/de désactivation du regroupement des lignes s'affiche après le groupe. |
columnGroupControlAfter
|
"True" si le bouton d'activation/de désactivation du regroupement des colonnes s'affiche 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 l' |
columns[]
|
Colonnes affichées sur la feuille, correspondant aux valeurs de |
dataExecutionStatus
|
État de l'exécution des données. |
GridData
Les données de la grille, ainsi que les 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 de zéro. |
startColumn
|
Première colonne à laquelle cette GridData fait référence, sur la base de zéro. |
rowData[]
|
Données de la grille, une entrée par ligne, en commençant par la ligne de startRow. Les valeurs de RowData correspondent aux colonnes commençant à |
rowMetadata[]
|
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, 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 (si la dimension est une ligne) ou largeur (si la dimension est 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 valeur 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[]
|
Intervalles mis 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 doit être définie exactement une fois.
rule ne peut être qu'un des éléments suivants:
|
|
booleanRule
|
Le formatage est activé ou désactivé en fonction de la règle. |
gradientRule
|
Le formatage varie en fonction des dégradés de la règle. |
BooleanRule
Règle qui peut ou non correspondre, en fonction de 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. Le formatage conditionnel ne peut appliquer qu'un sous-ensemble de formats : |
GradientRule
Règle qui applique un format d'échelle de couleurs en dégradé, 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 d'interpolation de départ. |
midpoint
|
Point d'interpolation intermédiaire facultatif. |
maxpoint
|
Point d'interpolation final. |
InterpolationPoint
Un seul point d'interpolation sur un format conditionnel de dégradé. Ils épinglent l'échelle de couleurs 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
|
Indique comment la valeur doit être interprétée. |
value
|
Valeur utilisée par ce point d'interpolation. Peut être une formule. Inutilisé 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 de 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 de InterpolationPoint.value .
|
PERCENT
|
Le point d'interpolation correspond au pourcentage donné pour 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) (les erreurs de la plage sont ignorées lors de l'aplatissement).
|
FilterView
Vue filtrée.
Représentation JSON |
---|
{ "filterViewId": integer, "title": string, "range": { object ( |
Champs | |
---|---|
filterViewId
|
ID de la vue de filtre. |
title
|
Nom de la vue de filtre. |
range
|
Plage couverte par cette vue filtrée.
Lors de l'écriture, vous ne pouvez définir qu'un seul des éléments |
namedRangeId
|
Plage nommée sur laquelle repose cette vue filtrée, le cas échéant.
Lors de l'écriture, vous ne pouvez définir qu'un seul des éléments |
tableId
|
Tableau sur lequel repose cette vue filtrée, le cas échéant.
Lors de l'écriture, vous ne pouvez définir qu'un seul des éléments |
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 d'affichage/de masquage des valeurs par colonne. La clé du mappage est l'indice de la colonne, et la valeur correspond aux critères de cette colonne.
Ce champ est obsolète et remplacé par |
filterSpecs[]
|
Critères de filtrage pour afficher/masquer les valeurs par colonne.
|
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égée. La plage peut être totalement illimitée, auquel cas elle est considérée comme une feuille protégée.
Lors de l'écriture, vous ne pouvez définir qu'un seul des éléments |
namedRangeId
|
Plage nommée à laquelle cette plage protégée est associée, le cas échéant.
Lors de l'écriture, vous ne pouvez définir qu'un seul des éléments |
tableId
|
Table sur laquelle repose cette plage protégée, le cas échéant.
Lors de l'écriture, vous ne pouvez définir qu'un seul des éléments |
description
|
Description de cette plage protégée. |
warningOnly
|
"True" si un avertissement s'affiche lorsque cette plage protégée est modifiée. La protection basée sur les avertissements signifie que tous les utilisateurs peuvent modifier les données de la plage protégée, mais qu'un avertissement s'affiche pour demander à l'utilisateur de confirmer la modification.
Lorsque vous écrivez: si ce champ est vrai, 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 compatibles qu'avec les feuilles protégées. |
editors
|
Utilisateurs et 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 |
Rédacteurs
Éditeurs d'une plage protégée.
Représentation JSON |
---|
{ "users": [ string ], "groups": [ string ], "domainUsersCanEdit": boolean } |
Champs | |
---|---|
users[]
|
Adresses e-mail des utilisateurs disposant d'un accès en modification à la plage protégée. |
groups[]
|
Adresses e-mail des groupes disposant d'un accès en modification à la plage protégée. |
domainUsersCanEdit
|
"True" si un utilisateur du domaine du document dispose d'un accès en modification à la plage protégée. La protection de domaine n'est disponible que pour les documents d'un même domaine. |
BasicFilter
Filtre par défaut associé à une feuille.
Représentation JSON |
---|
{ "range": { object ( |
Champs | |
---|---|
range
|
Plage couverte par le filtre. |
tableId
|
Table sur laquelle repose ce filtre, le cas échéant. Lors de l'écriture, vous ne pouvez définir qu'un seul élément |
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 d'affichage/de masquage des valeurs par colonne. La clé du mappage est l'indice de la colonne, et la valeur correspond aux critères de cette colonne.
Ce champ est obsolète et remplacé par |
filterSpecs[]
|
Critères de filtrage par colonne.
|
BandedRange
Plage à bandes (couleurs alternées) dans une feuille.
Représentation JSON |
---|
{ "bandedRangeId": integer, "range": { object ( |
Champs | |
---|---|
bandedRangeId
|
ID de la plage à bandes. |
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 dans toutes les lignes de la plage. Vous devez spécifier au moins l'un des éléments |
columnProperties
|
Propriétés des bandes de colonnes. Ces propriétés sont appliquées colonne par colonne dans toutes les colonnes de la plage. Vous devez spécifier au moins l'un des éléments |
BandingProperties
Propriétés faisant référence à une seule dimension (ligne ou colonne). Si BandedRange.row_properties
et BandedRange.column_properties
sont tous deux définis, les couleurs de remplissage sont appliquées aux cellules conformément aux règles suivantes:
-
headerColor
etfooterColor
ont la priorité sur les couleurs du bracelet. -
firstBandColor
est prioritaire sursecondBandColor
. -
rowProperties
est 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 de 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 de 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. Vous pouvez développer ou réduire un groupe en tant qu'unité sur la feuille.
Représentation JSON |
---|
{
"range": {
object ( |
Champs | |
---|---|
range
|
Plage sur laquelle ce groupe existe. |
depth
|
Profondeur du groupe, qui indique le nombre de groupes dont la plage contient entièrement celle de ce groupe. |
collapsed
|
Ce champ est défini sur "true" si ce groupe est réduit. Un groupe réduit reste réduit si un groupe qui se chevauche à une profondeur moindre 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 placé que sur une feuille existante. De plus, la largeur et la hauteur du sélecteur peuvent être automatiquement ajustées pour rester dans les limites autorisées. |
SlicerSpec
Spécifications d'un outil de segmentation.
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 à partir de 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 du titre dans le sélecteur. Le champ de 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 cette valeur n'est pas spécifiée, elle prend la valeur par défaut de |
Tableau
Un tableau.
Représentation JSON |
---|
{ "tableId": string, "name": string, "range": { object ( |
Champs | |
---|---|
tableId
|
ID de la table. |
name
|
Nom de la table. Il est unique pour toutes les tables de la même feuille de calcul. |
range
|
Plage du tableau. |
rowsProperties
|
Propriétés des lignes du tableau. |
columnProperties[]
|
Propriétés des colonnes 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 de 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 de bandes est remplie avec la couleur spécifiée. Sinon, la première ligne en 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 en bandes est remplie de la couleur spécifiée. Sinon, la deuxième ligne en 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
|
Indice de colonne en base 0. Cet indice est relatif à sa position dans le tableau et n'est pas nécessairement identique à l'indice de colonne de 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 de devise. |
PERCENT
|
Type de colonne "pourcentage". |
DATE
|
Type de colonne de date. |
TIME
|
Type de colonne d'heure. |
DATE_TIME
|
Type de colonne "date et heure". |
TEXT
|
Type de colonne de texte. |
BOOLEAN
|
Type de colonne booléen. |
DROPDOWN
|
Type de colonne déroulante. |
FILES_CHIP
|
Type de colonne défini sur "chip de fichier" |
PEOPLE_CHIP
|
Type de colonne "chip de contact" |
FINANCE_CHIP
|
Type de colonne "chip Finance" |
PLACE_CHIP
|
Type de colonne pour le 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 répondre. N'est valide que si [BooleanCondition.type] est ONE_OF_LIST. |