Method: spreadsheets.values.batchUpdateByDataFilter

Définit les valeurs dans une ou plusieurs plages d'une feuille de calcul. Pour en savoir plus, consultez Lire, écrire et rechercher des métadonnées.

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

string

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 (ValueInputOption),
  "data": [
    {
      object (DataFilterValueRange)
    }
  ],
  "includeValuesInResponse": boolean,
  "responseValueRenderOption": enum (ValueRenderOption),
  "responseDateTimeRenderOption": enum (DateTimeRenderOption)
}
Champs
valueInputOption

enum (ValueInputOption)

Indique comment les données d'entrée doivent être interprétées.
data[]

object (DataFilterValueRange)

Nouvelles valeurs à appliquer à la feuille de calcul. Si plusieurs plages correspondent à la DataFilter spécifiée, les valeurs spécifiées sont appliquées à toutes ces plages.
includeValuesInResponse

boolean

Détermine si la réponse à la mise à jour doit inclure les valeurs des cellules qui ont été mises à jour. Par défaut, les réponses n'incluent pas les valeurs mises à jour. Le champ updatedData de chaque BatchUpdateValuesResponse.responses contient les valeurs mises à jour. Si la plage à écrire était plus grande que la plage réellement écrite, la réponse inclut toutes les valeurs de la plage demandée (à l'exclusion des lignes et colonnes vides à la fin).
responseValueRenderOption

enum (ValueRenderOption)

Détermine comment les valeurs de la réponse doivent être affichées. L'option de rendu par défaut est FORMATTED_VALUE.
responseDateTimeRenderOption

enum (DateTimeRenderOption)

Détermine comment les dates, les heures et les durées de la réponse doivent être affichées. Cette valeur est ignorée si responseValueRenderOption est défini sur FORMATTED_VALUE. L'option de rendu dateTime par défaut est SERIAL_NUMBER.

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 (UpdateValuesByDataFilterResponse)
    }
  ]
}
Champs
spreadsheetId

string

Feuille de calcul à laquelle les modifications ont été appliquées.
totalUpdatedRows

integer

Nombre total de lignes dans lesquelles au moins une cellule a été modifiée.
totalUpdatedColumns

integer

Nombre total de colonnes dans lesquelles au moins une cellule a été modifiée.
totalUpdatedCells

integer

Nombre total de cellules mises à jour.
totalUpdatedSheets

integer

Nombre total de feuilles dans lesquelles au moins une cellule a été modifiée.
responses[]

object (UpdateValuesByDataFilterResponse)

La réponse pour chaque plage a été 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 d'autorisation.

DataFilterValueRange

Plage de valeurs dont l'emplacement est spécifié par un DataFilter.

Représentation JSON 
{
  "dataFilter": {
    object (DataFilter)
  },
  "majorDimension": enum (Dimension),
  "values": [
    array
  ]
}
Champs
dataFilter

object (DataFilter)

Filtre de données décrivant l'emplacement des valeurs dans la feuille de calcul.
majorDimension

enum (Dimension)

Dimension principale des valeurs.
values[]

array (ListValue format)

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 (DataFilter)
  },
  "updatedData": {
    object (ValueRange)
  }
}
Champs
updatedRange

string

Plage (en notation A1) à laquelle les modifications ont été appliquées.
updatedRows

integer

Nombre de lignes dans lesquelles au moins une cellule a été modifiée.
updatedColumns

integer

Nombre de colonnes dans lesquelles au moins une cellule a été modifiée.
updatedCells

integer

Nombre de cellules mises à jour.
dataFilter

object (DataFilter)

Filtre de données ayant sélectionné la plage mise à jour.
updatedData

object (ValueRange)

Valeurs des cellules de la plage correspondant à dataFilter après l'application de toutes les mises à jour. Cette valeur n'est incluse que si le champ includeValuesInResponse de la requête était défini sur true.