L'API Google Sheets vous permet d'ajouter, de supprimer et de manipuler des lignes et des colonnes dans des feuilles. Les exemples de cette page montrent comment réaliser certaines opérations de ligne et de colonne courantes avec l'API Sheets.
Ces exemples sont présentés sous la forme de requêtes HTTP afin de ne pas tenir compte du langage. Pour découvrir comment implémenter une mise à jour par lot dans différents langages à l'aide des bibliothèques clientes des API Google, consultez Mettre à jour des feuilles de calcul.
Dans ces exemples, les espaces réservés SPREADSHEET_ID et SHEET_ID indiquent où vous devez fournir ces ID. L'ID de la feuille de calcul se trouve dans l'URL de la feuille de calcul. Vous pouvez obtenir l'ID de la feuille à l'aide de la méthode spreadsheets.get. Les plages sont spécifiées au format A1. Exemple de plage : Sheet1!A1:D5.
Ajuster la largeur de colonne ou la hauteur des lignes
L'exemple de code spreadsheets.batchUpdate suivant montre comment utiliser UpdateDimensionPropertiesRequest pour mettre à jour la propriété de largeur de la colonne A sur 160 pixels. Une deuxième requête met à jour la propriété de hauteur de ligne des trois premières lignes pour qu'elle soit de 40 pixels. Le champ dimension détermine si l'opération s'applique aux colonnes ou aux lignes d'une feuille de calcul.
Le protocole de requête est présenté ci-dessous.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"updateDimensionProperties": {
"range": {
"sheetId": SHEET_ID,
"dimension": "COLUMNS",
"startIndex": 0,
"endIndex": 1
},
"properties": {
"pixelSize": 160
},
"fields": "pixelSize"
}
},
{
"updateDimensionProperties": {
"range": {
"sheetId": SHEET_ID,
"dimension": "ROWS",
"startIndex": 0,
"endIndex": 3
},
"properties": {
"pixelSize": 40
},
"fields": "pixelSize"
}
}
]
}
Ajouter des lignes ou des colonnes vides
L'exemple de code spreadsheets.batchUpdate suivant montre comment utiliser AppendDimensionRequest pour ajouter des lignes et des colonnes. La première requête ajoute trois lignes vides à la fin d'une feuille, tandis que la seconde ajoute une seule colonne vide. Le champ dimension détermine si l'opération s'applique aux colonnes ou aux lignes d'une feuille de calcul.
Le protocole de requête est présenté ci-dessous.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"appendDimension": {
"sheetId": SHEET_ID,
"dimension": "ROWS",
"length": 3
}
},
{
"appendDimension": {
"sheetId": SHEET_ID,
"dimension": "COLUMNS",
"length": 1
}
}
]
}
Redimensionner automatiquement une colonne
L'exemple de code spreadsheets.batchUpdate suivant montre comment utiliser AutoResizeDimensionsRequest pour redimensionner les colonnes A:C, en fonction de la taille du contenu de la colonne. Le champ dimension indique que l'opération s'applique aux colonnes de la feuille.
Le protocole de requête est présenté ci-dessous.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"autoResizeDimensions": {
"dimensions": {
"sheetId": SHEET_ID,
"dimension": "COLUMNS",
"startIndex": 0,
"endIndex": 3
}
}
}
]
}
Redimensionner automatiquement une ligne
L'exemple de code spreadsheets.batchUpdate suivant montre comment utiliser AutoResizeDimensionsRequest pour effacer la hauteur des trois premières lignes. La hauteur des lignes augmente ensuite de manière dynamique en fonction du contenu des cellules de chaque ligne. Le champ dimension indique que l'opération s'applique aux lignes de la feuille.
Le protocole de requête est présenté ci-dessous.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"autoResizeDimensions": {
"dimensions": {
"sheetId": SHEET_ID,
"dimension": "ROWS",
"startIndex": 0,
"endIndex": 3
}
}
}
]
}
Supprimer des lignes ou des colonnes
L'exemple de code spreadsheets.batchUpdate suivant montre comment supprimer les trois premières lignes d'une feuille à l'aide de DeleteDimensionRequest. Une deuxième requête supprime les colonnes B:D.
Le champ dimension détermine si l'opération s'applique aux colonnes ou aux lignes d'une feuille.
Le protocole de requête est présenté ci-dessous.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"deleteDimension": {
"range": {
"sheetId": SHEET_ID,
"dimension": "ROWS",
"startIndex": 0,
"endIndex": 3
}
}
},
{
"deleteDimension": {
"range": {
"sheetId": SHEET_ID,
"dimension": "COLUMNS",
"startIndex": 1,
"endIndex": 4
}
}
},
],
}
Insérer une ligne ou une colonne vide
L'exemple de code spreadsheets.batchUpdate suivant montre comment utiliser InsertDimensionRequest pour insérer des colonnes ou des lignes à un indice particulier (par exemple, ajouter des lignes vides en haut d'une feuille de calcul). La première requête insère deux colonnes vides dans la colonne C.
Une deuxième requête insère trois lignes vides à partir de la ligne 1.
Le champ dimension détermine si l'opération s'applique aux colonnes ou aux lignes d'une feuille.
Si la valeur est "true", le champ inheritFromBefore indique à l'API Sheets d'attribuer aux nouvelles colonnes ou lignes les mêmes propriétés que la ligne ou colonne précédente. Si la valeur est "false", il doit hériter des dimensions situées après les nouvelles colonnes ou lignes.
inheritFromBefore ne peut pas être défini sur "true" si vous insérez une ligne au niveau de la ligne 1 ou une colonne au niveau de la colonne A.
Le protocole de requête est présenté ci-dessous.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"insertDimension": {
"range": {
"sheetId": SHEET_ID,
"dimension": "COLUMNS",
"startIndex": 2,
"endIndex": 4
},
"inheritFromBefore": true
}
},
{
"insertDimension": {
"range": {
"sheetId": SHEET_ID,
"dimension": "ROWS",
"startIndex": 0,
"endIndex": 3
},
"inheritFromBefore": false
}
},
],
}
Déplacer une ligne ou une colonne
L'exemple de code spreadsheets.batchUpdate suivant montre comment utiliser MoveDimensionRequest pour déplacer la colonne A à la position de la colonne D. Une deuxième requête déplace les lignes 5 à 10 à la position de la ligne 20.
Le champ dimension détermine si l'opération s'applique aux colonnes ou aux lignes d'une feuille. Le champ destinationIndex détermine où déplacer les données sources à l'aide d'un index de départ basé sur zéro.
Le protocole de requête est présenté ci-dessous.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"moveDimension": {
"source": {
"sheetId": SHEET_ID,
"dimension": "COLUMNS",
"startIndex": 0,
"endIndex": 1
},
"destinationIndex": 3
}
},
{
"moveDimension": {
"source": {
"sheetId": SHEET_ID,
"dimension": "ROWS",
"startIndex": 4,
"endIndex": 10
},
"destinationIndex": 19
}
},
],
}