- Requête HTTP
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- DataFilterValueRange
- UpdateValuesByDataFilterResponse
- Essayer
Définit les valeurs d'une ou de plusieurs plages d'une feuille de calcul. L'appelant doit spécifier l'ID de la feuille de calcul, un valueInputOption
et un ou plusieurs DataFilterValueRanges
.
Requête HTTP
POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres | |
---|---|
spreadsheetId |
ID de la feuille de calcul à mettre à jour. |
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
Représentation JSON |
---|
{ "valueInputOption": enum ( |
Champs | |
---|---|
valueInputOption |
Manière dont les données d'entrée doivent être interprétées. |
data[] |
Nouvelles valeurs à appliquer à la feuille de calcul. Si plusieurs plages correspondent à l'élément |
includeValuesInResponse |
Détermine si la réponse de mise à jour doit inclure les valeurs des cellules mises à jour. Par défaut, les réponses n'incluent pas les valeurs mises à jour. Le champ |
responseValueRenderOption |
Détermine la façon dont les valeurs de la réponse doivent s'afficher. L'option de rendu par défaut est |
responseDateTimeRenderOption |
Détermine comment les dates, les heures et les durées de la réponse doivent s'afficher. Cette valeur est ignorée si |
Corps de la réponse
Réponse lors de la mise à jour d'une plage de valeurs dans une feuille de calcul.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
Représentation JSON |
---|
{
"spreadsheetId": string,
"totalUpdatedRows": integer,
"totalUpdatedColumns": integer,
"totalUpdatedCells": integer,
"totalUpdatedSheets": integer,
"responses": [
{
object ( |
Champs | |
---|---|
spreadsheetId |
Feuille de calcul à laquelle les mises à jour ont été appliquées. |
totalUpdatedRows |
Nombre total de lignes dans lesquelles au moins une cellule a été mise à jour. |
totalUpdatedColumns |
Nombre total de colonnes dans lesquelles au moins une cellule de la colonne a été mise à jour. |
totalUpdatedCells |
Nombre total de cellules mises à jour. |
totalUpdatedSheets |
Nombre total de feuilles dans lesquelles au moins une cellule a été mise à jour. |
responses[] |
Réponse pour chaque plage mise à jour. |
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/spreadsheets
Pour en savoir plus, consultez le guide relatif aux autorisations.
DataFilterValueRange
Une plage de valeurs dont l'emplacement est spécifié par un DataFilter
.
Représentation JSON |
---|
{ "dataFilter": { object ( |
Champs | |
---|---|
dataFilter |
Le filtre de données décrivant l'emplacement des valeurs dans la feuille de calcul. |
majorDimension |
La dimension majeure des valeurs. |
values[] |
Données à écrire. Si les valeurs fournies dépassent l'une des plages correspondant au filtre de données, la requête échoue. Si les valeurs fournies sont inférieures aux plages correspondantes, seules les valeurs spécifiées sont écrites. Les valeurs existantes dans les plages correspondantes ne sont pas affectées. |
UpdateValuesByDataFilterResponse
Réponse lors de la mise à jour d'une plage de valeurs par un filtre de données dans une feuille de calcul.
Représentation JSON |
---|
{ "updatedRange": string, "updatedRows": integer, "updatedColumns": integer, "updatedCells": integer, "dataFilter": { object ( |
Champs | |
---|---|
updatedRange |
Plage (en notation A1) à laquelle les mises à jour ont été appliquées. |
updatedRows |
Nombre de lignes dans lesquelles au moins une cellule a été mise à jour. |
updatedColumns |
Nombre de colonnes dans lesquelles au moins une cellule de la colonne a été mise à jour. |
updatedCells |
Nombre de cellules mises à jour. |
dataFilter |
Filtre de données qui a sélectionné la plage mise à jour. |
updatedData |
Valeurs des cellules de la plage qui correspondent au filtre dataFilter après l'application de toutes les mises à jour. Cet élément n'est inclus que si le champ |