Method: spreadsheets.values.batchUpdateByDataFilter

Imposta i valori in uno o più intervalli di un foglio di lavoro. Il chiamante deve specificare l'ID del foglio di lavoro, un valueInputOption e uno o più DataFilterValueRanges.

Richiesta HTTP

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
spreadsheetId

string

L'ID del foglio di lavoro da aggiornare.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "valueInputOption": enum (ValueInputOption),
  "data": [
    {
      object (DataFilterValueRange)
    }
  ],
  "includeValuesInResponse": boolean,
  "responseValueRenderOption": enum (ValueRenderOption),
  "responseDateTimeRenderOption": enum (DateTimeRenderOption)
}
Campi
valueInputOption

enum (ValueInputOption)

Come devono essere interpretati i dati di input.
data[]

object (DataFilterValueRange)

I nuovi valori da applicare al foglio di lavoro. Se più intervalli corrispondono a DataFilter i valori specificati vengono applicati a tutti gli intervalli.
includeValuesInResponse

boolean

Determina se la risposta di aggiornamento deve includere i valori delle celle che sono state aggiornate. Per impostazione predefinita, le risposte non includono i valori aggiornati. Il campo updatedData all'interno di BatchUpdateValuesResponse.responses contiene i valori aggiornati. Se l'intervallo da scrivere era maggiore dell'intervallo effettivamente scritto, la risposta include tutti i valori nell'intervallo richiesto (ad eccezione delle righe e delle colonne vuote che seguono).
responseValueRenderOption

enum (ValueRenderOption)

Determina il rendering dei valori nella risposta. L'opzione di rendering predefinita è FORMATTED_VALUE.
responseDateTimeRenderOption

enum (DateTimeRenderOption)

Determina come devono essere visualizzati le date, gli orari e le durate della risposta. Questa impostazione viene ignorata se responseValueRenderOption è FORMATTED_VALUE. L'opzione di rendering predefinita di dataTime è SERIAL_NUMBER.

Corpo della risposta

La risposta quando si aggiorna un intervallo di valori in un foglio di lavoro.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "spreadsheetId": string,
  "totalUpdatedRows": integer,
  "totalUpdatedColumns": integer,
  "totalUpdatedCells": integer,
  "totalUpdatedSheets": integer,
  "responses": [
    {
      object (UpdateValuesByDataFilterResponse)
    }
  ]
}
Campi
spreadsheetId

string

Il foglio di lavoro a cui sono stati applicati gli aggiornamenti.
totalUpdatedRows

integer

Il numero totale di righe in cui è stata aggiornata almeno una cella della riga.
totalUpdatedColumns

integer

Il numero totale di colonne in cui è stata aggiornata almeno una cella della colonna.
totalUpdatedCells

integer

Il numero totale di celle aggiornato.
totalUpdatedSheets

integer

Il numero totale di fogli in cui è stata aggiornata almeno una cella del foglio.
responses[]

object (UpdateValuesByDataFilterResponse)

La risposta per ciascun intervallo è stata aggiornata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets

Per ulteriori informazioni, consulta la Guida alle autorizzazioni.

IntervalloValoreValoreDati

Un intervallo di valori la cui posizione è specificata da un DataFilter.

Rappresentazione JSON 
{
  "dataFilter": {
    object (DataFilter)
  },
  "majorDimension": enum (Dimension),
  "values": [
    array
  ]
}
Campi
dataFilter

object (DataFilter)

Il filtro dati che descrive la posizione dei valori nel foglio di lavoro.
majorDimension

enum (Dimension)

La dimensione principale dei valori.
values[]

array (ListValue format)

I dati da scrivere. Se i valori forniti superano uno qualsiasi degli intervalli corrispondenti al filtro dati, la richiesta non riesce. Se i valori forniti sono inferiori agli intervalli corrispondenti, vengono scritti solo i valori specificati, i valori esistenti negli intervalli corrispondenti non vengono modificati.

AggiornamentoValorePerRispostaDatiFiltro

La risposta quando si aggiorna un intervallo di valori in base a un filtro dati in un foglio di lavoro.

Rappresentazione JSON 
{
  "updatedRange": string,
  "updatedRows": integer,
  "updatedColumns": integer,
  "updatedCells": integer,
  "dataFilter": {
    object (DataFilter)
  },
  "updatedData": {
    object (ValueRange)
  }
}
Campi
updatedRange

string

L'intervallo (in notazione A1) a cui sono stati applicati gli aggiornamenti.
updatedRows

integer

Il numero di righe in cui è stata aggiornata almeno una cella della riga.
updatedColumns

integer

Il numero di colonne in cui è stata aggiornata almeno una cella della colonna.
updatedCells

integer

Il numero di celle è stato aggiornato.
dataFilter

object (DataFilter)

Il filtro dati che ha selezionato l'intervallo aggiornato.
updatedData

object (ValueRange)

I valori delle celle nell'intervallo corrispondente al dataFilter dopo l'applicazione di tutti gli aggiornamenti. Questo valore è incluso solo se il campo includeValuesInResponse della richiesta era true.