L'API Google Sheets vous permet de créer, de modifier et de supprimer des plages nommées ou protégées. Les exemples de cette page montrent comment effectuer certaines opérations Sheets courantes avec l'API Sheets.
Ces exemples sont présentés sous la forme de requêtes HTTP pour être neutres en termes de langue. Pour découvrir comment implémenter une mise à jour par lot dans différentes langues à l'aide des bibliothèques clientes de l'API Google, consultez Modifier des feuilles de calcul.
Dans ces exemples, les espaces réservés SPREADSHEET_ID et SHEET_ID indiquent où vous devez fournir ces ID. Vous trouverez l'identifiant de la feuille de calcul 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 à l'aide de la notation A1. Par exemple, Feuille1!A1:D5.
De plus, les espaces réservés NAMED_RANGE_ID et PROTECTED_RANGE_ID fournissent les ID des plages nommées et protégées. namedRangeId et protectedRangeId sont utilisés lorsque vous envoyez des requêtes pour mettre à jour ou supprimer les plages associées. L'ID est renvoyé dans la réponse à une requête API Sheets qui crée une plage nommée ou protégée. Vous pouvez obtenir les ID des plages existantes avec la méthode spreadsheets.get, dans le corps de la réponse Spreadsheet.
Ajouter des plages nommées ou protégées
L'exemple de code spreadsheets.batchUpdate suivant montre comment utiliser deux objets de requête. La première utilise AddNamedRangeRequest pour attribuer le nom "Nombres" à la plage A1:E3. Le second utilise AddProtectedRangeRequest pour associer une protection de niveau d'avertissement à la plage A4:E4. Ce niveau de protection permet toujours de modifier les cellules de la plage, mais un avertissement s'affiche avant la modification.
Ces requêtes renvoient un AddNamedRangeResponse et un AddProtectedRangeResponse, contenant les ID et les propriétés de la plage.
Le protocole de requête est présenté ci-dessous.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"addNamedRange": {
"namedRange": {
"name": "Counts",
"range": {
"sheetId": SHEET_ID,
"startRowIndex": 0,
"endRowIndex": 3,
"startColumnIndex": 0,
"endColumnIndex": 5,
},
}
}
},
{
"addProtectedRange": {
"protectedRange": {
"range": {
"sheetId": SHEET_ID,
"startRowIndex": 3,
"endRowIndex": 4,
"startColumnIndex": 0,
"endColumnIndex": 5,
},
"description": "Protecting total row",
"warningOnly": true
}
}
}
]
}
Supprimer des plages nommées ou protégées
L'exemple de code spreadsheets.batchUpdate suivant montre comment utiliser deux objets de requête. Le premier utilise DeleteNamedRangeRequest pour supprimer une plage nommée existante, à l'aide de l'NAMED_RANGE_ID d'un appel d'API précédent. Le second utilise DeleteProtectedRangeRequest pour supprimer une protection de plage existante, à l'aide de PROTECTED_RANGE_ID à partir d'un appel d'API précédent.
Le protocole de requête est présenté ci-dessous.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"deleteNamedRange": {
"namedRangeId": "NAMED_RANGE_ID",
}
},
{
"deleteProtectedRange": {
"protectedRangeId": PROTECTED_RANGE_ID,
}
}
]
}
Mettre à jour des plages nommées ou protégées
L'exemple de code spreadsheets.batchUpdate suivant montre comment utiliser deux objets de requête. Le premier utilise UpdateNamedRangeRequest pour remplacer le nom d'une plage nommée existante par "InitialCounts", à l'aide de NAMED_RANGE_ID à partir d'un appel d'API précédent. La seconde utilise UpdateProtectedRangeRequest pour mettre à jour une plage protégée existante afin qu'elle protège désormais la plage portant le même nom. La méthode Editors ne permet qu'aux utilisateurs listés de modifier ces cellules. Cette requête utilise NAMED_RANGE_ID et PROTECTED_RANGE_ID des appels d'API précédents.
Le protocole de requête est présenté ci-dessous.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate
{
"requests": [
{
"updateNamedRange": {
"namedRange": {
"namedRangeId": NAMED_RANGE_ID,
"name": "InitialCounts",
},
"fields": "name",
}
},
{
"updateProtectedRange": {
"protectedRange": {
"protectedRangeId": PROTECTED_RANGE_ID,
"namedRangeId": NAMED_RANGE_ID,
"warningOnly": false,
"editors": {
"users": [
"charlie@example.com",
"sasha@example.com"
]
}
},
"fields": "namedRangeId,warningOnly,editors"
}
}
]
}