Method: spreadsheets.values.batchUpdateByDataFilter

Imposta i valori in uno o più intervalli di un foglio di lavoro. L'utente che chiama 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 al valore DataFilter specificato, i valori specificati vengono applicati a tutti questi intervalli.
includeValuesInResponse

boolean

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

enum (ValueRenderOption)

Determina la modalità di visualizzazione dei valori nella risposta. L'opzione di rendering predefinita è FORMATTED_VALUE.
responseDateTimeRenderOption

enum (DateTimeRenderOption)

Determina la modalità di visualizzazione di date, ore e durate nella risposta. Questo valore viene ignorato se responseValueRenderOption è FORMATTED_VALUE. L'opzione di visualizzazione predefinita per dateTime è SERIAL_NUMBER.

Corpo della risposta

La risposta all'aggiornamento di 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.
totalUpdatedColumns

integer

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

integer

Il numero totale di celle aggiornate.
totalUpdatedSheets

integer

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

object (UpdateValuesByDataFilterResponse)

La risposta per ogni intervallo aggiornato.

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 all'autorizzazione.

DataFilterValueRange

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 degli intervalli corrispondenti al filtro dati, la richiesta non va a buon fine. Se i valori forniti sono inferiori agli intervalli corrispondenti, vengono scritti solo i valori specificati, mentre i valori esistenti negli intervalli corrispondenti rimangono invariati.

UpdateValuesByDataFilterResponse

La risposta all'aggiornamento di 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 almeno una cella è stata aggiornata.
updatedColumns

integer

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

integer

Il numero di celle aggiornate.
dataFilter

object (DataFilter)

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

object (ValueRange)

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