Method: spreadsheets.getByDataFilter

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

Diese Methode unterscheidet sich von „Tabellen.get“ darin, dass hier ausgewählt werden kann, welche Teilmengen von Tabellendaten mithilfe eines dataFilters-Parameters zurückgegeben werden. Es können mehrere DataFilters angegeben werden. Wenn Sie einen oder mehrere Datenfilter festlegen, werden die Teile der Tabelle zurückgegeben, die sich mit den Bereichen überschneiden.

Standardmäßig werden keine Daten in Rastern zurückgegeben. Sie haben zwei Möglichkeiten, Rasterdaten anzugeben:

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

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

Bei großen Tabellen empfiehlt es sich, 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 Tabelle, die angefordert werden soll.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

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

object (DataFilter)

Mit DataFilters werden die Bereiche ausgewählt, die aus der Tabelle abgerufen werden sollen.
includeGridData

boolean

Dieser Wert ist „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.