consulter et modifier la feuille d'une source de données existante ; Pour créer une feuille de source de données, utilisez Spreadsheet.insertDataSourceSheet(spec)
.
N'utilisez cette classe qu'avec des données connectées à une base de données.
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addFilter(columnName, filterCriteria) | DataSourceSheet | Ajoute un filtre appliqué à la feuille de la source de données. |
asSheet() | Sheet | Renvoie la feuille de la source de données en tant qu'objet "feuille" standard. |
autoResizeColumn(columnName) | DataSourceSheet | Redimensionne automatiquement la largeur de la colonne spécifiée. |
autoResizeColumns(columnNames) | DataSourceSheet | Redimensionne automatiquement la largeur des colonnes spécifiées. |
cancelDataRefresh() | DataSourceSheet | Annule l'actualisation des données associées à cet objet s'il est en cours d'exécution. |
forceRefreshData() | DataSourceSheet | Actualise les données de cet objet, quel que soit l'état actuel. |
getColumnWidth(columnName) | Integer | Renvoie la largeur de la colonne spécifiée. |
getDataSource() | DataSource | Récupère la source de données à laquelle l'objet est associé. |
getFilters() | DataSourceSheetFilter[] | Renvoie tous les filtres appliqués à la feuille de la source de données. |
getSheetValues(columnName) | Object[] | Renvoie toutes les valeurs de la feuille de source de données pour le nom de colonne fourni. |
getSheetValues(columnName, startRow, numRows) | Object[] | Renvoie toutes les valeurs de la feuille de source de données pour le nom de colonne fourni, à partir de la ligne de début fournie (based-1) et jusqu'au numRows fourni. |
getSortSpecs() | SortSpec[] | Récupère toutes les spécifications de tri dans la feuille de la source de données. |
getStatus() | DataExecutionStatus | Récupère l'état d'exécution des données de l'objet. |
refreshData() | DataSourceSheet | Actualise les données de l'objet. |
removeFilters(columnName) | DataSourceSheet | Supprime tous les filtres appliqués à la colonne de la feuille de source de données. |
removeSortSpec(columnName) | DataSourceSheet | Supprime les spécifications de tri d'une colonne de la feuille de la source de données. |
setColumnWidth(columnName, width) | DataSourceSheet | Définit la largeur de la colonne spécifiée. |
setColumnWidths(columnNames, width) | DataSourceSheet | Définit la largeur des colonnes spécifiées. |
setSortSpec(columnName, ascending) | DataSourceSheet | Définit les spécifications de tri d'une colonne de la feuille de la source de données. |
setSortSpec(columnName, sortOrder) | DataSourceSheet | Définit les spécifications de tri d'une colonne de la feuille de la source de données. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Attend la fin de l'exécution en cours, qui expire après le nombre de secondes spécifié. |
Documentation détaillée
addFilter(columnName, filterCriteria)
Ajoute un filtre appliqué à la feuille de la source de données.
Paramètres
Nom | Type | Description |
---|---|---|
columnName | String | Nom de la colonne à laquelle appliquer ce filtre. |
filterCriteria | FilterCriteria | Critères de filtre à appliquer. |
Renvois
DataSourceSheet
: feuille de source de données, pour le chaînage de méthodes.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
asSheet()
Renvoie la feuille de la source de données en tant qu'objet "feuille" standard.
Renvois
Sheet
: feuille standard.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
autoResizeColumn(columnName)
Redimensionne automatiquement la largeur de la colonne spécifiée.
Paramètres
Nom | Type | Description |
---|---|---|
columnName | String | Nom de la colonne. |
Renvois
DataSourceSheet
: feuille de source de données utilisée pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
autoResizeColumns(columnNames)
Redimensionne automatiquement la largeur des colonnes spécifiées.
Paramètres
Nom | Type | Description |
---|---|---|
columnNames | String[] | Liste des noms de colonnes à mettre à jour. |
Renvois
DataSourceSheet
: feuille de source de données utilisée pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
cancelDataRefresh()
Annule l'actualisation des données associées à cet objet s'il est en cours d'exécution.
Cet exemple montre comment annuler l'actualisation d'une formule.
const spreadsheet = SpreadsheetApp.getActive(); const formula = spreadsheet.getDataSourceFormulas()[0]; // Cancel the ongoing refresh on the formula. formula.cancelDataRefresh();
Une exception est générée si le type de source de données n'est pas activé. Utilisez les méthodes
SpreadsheetApp#enable...Execution()
afin d'activer l'exécution des données pour un type de source de données spécifique.
Renvois
DataSourceSheet
: objet de données
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
forceRefreshData()
Actualise les données de cet objet, quel que soit l'état actuel. Pour en savoir plus, consultez refreshData()
. Si vous souhaitez annuler une actualisation en cours de cet objet, consultez cancelDataRefresh()
.
Une exception est générée si le type de source de données n'est pas activé. Utilisez les méthodes SpreadsheetApp#enable...Execution()
afin d'activer l'exécution des données pour un type de source de données spécifique.
Renvois
DataSourceSheet
: objet de données
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumnWidth(columnName)
Renvoie la largeur de la colonne spécifiée.
Paramètres
Nom | Type | Description |
---|---|---|
columnName | String | Nom de la colonne. |
Renvois
Integer
: largeur de la colonne, ou null
si la colonne utilise la largeur par défaut.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSource()
Récupère la source de données à laquelle l'objet est associé.
Renvois
DataSource
: source de données.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFilters()
Renvoie tous les filtres appliqués à la feuille de la source de données.
Renvois
DataSourceSheetFilter[]
: tableau de l'ensemble des filtres appliqués à la feuille de la source de données.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheetValues(columnName)
Renvoie toutes les valeurs de la feuille de source de données pour le nom de colonne fourni.
Paramètres
Nom | Type | Description |
---|---|---|
columnName | String | Nom de la colonne de la source de données pour laquelle extraire des valeurs. |
Renvois
Object[]
: tableau de valeurs unidimensionnel.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheetValues(columnName, startRow, numRows)
Renvoie toutes les valeurs de la feuille de source de données pour le nom de colonne fourni, à partir de la ligne de début fournie (based-1) et jusqu'au numRows
fourni.
Paramètres
Nom | Type | Description |
---|---|---|
columnName | String | Nom de la colonne de la source de données pour laquelle extraire des valeurs. |
startRow | Integer | Position de la ligne à partir de laquelle commencer la récupération des valeurs. |
numRows | Integer | Nombre de lignes à récupérer. |
Renvois
Object[]
: tableau de valeurs unidimensionnel.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSortSpecs()
Récupère toutes les spécifications de tri dans la feuille de la source de données.
Renvois
SortSpec[]
: liste de spécifications de tri.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getStatus()
Récupère l'état d'exécution des données de l'objet.
Renvois
DataExecutionStatus
: état d'exécution des données.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
refreshData()
Actualise les données de l'objet.
Génère une exception si l'état actuel est error
. Utilisez DataSource#updateSpec()
pour mettre à jour la spécification. Cette méthode est préférable à forceRefreshData()
pour éviter les modifications inattendues de la source de données.
Une exception est générée si le type de source de données n'est pas activé. Utilisez les méthodes SpreadsheetApp#enable...Execution()
afin d'activer l'exécution des données pour un type de source de données spécifique.
Renvois
DataSourceSheet
: objet de données
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeFilters(columnName)
Supprime tous les filtres appliqués à la colonne de la feuille de source de données.
Paramètres
Nom | Type | Description |
---|---|---|
columnName | String | Nom de la colonne dont vous souhaitez supprimer les filtres. |
Renvois
DataSourceSheet
: feuille de source de données, pour le chaînage de méthodes.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeSortSpec(columnName)
Supprime les spécifications de tri d'une colonne de la feuille de la source de données.
Paramètres
Nom | Type | Description |
---|---|---|
columnName | String | Nom de la colonne. |
Renvois
DataSourceSheet
: feuille de la source de données, pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setColumnWidth(columnName, width)
Définit la largeur de la colonne spécifiée.
Paramètres
Nom | Type | Description |
---|---|---|
columnName | String | Nom de la colonne. |
width | Integer | Nouvelle largeur de la colonne. |
Renvois
DataSourceSheet
: feuille de source de données utilisée pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setColumnWidths(columnNames, width)
Définit la largeur des colonnes spécifiées.
Paramètres
Nom | Type | Description |
---|---|---|
columnNames | String[] | Liste des noms de colonnes à mettre à jour. |
width | Integer | Nouvelle largeur des colonnes. |
Renvois
DataSourceSheet
: feuille de source de données utilisée pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setSortSpec(columnName, ascending)
Définit les spécifications de tri d'une colonne de la feuille de la source de données.
Paramètres
Nom | Type | Description |
---|---|---|
columnName | String | Nom de la colonne à trier. |
ascending | Boolean | Si la valeur est true , trie la colonne par ordre croissant. Si la valeur est false , trie la colonne par ordre décroissant. |
Renvois
DataSourceSheet
: feuille de la source de données, pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setSortSpec(columnName, sortOrder)
Définit les spécifications de tri d'une colonne de la feuille de la source de données.
Paramètres
Nom | Type | Description |
---|---|---|
columnName | String | Nom de la colonne à trier. |
sortOrder | SortOrder | Ordre de tri. |
Renvois
DataSourceSheet
: feuille de la source de données, pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
waitForCompletion(timeoutInSeconds)
Attend la fin de l'exécution en cours, qui expire après le nombre de secondes spécifié. Elle génère une exception si l'exécution n'est pas terminée lorsque le délai a expiré, mais n'annule pas l'exécution des données.
Paramètres
Nom | Type | Description |
---|---|---|
timeoutInSeconds | Integer | Délai d'attente de l'exécution des données, en secondes. La valeur maximale est de 300 secondes. |
Renvois
DataExecutionStatus
: état d'exécution des données.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets