Method: spreadsheets.getByDataFilter

Restituisce il foglio di lavoro all'ID specificato. Il chiamante deve specificare l'ID del foglio di lavoro.

Questo metodo differisce da spreadsheet.get perché consente di selezionare i sottoinsiemi di dati dei fogli di lavoro da restituire specificando un parametro dataFilters. È possibile specificare più DataFilters. Se specifichi uno o più filtri dati, vengono restituite le parti del foglio di lavoro che intersecano intervalli corrispondenti a qualsiasi filtro.

Per impostazione predefinita, i dati all'interno delle griglie non vengono restituiti. Puoi includere i dati della griglia in due modi:

  • Specifica una maschera di campo che elenca i campi desiderati utilizzando il parametro URL fields in HTTP

  • Imposta il parametro includeGridData su true. Se viene impostata una maschera del campo, il parametro includeGridData viene ignorato

Per i fogli di lavoro di grandi dimensioni, come best practice, recupera solo i campi specifici del foglio di lavoro che preferisci.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
spreadsheetId

string

Il foglio di lavoro da richiedere.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "includeGridData": boolean
}
Campi
dataFilters[]

object (DataFilter)

Il DataFilters utilizzato per selezionare gli intervalli da recuperare dal foglio di lavoro.
includeGridData

boolean

True se devono essere restituiti i dati della griglia. Questo parametro viene ignorato se nella richiesta è stata impostata una maschera di campo.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Spreadsheet.

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.