Accéder à la feuille de source de données existante et la modifier. Pour créer une feuille de source de données, utilisez Spreadsheet.insertDataSourceSheet(spec).
Utilisez cette classe uniquement avec les 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 source de données. |
asSheet() | Sheet | Renvoie la feuille de source de données sous la forme d'un objet de feuille standard. |
autoResizeColumn(columnName) | DataSourceSheet | Cette option permet de redimensionner automatiquement la largeur de la colonne spécifiée. |
autoResizeColumns(columnNames) | DataSourceSheet | Cette option permet de redimensionner automatiquement la largeur des colonnes spécifiées. |
forceRefreshData() | DataSourceSheet | Actualise les données de cet objet, quel que soit leur é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 source de données. |
getSheetValues(columnName) | Object[] | Renvoie toutes les valeurs de la feuille de source de données correspondant au nom de colonne indiqué. |
getSheetValues(columnName, startRow, numRows) | Object[] | Renvoie toutes les valeurs de la feuille de source de données correspondant au nom de colonne fourni, depuis la ligne de départ fournie (basée sur 1) et jusqu'au paramètre numRows fourni. |
getSortSpecs() | SortSpec[] | Récupère toutes les spécifications de tri dans la feuille de 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 la source de données. |
removeSortSpec(columnName) | DataSourceSheet | Supprime la spécification de tri d'une colonne de la feuille de 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 la spécification de tri sur une colonne de la feuille de source de données. |
setSortSpec(columnName, sortOrder) | DataSourceSheet | Définit la spécification de tri sur une colonne de la feuille de source de données. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Attend la fin de l'exécution en cours. Le délai expire après le nombre de secondes indiqué. |
Documentation détaillée
addFilter(columnName, filterCriteria)
Ajoute un filtre appliqué à la feuille de source de données.
Paramètres
| Nom | Type | Description |
|---|---|---|
columnName | String | Nom de la colonne à laquelle appliquer le filtre. |
filterCriteria | FilterCriteria | Critères de filtre à appliquer. |
Aller-retour
DataSourceSheet : feuille de source de données, pour le chaînage de méthode
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 source de données sous la forme d'un objet de feuille standard.
Aller-retour
Sheet : feuille standard
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
autoResizeColumn(columnName)
Cette option permet de redimensionner automatiquement la largeur de la colonne spécifiée.
Paramètres
| Nom | Type | Description |
|---|---|---|
columnName | String | Nom de la colonne. |
Aller-retour
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 avec un ou plusieurs des champs d'application suivants :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
autoResizeColumns(columnNames)
Cette option permet de redimensionner automatiquement la largeur des colonnes spécifiées.
Paramètres
| Nom | Type | Description |
|---|---|---|
columnNames | String[] | Liste des noms de colonnes à mettre à jour. |
Aller-retour
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 avec 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 leur état actuel. Pour en savoir plus, consultez refreshData().
Lève une exception 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 de données pour un type de source de données spécifique.
Aller-retour
DataSourceSheet : objet de données
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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. |
Aller-retour
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 avec 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é.
Aller-retour
DataSource : source de données
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 source de données.
Aller-retour
DataSourceSheetFilter[] : tableau de tous les filtres appliqués à la feuille de la source de données.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 correspondant au nom de colonne indiqué.
Paramètres
| Nom | Type | Description |
|---|---|---|
columnName | String | Nom de la colonne de source de données pour laquelle extraire des valeurs. |
Aller-retour
Object[] : tableau de valeurs unidimensionnel.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 correspondant au nom de colonne fourni, depuis la ligne de départ fournie (basée sur 1) et jusqu'au paramètre numRows fourni.
Paramètres
| Nom | Type | Description |
|---|---|---|
columnName | String | Nom de la colonne de source de données pour laquelle extraire des valeurs. |
startRow | Integer | Position de la ligne à partir de laquelle extraire des valeurs. |
numRows | Integer | Nombre de lignes à extraire. |
Aller-retour
Object[] : tableau de valeurs unidimensionnel.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 source de données.
Aller-retour
SortSpec[] : liste de spécifications de tri.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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.
Aller-retour
DataExecutionStatus : état d'exécution des données.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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.
Lève 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 toute modification inattendue de la source de données.
Lève une exception 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 de données pour un type de source de données spécifique.
Aller-retour
DataSourceSheet : objet de données
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 la source de données.
Paramètres
| Nom | Type | Description |
|---|---|---|
columnName | String | Nom de la colonne dont vous souhaitez supprimer les filtres. |
Aller-retour
DataSourceSheet : feuille de source de données, pour le chaînage de méthode
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
removeSortSpec(columnName)
Supprime la spécification de tri d'une colonne de la feuille de source de données.
Paramètres
| Nom | Type | Description |
|---|---|---|
columnName | String | Nom de la colonne. |
Aller-retour
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 avec 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. |
Aller-retour
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 avec 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. |
Aller-retour
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 avec 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 la spécification de tri sur une colonne de la feuille de source de données.
Paramètres
| Nom | Type | Description |
|---|---|---|
columnName | String | Nom de la colonne à trier. |
ascending | Boolean | Si la valeur est true, triez la colonne par ordre croissant. Si la valeur est false, triez la colonne par ordre décroissant. |
Aller-retour
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 avec 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 la spécification de tri sur une colonne de la feuille de source de données.
Paramètres
| Nom | Type | Description |
|---|---|---|
columnName | String | Nom de la colonne à trier. |
sortOrder | SortOrder | Ordre de tri. |
Aller-retour
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 avec 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. Le délai expire après le nombre de secondes indiqué. Lève une exception si l'exécution n'est pas terminée lors de l'expiration du délai, mais n'annule pas l'exécution des données.
Paramètres
| Nom | Type | Description |
|---|---|---|
timeoutInSeconds | Integer | Temps d'attente pour l'exécution des données, en secondes. La valeur maximale est de 300 secondes. |
Aller-retour
DataExecutionStatus : état d'exécution des données.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets