Method: spreadsheets.getByDataFilter

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

Diese Methode unterscheidet sich von „Tables.get“ dadurch, dass durch Angabe eines dataFilters-Parameters ausgewählt werden kann, 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 mit einem der Filter übereinstimmen.

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

  • Geben Sie eine Feldmaske mit den gewünschten Feldern über den URL-Parameter fields in HTTP an.

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

Rufen Sie bei großen Tabellenkalkulationen als Best Practice nur die gewünschten Tabellenkalkulationsfelder ab.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
spreadsheetId

string

Die anzufragende Tabelle.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

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

object (DataFilter)

Der DataFilters, mit dem die Bereiche ausgewählt werden, die aus der Tabelle abgerufen werden sollen.
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.