Method: spreadsheets.getByDataFilter

Gibt die Tabelle mit der angegebenen ID zurück. Der Aufrufer muss die Tabellen-ID angeben. Weitere Informationen finden Sie unter Metadaten lesen, schreiben und durchsuchen.

Diese Methode unterscheidet sich von spreadsheets.get dadurch, dass Sie mit dem Parameter dataFilters auswählen können, 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 keine Daten in Rastern zurückgegeben. Sie haben zwei Möglichkeiten, Rasterdaten einzufügen:

  • Geben Sie eine Feldmaske an, in der die gewünschten Felder mit dem URL-Parameter fields in HTTP aufgeführt sind.

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

Bei großen Tabellen sollten Sie als Best Practice nur die gewünschten Tabellenfelder abrufen.

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,
  "excludeTablesInBandedRanges": boolean,
  "commentsViewMode": enum (CommentsViewMode)
}
Felder
dataFilters[]

object (DataFilter)

Mit dem DataFilters wird ausgewählt, welche Bereiche 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.
excludeTablesInBandedRanges

boolean

„True“, wenn Tabellen in den Bereichen mit Klassen ausgeschlossen werden sollen. „False“, wenn nicht festgelegt.
commentsViewMode

enum (CommentsViewMode)

Der Ansichtsmodus für Kommentare, der auf die Tabelle angewendet werden soll. So können Sie die Tabelle mit oder ohne Kommentare aufrufen. Wenn keine angegeben ist, wird COMMENTS_VIEW_MODE_OMITTED verwendet.

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 Autorisierungsleitfaden.