REST Resource: spreadsheets

Ressource : Spreadsheet

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)
    }
  ],
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "commentsViewMode": enum (CommentsViewMode)
}
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 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)

Liste des 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.
comments[]

object (CommentThread)

Fils de commentaires associés à la feuille de calcul.
commentsViewMode

enum (CommentsViewMode)

Uniquement en sortie. Mode d'affichage des commentaires appliqué à la feuille de calcul.

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, si aucun code 639-1 n'existe.

  • une combinaison du code de langue et du code pays ISO, comme en_US.

Remarque : Lorsque vous mettez à jour ce champ, toutes les langues/locales ne sont pas acceptées.
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 (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 le 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

Indique si l'accès aux URL externes est autorisé pour les fonctions d'image et d'importation. Lecture seule lorsque la valeur est "true". Si la valeur est "false", vous pouvez la définir sur "true". Cette valeur sera ignorée et renverra toujours "true" si l'administrateur a activé la fonctionnalité d'ajout à la liste d'autorisation.

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 toutes les minutes.
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 avec le calcul itératif.

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

integer

Lorsque le calcul itératif est activé, il s'agit du nombre maximal de cycles de calcul à effectuer.
convergenceThreshold

number

Lorsque le calcul itératif est activé et que les résultats successifs diffèrent de moins que cette valeur seuil, les calculs sont arrondis.

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 une 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

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

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

object (DataSourceSpec)

L'DataSourceSpec de la source de données associée à cette feuille de calcul.
calculatedColumns[]

object (DataSourceColumn)

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

integer

ID de Sheet associé à la source de données. Une fois défini, ce 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.

DataSourceSpec

Cette section spécifie les détails de la source de données. Par exemple, pour BigQuery, cela spécifie des informations sur la source BigQuery.

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

  "bigQuery": {
    object (BigQueryDataSourceSpec)
  },
  "looker": {
    object (LookerDataSourceSpec)
  }
}
Champs
parameters[]

object (DataSourceParameter)

Paramètres de la source de données, utilisés lors de l'interrogation de la source de données.
Spécification réelle par type de source de données. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
bigQuery

object (BigQueryDataSourceSpec)

BigQueryDataSourceSpec
looker

object (LookerDataSourceSpec)

[LookerDatasourceSpec][].
Fin des champs qui s'excluent mutuellement.

BigQueryDataSourceSpec

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

Représentation JSON 
{
  "projectId": string,

  "querySpec": {
    object (BigQueryQuerySpec)
  },
  "tableSpec": {
    object (BigQueryTableSpec)
  }
}
Champs
projectId

string

ID d'un projet Google Cloud compatible avec BigQuery et associé à un compte de facturation. Le projet est facturé pour toutes les requêtes exécutées sur la source de données.
Spécification réelle. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
querySpec

object (BigQueryQuerySpec)

BigQueryQuerySpec
tableSpec

object (BigQueryTableSpec)

BigQueryTableSpec
Fin des champs qui s'excluent mutuellement.

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 appartient la table. Si aucune valeur n'est spécifiée, la valeur projectId est déduite.
tableId

string

ID de la table BigQuery.
datasetId

string

ID de l'ensemble de données BigQuery.

LookerDataSourceSpec

Spécification d'une source de données Looker.

Représentation JSON 
{
  "instanceUri": string,
  "model": string,
  "explore": string
}
Champs
instanceUri

string

URL d'une instance Looker.
model

string

Nom d'un modèle Looker.
explore

string

Nom d'une exploration de modèle Looker.

DataSourceParameter

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

Représentation JSON 
{

  "name": string

  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
}
Champs
Identifiant du paramètre. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
name

string

Paramètre nommé. Doit être un identifiant légitime pour le DataSource qui le prend en charge. Par exemple, identifiant BigQuery.
Fin des champs qui s'excluent mutuellement.
Valeur du paramètre. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
namedRangeId

string

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

object (GridRange)

Plage contenant la valeur du paramètre. Sa taille doit être de 1 x 1.
Fin des champs qui s'excluent mutuellement.

DataSourceRefreshSchedule

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

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

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

  "dailySchedule": {
    object (DataSourceRefreshDailySchedule)
  },
  "weeklySchedule": {
    object (DataSourceRefreshWeeklySchedule)
  },
  "monthlySchedule": {
    object (DataSourceRefreshMonthlySchedule)
  }
}
Champs
enabled

boolean

"True" si le programme d'actualisation est activé, 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.
Configurations de planification Voici une liste de champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
dailySchedule

object (DataSourceRefreshDailySchedule)

Planning d'actualisation quotidienne.
weeklySchedule

object (DataSourceRefreshWeeklySchedule)

Calendrier d'actualisation hebdomadaire.
monthlySchedule

object (DataSourceRefreshMonthlySchedule)

Calendrier d'actualisation mensuelle.
Fin des champs qui s'excluent mutuellement.

DataSourceRefreshScope

Les niveaux d'actualisation des sources 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 associés dans la feuille de calcul.

DataSourceRefreshDailySchedule

Une programmation pour actualiser les données tous les jours à un intervalle de temps donné.

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

object (TimeOfDay)

Heure de début d'un intervalle de temps dans lequel l'actualisation d'une source de données est planifiée. Seule la partie hours est utilisée. La taille de l'intervalle de temps est définie par défaut sur celle de 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

Heures d'une journée au format 24 heures. Doit être supérieur ou égal à 0 et généralement inférieur ou égal à 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 d'une heure. Doit être supérieur ou égal à 0 et inférieur ou égal à 59.
seconds

integer

Secondes d'une minute. Doit être supérieur ou égal à 0 et généralement inférieur ou égal à 59. Une API peut autoriser la valeur 60 si elle autorise les secondes intercalaires.
nanos

integer

Fractions de secondes, en nanosecondes. Doit être supérieur ou égal à 0 et inférieur ou égal à 999 999 999.

DataSourceRefreshWeeklySchedule

Une programmation hebdomadaire pour l'actualisation des données à des 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 dans lequel l'actualisation d'une source de données est planifiée. Seule la partie hours est utilisée. La taille de l'intervalle de temps est définie par défaut sur celle de l'éditeur Sheets.
daysOfWeek[]

enum (DayOfWeek)

Jours de la semaine pour lesquels actualiser les données. 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

DataSourceRefreshMonthlySchedule

Programmation mensuelle pour l'actualisation des données à des jours spécifiques du mois, dans 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 dans lequel l'actualisation d'une source de données est planifiée. Seule la partie hours est utilisée. La taille de l'intervalle de temps est définie par défaut sur celle de l'éditeur Sheets.
daysOfMonth[]

integer

Jours du mois pour l'actualisation. Seules les valeurs comprises entre 1 et 28 sont acceptées, correspondant au 1er et au 28e jour. 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 (inclusif) et d'un code temporel de fin (exclusif).

La valeur de début doit être inférieure ou égale à celle de fin. Lorsque la valeur de début est la même que la valeur de fin, l'intervalle est vide (il ne correspond à aucune durée). Lorsque les heures de début et de fin ne sont pas spécifiées, l'intervalle couvre toutes les heures.

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

string (Timestamp format)

Facultatif. Valeur de début (inclusive) de l'intervalle.

Si elle est spécifiée, un code temporel correspondant à cet intervalle devra être égal ou postérieur à l'heure de début.
endTime

string (Timestamp format)

Facultatif. Valeur de fin (exclusive) de l'intervalle.

Si elle est spécifiée, un code temporel correspondant à cet intervalle devra être antérieur à l'heure de fin.

CommentThread

Représente un fil de discussion unique dans une feuille de calcul.

Représentation JSON 
{
  "commentId": string,
  "anchorId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),

  "plainTextQuote": string
}
Champs
commentId

string

Identifiant unique du fil de discussion.
anchorId

string

ID de la CommentAnchor de la feuille à laquelle ce thread est associé.
headPost

object (Post)

Premier post du fil de discussion.
replies[]

object (Post)

Réponses au post principal.
status

enum (Status)

Indique si le fil de discussion est ouvert ou résolu.
Texte cité du document au moment de la création du commentaire. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
plainTextQuote

string

Texte cité de la feuille de calcul au moment de la création du commentaire, mis en forme en texte brut.
Fin des champs qui s'excluent mutuellement.

Publier

Représente un seul post dans un fil de commentaires.

Représentation JSON 
{
  "postId": string,
  "content": string,
  "contentHtml": string,
  "author": {
    object (PostAuthor)
  },
  "createTime": string,
  "updateTime": string,
  "deleted": boolean,
  "fromImportedSpreadsheet": boolean,
  "fromCopiedSpreadsheet": boolean,
  "assigneeEmail": string,
  "commentAction": enum (CommentActionType)
}
Champs
postId

string

Uniquement en sortie. Identifiant unique du post.
content

string

Contenu du post.

Obligatoire et non vide si commentAction n'est pas RESOLVE ni REOPEN.

Ce contenu textuel sera traité de la même manière que les commentaires créés dans l'éditeur Sheets. Il aura des comportements similaires pour la mise en forme, les notifications, etc.

Ne doit pas dépasser 2 048 unités de code UTF-8.
contentHtml

string

Uniquement en sortie. Contenu du post au format HTML.
author

object (PostAuthor)

Uniquement en sortie. Utilisateur qui a créé le post.
createTime

string (Timestamp format)

Uniquement en sortie. Heure de création du post.
updateTime

string (Timestamp format)

Uniquement en sortie. Date et heure de la dernière mise à jour du post.
deleted

boolean

Uniquement en sortie. Indique si le post a été supprimé. Si true, les champs content et author seront vides.
fromImportedSpreadsheet

boolean

Uniquement en sortie. Indique si le post provient d'une feuille de calcul importée. Ce champ ne peut pas être défini directement par les appelants.
fromCopiedSpreadsheet

boolean

Uniquement en sortie. Indique si le post provient d'une feuille de calcul copiée. Ce champ ne peut pas être défini directement par les appelants.
assigneeEmail

string

Facultatif. Adresse e-mail de l'utilisateur qui est nouvellement attribué au fil de discussion dans ce post.

Renvoie une erreur 400 (requête incorrecte) si :

  • Le thread parent est un CommentThread dont le headPost n'a pas d'attributaire.

  • commentAction est spécifié comme RESOLVE ou REOPEN.

  • assigneeEmail dépasse 2 048 unités de code UTF-8.
commentAction

enum (CommentActionType)

Action effectuée lors de la création du post.

PostAuthor

Représente un utilisateur qui a créé un post de commentaire.

Représentation JSON 
{
  "displayName": string,
  "me": boolean,
  "anonymous": boolean,
  "user": string
}
Champs
displayName

string

Nom à afficher de l'utilisateur. Peut être absent si l'auteur est anonyme.
me

boolean

Indique si l'utilisateur est l'utilisateur authentifié qui effectue la demande.
anonymous

boolean

Indique si l'utilisateur est anonyme.
user

string

Nom de ressource de l'utilisateur auteur du post, qui peut également être utilisé pour identifier l'utilisateur dans l'API Google People. Format : users/{user}. Ne sera pas renseigné si le champ "Anonyme" est défini sur true ou si le post provient d'une feuille de calcul importée.

CommentActionType

Action effectuée avec cette réponse à un fil de commentaires.

Enums
COMMENT_ACTION_TYPE_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
NO_COMMENT_ACTION_CHANGE Aucune modification d'action dans ce post.
RESOLVE Ce post clôture le fil de discussion.
REOPEN Ce post rouvre le fil de discussion.

État

Options d'état du fil de discussion.

Enums
STATUS_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
OPEN Le fil de commentaires est ouvert.
RESOLVED Le fil de commentaires est résolu.

CommentsViewMode

Mode d'affichage des commentaires appliqué à la feuille de calcul, qui indique si les commentaires sont inclus. Il propose des options pour lire la feuille de calcul avec ou sans commentaires et ancres de commentaires.

Enums
COMMENTS_VIEW_MODE_UNSPECIFIED Le CommentsViewMode n'est pas spécifié. COMMENTS_VIEW_MODE_OMITTED est appliqué.
COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS Le mode d'affichage des commentaires appliqué à la feuille de calcul renvoyée dépend du niveau d'accès actuel de l'utilisateur. Si l'utilisateur ne dispose que d'un accès en lecture seule, COMMENTS_VIEW_MODE_OMITTED est appliqué. Sinon, COMMENTS_VIEW_MODE_INCLUDED est appliqué.
COMMENTS_VIEW_MODE_OMITTED Les commentaires sont omis de la feuille de calcul renvoyée.
COMMENTS_VIEW_MODE_INCLUDED

La feuille de calcul renvoyée inclut des commentaires.

Les requêtes visant à récupérer une feuille de calcul à l'aide de ce mode renverront une erreur 403 si l'utilisateur n'est pas autorisé à afficher les commentaires.

Méthodes

batchUpdate

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

create

 Crée une feuille de calcul et l'affiche.

get

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

getByDataFilter

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