REST Resource: spreadsheets

Ressource: Feuille de calcul

Ressource représentant 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

Identifiant 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 qui font 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 du développeur associées à une feuille de calcul.
dataSources[]

object (DataSource)

Une liste de sources de données externes connectées à la feuille de calcul.
dataSourceSchedules[]

object (DataSourceRefreshSchedule)

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

SpreadsheetProperties

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)
  },
  "importFunctionsExternalUrlAccessAllowed": boolean
}
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, tel que en

  • Un code de langue ISO 639-2 tel que fil, en l'absence de code 639-1

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

Remarque: Les paramètres régionaux et linguistiques ne sont pas tous pris en charge lors de la mise à jour de ce champ.
autoRecalc

enum (RecalculationInterval)

Délai d'attente avant que les fonctions volatiles soient recalculées.
timeZone

string

Fuseau horaire de la feuille de calcul, au format CLDR (par exemple, 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 ne sera 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 avec un calcul itératif. L'absence de ce champ signifie que les références circulaires entraînent des erreurs de calcul.
spreadsheetTheme

object (SpreadsheetTheme)

Thème appliqué à la feuille de calcul.
importFunctionsExternalUrlAccessAllowed

boolean

Permet d'autoriser ou non l'accès des URL externes pour les fonctions d'image et d'importation. Lecture seule si "true". Si elle est définie sur "false", vous pouvez la définir sur "true".

RecalculationInterval

É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 à chaque modification et toutes les heures.

IterativeCalculationSettings

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

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

integer

Nombre maximal de séries de calculs à effectuer lorsque le calcul itératif est activé.
convergenceThreshold

number

Lorsque le calcul itératif est activé et que la différence entre les résultats successifs est inférieure à cette valeur seuil, le calcul s'arrête.

SpreadsheetTheme

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 effectuer la mise à jour, vous devez fournir toutes les paires de couleurs du thème.

ThemeColorPair

Paire associant un type de couleur de thème de feuille de calcul à la couleur concrète qu'il 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.

NamedRange

Une plage nommée.

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

string

ID de la plage nommée.
name

string

Nom de la plage nommée.
range

object (GridRange)

Plage que cela représente.

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

Identifiant unique de portée feuille de calcul qui identifie la source de données. Exemple: 1080547365.
spec

object (DataSourceSpec)

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

object (DataSourceColumn)

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

integer

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

Lorsque vous créez 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.

DataSourceSpec

Cette option permet d'afficher 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)

Un BigQueryDataSourceSpec.

BigQueryDataSourceSpec

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

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 Google Cloud activé pour BigQuery et 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)

Un BigQueryQuerySpec.
tableSpec

object (BigQueryTableSpec)

Un 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.
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 compatible. (par exemple, un identifiant BigQuery).
Champ d'union value. Valeur du paramètre. value ne peut être qu'un des éléments suivants :
namedRangeId

string

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

object (GridRange)

Une plage qui contient la valeur du paramètre Sa taille doit être de 1 x 1.

DataSourceRefreshSchedule

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

Les sources de données de la feuille de calcul sont actualisées selon un intervalle de temps spécifique. Vous pouvez spécifier l'heure de début en cliquant sur le bouton "Actualisation planifiée" de l'éditeur Sheets, mais l'intervalle est fixé à quatre heures. Par exemple, si vous spécifiez 8 h comme heure de début , 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)

Champ d'application 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 programmation schedule_config ne peuvent être que l'un des éléments suivants:
dailySchedule

object (DataSourceRefreshDailySchedule)

Programmation d'actualisation quotidienne.
weeklySchedule

object (DataSourceRefreshWeeklySchedule)

Programmation d'actualisation hebdomadaire.
monthlySchedule

object (DataSourceRefreshMonthlySchedule)

Programmation d'actualisation mensuelle.

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 leurs objets de sources de données associés dans la feuille de calcul.

DataSourceRefreshDailySchedule

Calendrier d'actualisation des 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 temps pendant lequel l'actualisation d'une source de données est planifiée. Seule la partie hours est utilisée. Par défaut, la taille de l'intervalle de temps est définie 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.

DataSourceRefreshWeeklySchedule

Programmation hebdomadaire de l'actualisation des données certains jours spécifiques d'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 temps pendant lequel l'actualisation d'une source de données est planifiée. Seule la partie hours est utilisée. Par défaut, la taille de l'intervalle de temps est définie dans l'éditeur Sheets.
daysOfWeek[]

enum (DayOfWeek)

Jours de la semaine à actualiser. Vous devez indiquer 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

DataSourceRefreshMonthlySchedule

Planification mensuelle de l'actualisation des données certains jours du mois au cours d'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 temps pendant lequel l'actualisation d'une source de données est planifiée. Seule la partie hours est utilisée. Par défaut, la taille de l'intervalle de temps est définie dans l'éditeur Sheets.
daysOfMonth[]

integer

Jours du mois à actualiser. Seules les valeurs comprises entre 1 et 28 sont acceptées, correspondant au 1er au 28e jour. Vous devez indiquer au moins un jour.

Intervalle

Représente un intervalle de temps encodé en tant que début d'horodatage (inclus) et fin d'horodatage (exclus).

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

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

string (Timestamp format)

Facultatif. Début de l'intervalle inclusif.

Si cet intervalle est spécifié, la valeur de l'horodatage doit être identique ou postérieure au début.
endTime

string (Timestamp format)

Facultatif. Fin exclusive de l'intervalle.

Si cet intervalle est spécifié, l'horodatage doit se trouver avant la fin.

Méthodes

batchUpdate

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

create

 Crée une feuille de calcul et renvoie la feuille de calcul nouvellement créée.

get

 Renvoie la feuille de calcul correspondant à l'identifiant donné.

getByDataFilter

 Renvoie la feuille de calcul correspondant à l'identifiant donné.