Method: spreadsheets.getByDataFilter

Restituisce il foglio di lavoro con l'ID specificato. Il chiamante deve specificare l'ID foglio di lavoro. Per saperne di più, consulta Leggere, scrivere ed eseguire ricerche nei metadati.

Questo metodo è diverso da spreadsheets.get in quanto consente di selezionare i sottoinsiemi di dati del foglio di lavoro da restituire specificando un parametro dataFilters. È possibile specificare più DataFilters. Se specifichi uno o più filtri dei dati, vengono restituite le parti del foglio di lavoro che intersecano gli intervalli corrispondenti a uno qualsiasi dei filtri.

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 che ti interessano utilizzando il parametro URL fields in HTTP.

  • Imposta il parametro includeGridData su true. Se viene impostata una maschera di 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 ti interessano.

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,
  "excludeTablesInBandedRanges": 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 del campo.
excludeTablesInBandedRanges

boolean

True se le tabelle devono essere escluse dagli intervalli a bande. False se non impostato.

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.