Method: spreadsheets.getByDataFilter

Gibt die Tabelle unter der angegebenen ID zurück. Der Aufrufer muss die Tabellen-ID angeben.

Diese Methode unterscheidet sich von spreadsheet.get insofern, als sie es ermöglicht, durch Angabe eines dataFilters-Parameters auszuwählen, welche Teilmengen von Tabellendaten zurückgegeben werden sollen. Es können mehrere DataFilters angegeben werden. Wenn Sie einen oder mehrere Datenfilter angeben, werden die Teile der Tabelle zurückgegeben, die sich mit Bereichen überschneiden, die einem der Filter entsprechen.

Standardmäßig werden Daten innerhalb von Rastern nicht zurückgegeben. Sie haben zwei Möglichkeiten, Rasterdaten einzubinden:

  • Geben Sie eine Feldmaske an, die die gewünschten Felder mithilfe des URL-Parameters fields in HTTP auflistet.

  • Legen Sie den includeGridData-Parameter auf „true“ fest. Wenn eine Feldmaske festgelegt ist, wird der Parameter includeGridData ignoriert.

Bei großen Tabellen hat es sich bewährt, nur die gewünschten Tabellenfelder abzurufen.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
spreadsheetId

string

Die anzufordernde Tabelle.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "includeGridData": boolean
}
Felder
dataFilters[]

object (DataFilter)

Die DataFilters zur Auswahl der aus der Tabelle abzurufenden Bereiche.
includeGridData

boolean

"True", wenn Rasterdaten zurückgegeben werden sollen. Dieser Parameter wird ignoriert, wenn in der Anfrage eine Feldmaske festgelegt wurde.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Spreadsheet.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.