REST Resource: spreadsheets

Ressource: Feuille de calcul

Ressource qui représente une feuille de calcul.

Représentation JSON 
{
  "spreadsheetId": string,
  "properties": {
    object (SpreadsheetProperties)
  },
  "sheets": [
    {
      object (Sheet)
    }
  ],
  "namedRanges": [
    {
      object (NamedRange)
    }
  ],
  "spreadsheetUrl": string,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSources": [
    {
      object (DataSource)
    }
  ],
  "dataSourceSchedules": [
    {
      object (DataSourceRefreshSchedule)
    }
  ]
}
Champs
spreadsheetId

string

ID de la feuille de calcul. Ce champ est en lecture seule.
properties

object (SpreadsheetProperties)

Propriétés générales d'une feuille de calcul.
sheets[]

object (Sheet)

Feuilles faisant partie d'une feuille de calcul.
namedRanges[]

object (NamedRange)

Plages nommées définies dans une feuille de calcul.
spreadsheetUrl

string

URL de la feuille de calcul. Ce champ est en lecture seule.
developerMetadata[]

object (DeveloperMetadata)

Métadonnées pour les développeurs associées à une feuille de calcul.
dataSources[]

object (DataSource)

Liste des sources de données externes associées à la feuille de calcul.
dataSourceSchedules[]

object (DataSourceRefreshSchedule)

Uniquement en sortie. Liste des programmations d'actualisation de la source de données.

Propriétés des feuilles de calcul

Propriétés d'une feuille de calcul.

Représentation JSON 
{
  "title": string,
  "locale": string,
  "autoRecalc": enum (RecalculationInterval),
  "timeZone": string,
  "defaultFormat": {
    object (CellFormat)
  },
  "iterativeCalculationSettings": {
    object (IterativeCalculationSettings)
  },
  "spreadsheetTheme": {
    object (SpreadsheetTheme)
  }
}
Champs
title

string

Titre de la feuille de calcul.
locale

string

Paramètres régionaux de la feuille de calcul dans l'un des formats suivants:

  • Un code de langue ISO 639-1, par exemple en

  • Un code de langue ISO 639-2, par exemple fil, si aucun code 639-1 n'existe

  • Une combinaison du code de langue ISO et du code pays, par exemple en_US

Remarque: Lors de la mise à jour de ce champ, les paramètres régionaux/langues ne sont pas tous pris en charge.
autoRecalc

enum (RecalculationInterval)

Délai d'attente avant le recalcul des fonctions volatiles.
timeZone

string

Fuseau horaire de la feuille de calcul, au format CLDR tel que America/New_York. Si le fuseau horaire n'est pas reconnu, il peut s'agir d'un fuseau horaire personnalisé tel que GMT-07:00.
defaultFormat

object (CellFormat)

Format par défaut de toutes les cellules de la feuille de calcul. CellData.effectiveFormat n'est pas défini si le format de la cellule est égal à ce format par défaut. Ce champ est en lecture seule.
iterativeCalculationSettings

object (IterativeCalculationSettings)

Détermine si et comment les références circulaires sont résolues grâce à un calcul itératif. L'absence de ce champ signifie que les références circulaires génèrent des erreurs de calcul.
spreadsheetTheme

object (SpreadsheetTheme)

Thème appliqué à la feuille de calcul.

Intervalle de recalcul

Énumération des options d'intervalle de recalcul possibles.

Enums
RECALCULATION_INTERVAL_UNSPECIFIED Valeur par défaut. Cette valeur ne doit pas être utilisée.
ON_CHANGE Les fonctions volatiles sont mises à jour à chaque modification.
MINUTE Les fonctions volatiles sont mises à jour à chaque modification et chaque minute.
HOUR Les fonctions volatiles sont mises à jour toutes les heures.

Paramètres de calcul itératif

Paramètres permettant de contrôler la façon dont les dépendances circulaires sont résolues par un calcul itératif.

Représentation JSON 
{
  "maxIterations": integer,
  "convergenceThreshold": number
}
Champs
maxIterations

integer

Lorsque le calcul itératif est activé, le nombre maximal de cycles de calcul à effectuer.
convergenceThreshold

number

Lorsque le calcul itératif est activé et que les résultats successifs sont inférieurs à cette valeur de seuil, les arrondis des calculs s'arrêtent.

Thème Feuille de calcul

Représente le thème de la feuille de calcul

Représentation JSON 
{
  "primaryFontFamily": string,
  "themeColors": [
    {
      object (ThemeColorPair)
    }
  ]
}
Champs
primaryFontFamily

string

Nom de la famille de polices principale.
themeColors[]

object (ThemeColorPair)

Paires de couleurs du thème de la feuille de calcul. Pour procéder à la mise à jour, vous devez indiquer toutes les paires de couleurs du thème.

Paire de couleurs du thème

Paire entre un type de couleur de thème de feuille de calcul et la couleur concrète qu'elle représente.

Représentation JSON 
{
  "colorType": enum (ThemeColorType),
  "color": {
    object (ColorStyle)
  }
}
Champs
colorType

enum (ThemeColorType)

Type de couleur du thème de la feuille de calcul.
color

object (ColorStyle)

Couleur concrète correspondant au type de couleur du thème.

Plage nommée

Une plage nommée.

Représentation JSON 
{
  "namedRangeId": string,
  "name": string,
  "range": {
    object (GridRange)
  }
}
Champs
namedRangeId

string

Identifiant de la plage nommée.
name

string

Nom de la plage nommée.
range

object (GridRange)

Plage représentée.

DataSource

Informations sur une source de données externe dans la feuille de calcul.

Représentation JSON 
{
  "dataSourceId": string,
  "spec": {
    object (DataSourceSpec)
  },
  "calculatedColumns": [
    {
      object (DataSourceColumn)
    }
  ],
  "sheetId": integer
}
Champs
dataSourceId

string

ID unique au niveau de la feuille de calcul qui identifie la source de données. Exemple: 1080547365.
spec

object (DataSourceSpec)

DataSourceSpec pour la source de données connectée à cette feuille de calcul.
calculatedColumns[]

object (DataSourceColumn)

Toutes les colonnes calculées dans la source de données.
sheetId

integer

L'ID de Sheet connecté à la source de données Une fois défini, le champ ne peut plus être modifié.

Lors de la création d'une source de données, une feuille DATA_SOURCE associée est également créée. Si le champ n'est pas spécifié, l'ID de la feuille créée est généré de manière aléatoire.

Spécifications des sources de données

Cette option permet d'indiquer les détails de la source de données. Par exemple, pour BigQuery, il s'agit d'informations sur la source BigQuery.

Représentation JSON 
{
  "parameters": [
    {
      object (DataSourceParameter)
    }
  ],

  // Union field spec can be only one of the following:
  "bigQuery": {
    object (BigQueryDataSourceSpec)
  }
  // End of list of possible types for union field spec.
}
Champs
parameters[]

object (DataSourceParameter)

Paramètres de la source de données, utilisés lors de l'interrogation de la source de données.
Champ d'union spec. Spécification réelle par type de source de données. spec ne peut être qu'un des éléments suivants :
bigQuery

object (BigQueryDataSourceSpec)

Une BigQueryDataSourceSpec.

BigQueryDataSourceSpec

Spécification d'une source de données BigQuery connectée à une feuille de calcul.

Représentation JSON 
{
  "projectId": string,

  // Union field spec can be only one of the following:
  "querySpec": {
    object (BigQueryQuerySpec)
  },
  "tableSpec": {
    object (BigQueryTableSpec)
  }
  // End of list of possible types for union field spec.
}
Champs
projectId

string

ID d'un projet GCP BigQuery associé à un compte de facturation. Pour toute requête exécutée sur la source de données, le projet est facturé.
Champ d'union spec. Spécification réelle. spec ne peut être qu'un des éléments suivants :
querySpec

object (BigQueryQuerySpec)

Une BigQueryQuerySpec.
tableSpec

object (BigQueryTableSpec)

Une BigQueryTableSpec.

BigQueryQuerySpec

Spécifie une requête BigQuery personnalisée.

Représentation JSON 
{
  "rawQuery": string
}
Champs
rawQuery

string

Chaîne de requête brute.

BigQueryTableSpec

Spécifie une définition de table BigQuery. Seules les tables natives sont autorisées.

Représentation JSON 
{
  "tableProjectId": string,
  "tableId": string,
  "datasetId": string
}
Champs
tableProjectId

string

ID d'un projet BigQuery auquel la table appartient. Si aucune valeur n'est spécifiée, la valeur projectId est utilisée par défaut.
tableId

string

ID de la table BigQuery.
datasetId

string

ID de l'ensemble de données BigQuery.

DataSourceParameter

Paramètre dans la requête d'une source de données. Ce paramètre permet à l'utilisateur de transmettre des valeurs de la feuille de calcul dans une requête.

Représentation JSON 
{

  // Union field identifier can be only one of the following:
  "name": string
  // End of list of possible types for union field identifier.

  // Union field value can be only one of the following:
  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
  // End of list of possible types for union field value.
}
Champs
Champ d'union identifier. Identifiant du paramètre. identifier ne peut être qu'un des éléments suivants :
name

string

Paramètre nommé. Il doit s'agir d'un identifiant légitime pour le DataSource qui le prend en charge. Par exemple, identifiant BigQuery.
Champ d'union value. Valeur du paramètre. value ne peut être qu'un des éléments suivants :
namedRangeId

string

ID d'une NamedRange. Sa taille doit être 1 x 1.
range

object (GridRange)

Plage contenant la valeur du paramètre. Sa taille doit être 1 x 1.

Actualisation de la source de données

Planifier l'actualisation de la source de données.

Les sources de données de la feuille de calcul sont actualisées au cours d'un intervalle de temps. Vous pouvez spécifier l'heure de début en cliquant sur le bouton d'actualisation programmée de l'éditeur Sheets, mais l'intervalle est fixe : 4 heures. Par exemple, si vous définissez l'heure de début à 8 h du matin , l'actualisation aura lieu tous les jours entre 8 h et 12 h.

Représentation JSON 
{
  "enabled": boolean,
  "refreshScope": enum (DataSourceRefreshScope),
  "nextRun": {
    object (Interval)
  },

  // Union field schedule_config can be only one of the following:
  "dailySchedule": {
    object (DataSourceRefreshDailySchedule)
  },
  "weeklySchedule": {
    object (DataSourceRefreshWeeklySchedule)
  },
  "monthlySchedule": {
    object (DataSourceRefreshMonthlySchedule)
  }
  // End of list of possible types for union field schedule_config.
}
Champs
enabled

boolean

True si la planification d'actualisation est activée, ou false dans le cas contraire.
refreshScope

enum (DataSourceRefreshScope)

Portée de l'actualisation doit être ALL_DATA_SOURCES
nextRun

object (Interval)

Uniquement en sortie. Intervalle de temps de la prochaine exécution.
Champ d'union schedule_config. Les configurations de planification schedule_config ne peuvent être que l'un des éléments suivants:
dailySchedule

object (DataSourceRefreshDailySchedule)

Calendrier d'actualisation quotidien.
weeklySchedule

object (DataSourceRefreshWeeklySchedule)

Programmation d'actualisation hebdomadaire.
monthlySchedule

object (DataSourceRefreshMonthlySchedule)

Calendrier d'actualisation mensuel.

DataSourceRefreshScope

Champs d'application de l'actualisation de la source de données.

Enums
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED Valeur par défaut, ne pas utiliser.
ALL_DATA_SOURCES Actualise toutes les sources de données et les objets de sources de données associés dans la feuille de calcul.

Actualisation quotidienne de la source de données

Un calendrier pour actualiser les données tous les jours dans un intervalle de temps donné.

Représentation JSON 
{
  "startTime": {
    object (TimeOfDay)
  }
}
Champs
startTime

object (TimeOfDay)

Heure de début d'un intervalle de planification de l'actualisation d'une source de données. Seule hours partie est utilisée. La taille de l'intervalle de temps est définie par défaut sur celle indiquée dans l'éditeur Sheets.

TimeOfDay

Représente une heure de la journée. La date et le fuseau horaire sont spécifiés ailleurs, ou ne sont pas significatifs. Une API peut choisir d'autoriser des secondes intercalaires. Les types associés sont google.type.Date et google.protobuf.Timestamp.

Représentation JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Champs
hours

integer

Heure de la journée au format 24 heures. Elle doit être comprise entre 0 à 23. Une API peut choisir d'autoriser la valeur "24:00:00" pour des cas tels que l'heure de fermeture des bureaux.
minutes

integer

Minutes de l'heure de la journée. Elles doivent être comprises entre 0 à 59.
seconds

integer

Secondes de l'heure de la journée. Elles doivent normalement être comprises entre 0 et 59. Une API peut autoriser la valeur 60 si elle autorise les secondes intercalaires.
nanos

integer

Fractions de secondes en nanosecondes. La valeur doit être comprise entre 0 et 999 999 999.

Source de données Actualisation hebdomadaire

Un calendrier hebdomadaire pour actualiser les données sur des jours spécifiques dans un intervalle de temps donné.

Représentation JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
Champs
startTime

object (TimeOfDay)

Heure de début d'un intervalle de planification de l'actualisation d'une source de données. Seule hours partie est utilisée. La taille de l'intervalle de temps est définie par défaut sur celle indiquée dans l'éditeur Sheets.
daysOfWeek[]

enum (DayOfWeek)

Jours de la semaine à actualiser. Vous devez spécifier au moins un jour.

DayOfWeek

Représente un jour de la semaine.

Enums
DAY_OF_WEEK_UNSPECIFIED Le jour de la semaine n'est pas spécifié.
MONDAY Lundi
TUESDAY Mardi
WEDNESDAY Mercredi
THURSDAY Jeudi
FRIDAY Vendredi
SATURDAY Samedi
SUNDAY Dimanche

Actualisation des données par mois

Programmation mensuelle pour l'actualisation des données les jours du mois, selon un intervalle de temps donné.

Représentation JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfMonth": [
    integer
  ]
}
Champs
startTime

object (TimeOfDay)

Heure de début d'un intervalle de planification de l'actualisation d'une source de données. Seule hours partie est utilisée. La taille de l'intervalle de temps est définie par défaut sur celle indiquée dans l'éditeur Sheets.
daysOfMonth[]

integer

Jours du mois à actualiser. Seules les valeurs 1 à 28 sont prises en charge, en partant du 1er au 28. Vous devez spécifier au moins un jour.

Intervalle

Représente un intervalle de temps, encodé sous la forme d'un code temporel de début (inclus) et d'un code temporel de fin (exclusif).

Le début doit être inférieur ou égal à la fin. Lorsque le début correspond à la fin, l'intervalle est vide (ne correspond pas à une heure). Lorsque le début et la fin ne sont pas spécifiés, l'intervalle correspond à tout moment.

Représentation JSON 
{
  "startTime": string,
  "endTime": string
}
Champs
startTime

string (Timestamp format)

Facultatif. Début inclusif de l'intervalle.

Si cette valeur est spécifiée, un horodatage correspondant à cet intervalle devra être identique ou postérieure au début.
endTime

string (Timestamp format)

Facultatif. Fin de l'intervalle exclusive.

Si cette valeur est spécifiée, le code temporel correspondant à cet intervalle doit être antérieur à la fin.

Méthodes

batchUpdate

 Applique une ou plusieurs mises à jour à la feuille de calcul.

create

 Crée une feuille de calcul, en renvoyant celle que vous venez de créer.

get

 Renvoie la feuille de calcul à l'ID indiqué.

getByDataFilter

 Renvoie la feuille de calcul à l'ID indiqué.