REST Resource: spreadsheets

Ressource: Tabelle

Ressource, die eine Tabelle darstellt.

JSON-Darstellung 
{
  "spreadsheetId": string,
  "properties": {
    object (SpreadsheetProperties)
  },
  "sheets": [
    {
      object (Sheet)
    }
  ],
  "namedRanges": [
    {
      object (NamedRange)
    }
  ],
  "spreadsheetUrl": string,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSources": [
    {
      object (DataSource)
    }
  ],
  "dataSourceSchedules": [
    {
      object (DataSourceRefreshSchedule)
    }
  ]
}
Felder
spreadsheetId

string

Die ID der Tabelle. Dieses Feld ist schreibgeschützt.
properties

object (SpreadsheetProperties)

Allgemeine Eigenschaften einer Tabelle
sheets[]

object (Sheet)

Die Tabellenblätter einer Tabelle.
namedRanges[]

object (NamedRange)

Die in einer Tabelle definierten benannten Bereiche.
spreadsheetUrl

string

Die URL der Tabelle. Dieses Feld ist schreibgeschützt.
developerMetadata[]

object (DeveloperMetadata)

Die mit einer Tabelle verknüpften Entwicklermetadaten.
dataSources[]

object (DataSource)

Eine Liste der externen Datenquellen, die mit der Tabelle verknüpft sind.
dataSourceSchedules[]

object (DataSourceRefreshSchedule)

Nur Ausgabe. Eine Liste mit Aktualisierungsplänen für Datenquellen.

SpreadsheetProperties

Eigenschaften einer Tabelle.

JSON-Darstellung 
{
  "title": string,
  "locale": string,
  "autoRecalc": enum (RecalculationInterval),
  "timeZone": string,
  "defaultFormat": {
    object (CellFormat)
  },
  "iterativeCalculationSettings": {
    object (IterativeCalculationSettings)
  },
  "spreadsheetTheme": {
    object (SpreadsheetTheme)
  },
  "importFunctionsExternalUrlAccessAllowed": boolean
}
Felder
title

string

Der Titel der Tabelle.
locale

string

Die Sprache der Tabelle in einem der folgenden Formate:

  • einen ISO 639-1-Sprachcode wie en

  • einen ISO 639-2-Sprachcode wie fil, wenn kein 639-1-Code vorhanden ist

  • eine Kombination aus dem ISO-Sprachcode und dem Ländercode, z. B. en_US

Hinweis: Bei der Aktualisierung dieses Felds werden nicht alle Sprachen und Länder unterstützt.
autoRecalc

enum (RecalculationInterval)

Die Zeitspanne, die gewartet werden soll, bevor volatile Funktionen neu berechnet werden.
timeZone

string

Die Zeitzone der Tabelle im CLDR-Format, z. B. America/New_York. Wenn die Zeitzone nicht erkannt wird, kann es sich um eine benutzerdefinierte Zeitzone wie GMT-07:00 handeln.
defaultFormat

object (CellFormat)

Das Standardformat aller Zellen in der Tabelle. CellData.effectiveFormat wird nicht festgelegt, wenn das Format der Zelle diesem Standardformat entspricht. Dieses Feld ist schreibgeschützt.
iterativeCalculationSettings

object (IterativeCalculationSettings)

Legt fest, ob und wie Zirkelbezüge durch iterative Berechnung aufgelöst werden. Wenn dieses Feld fehlt, führen Rückwärtsverweise zu Berechnungsfehlern.
spreadsheetTheme

object (SpreadsheetTheme)

Das Design wurde auf die Tabelle angewendet.
importFunctionsExternalUrlAccessAllowed

boolean

Gibt an, ob der Zugriff auf externe URLs für Bild- und Importfunktionen zulässig ist. Nur lesen, wenn wahr. Bei „false“ können Sie diesen Wert auf „true“ setzen. Dieser Wert wird umgangen und gibt immer „true“ zurück, wenn der Administrator die Zulassungsliste aktiviert hat.

RecalculationInterval

Eine Aufzählung der möglichen Optionen für das Neuberechnungsintervall.

Enums
RECALCULATION_INTERVAL_UNSPECIFIED Standardwert. Dieser Wert darf nicht verwendet werden.
ON_CHANGE Veränderliche Funktionen werden bei jeder Änderung aktualisiert.
MINUTE Veränderliche Funktionen werden bei jeder Änderung und jede Minute aktualisiert.
HOUR Veränderliche Funktionen werden bei jeder Änderung und stündlich aktualisiert.

IterativeCalculationSettings

Einstellungen, mit denen Sie festlegen können, wie Zirkelbezüge durch iterative Berechnungen aufgelöst werden.

JSON-Darstellung 
{
  "maxIterations": integer,
  "convergenceThreshold": number
}
Felder
maxIterations

integer

Wenn die iterative Berechnung aktiviert ist, wird die maximale Anzahl von durchzuführenden Berechnungsrunden festgelegt.
convergenceThreshold

number

Wenn die iterative Berechnung aktiviert ist und sich aufeinanderfolgende Ergebnisse um weniger als diesen Grenzwert unterscheiden, werden die Berechnungsrunden beendet.

SpreadsheetTheme

Steht für Tabellendesign

JSON-Darstellung 
{
  "primaryFontFamily": string,
  "themeColors": [
    {
      object (ThemeColorPair)
    }
  ]
}
Felder
primaryFontFamily

string

Name der primären Schriftfamilie.
themeColors[]

object (ThemeColorPair)

Die Farbpaare des Tabellendesigns. Zum Aktualisieren müssen Sie alle Farbpaare des Designs angeben.

ThemeColorPair

Ein Paar, das den Farbtyp eines Tabellendesigns der entsprechenden Betonfarbe zuordnet.

JSON-Darstellung 
{
  "colorType": enum (ThemeColorType),
  "color": {
    object (ColorStyle)
  }
}
Felder
colorType

enum (ThemeColorType)

Der Typ der Tabellenthemenfarbe.
color

object (ColorStyle)

Die Betonfarbe, die dem Farbtyp des Designs entspricht.

NamedRange

Ein benannter Bereich.

JSON-Darstellung 
{
  "namedRangeId": string,
  "name": string,
  "range": {
    object (GridRange)
  }
}
Felder
namedRangeId

string

Die ID des benannten Bereichs.
name

string

Der Name des benannten Bereichs.
range

object (GridRange)

Der Bereich, den dieser darstellt.

DataSource

Informationen zu einer externen Datenquelle in der Tabelle.

JSON-Darstellung 
{
  "dataSourceId": string,
  "spec": {
    object (DataSourceSpec)
  },
  "calculatedColumns": [
    {
      object (DataSourceColumn)
    }
  ],
  "sheetId": integer
}
Felder
dataSourceId

string

Die eindeutige ID auf Tabellenebene, mit der die Datenquelle identifiziert wird. Beispiel: 1080547365.
spec

object (DataSourceSpec)

Die DataSourceSpec für die Datenquelle, die mit dieser Tabelle verknüpft ist.
calculatedColumns[]

object (DataSourceColumn)

Alle berechneten Spalten in der Datenquelle.
sheetId

integer

Die ID der Sheet, die mit der Datenquelle verknüpft ist. Das Feld kann nach der Festlegung nicht mehr geändert werden.

Beim Erstellen einer Datenquelle wird auch ein zugehöriges Tabellenblatt mit dem Namen DATA_SOURCE erstellt. Wenn das Feld nicht angegeben ist, wird die ID des erstellten Tabellenblatts nach dem Zufallsprinzip generiert.

DataSourceSpec

Hier werden die Details der Datenquelle angegeben. Bei BigQuery werden hier beispielsweise Informationen zur BigQuery-Quelle angegeben.

JSON-Darstellung 
{
  "parameters": [
    {
      object (DataSourceParameter)
    }
  ],

  // Union field spec can be only one of the following:
  "bigQuery": {
    object (BigQueryDataSourceSpec)
  },
  "looker": {
    object (LookerDataSourceSpec)
  }
  // End of list of possible types for union field spec.
}
Felder
parameters[]

object (DataSourceParameter)

Die Parameter der Datenquelle, die beim Abfragen der Datenquelle verwendet werden.
Union-Feld spec. Die tatsächliche Spezifikation pro Datenquellentyp. Für spec ist nur einer der folgenden Werte zulässig:
bigQuery

object (BigQueryDataSourceSpec)

Ein BigQueryDataSourceSpec.
looker

object (LookerDataSourceSpec)

Eine [LookerDatasourceSpec][].

BigQueryDataSourceSpec

Die Spezifikation einer BigQuery-Datenquelle, die mit einem Tabellenblatt verbunden ist.

JSON-Darstellung 
{
  "projectId": string,

  // Union field spec can be only one of the following:
  "querySpec": {
    object (BigQueryQuerySpec)
  },
  "tableSpec": {
    object (BigQueryTableSpec)
  }
  // End of list of possible types for union field spec.
}
Felder
projectId

string

Die ID eines BigQuery-kompatiblen Google Cloud-Projekts mit einem verknüpften Abrechnungskonto. Für alle Abfragen, die an der Datenquelle ausgeführt werden, wird dem Projekt eine Gebühr in Rechnung gestellt.
Union-Feld spec. Die eigentliche Spezifikation. Für spec ist nur einer der folgenden Werte zulässig:
querySpec

object (BigQueryQuerySpec)

Ein BigQueryQuerySpec.
tableSpec

object (BigQueryTableSpec)

Ein BigQueryTableSpec.

BigQueryQuerySpec

Gibt eine benutzerdefinierte BigQuery-Abfrage an.

JSON-Darstellung 
{
  "rawQuery": string
}
Felder
rawQuery

string

Der Rohabfragestring.

BigQueryTableSpec

Gibt eine BigQuery-Tabellendefinition an. Es sind nur native Tabellen zulässig.

JSON-Darstellung 
{
  "tableProjectId": string,
  "tableId": string,
  "datasetId": string
}
Felder
tableProjectId

string

Die ID eines BigQuery-Projekts, zu dem die Tabelle gehört. Wenn nichts angegeben wurde, wird von einem projectId ausgegangen.
tableId

string

Die BigQuery-Tabellen-ID.
datasetId

string

Die BigQuery-Dataset-ID.

LookerDataSourceSpec

Die Spezifikation einer Looker-Datenquelle.

JSON-Darstellung 
{
  "instanceUri": string,
  "model": string,
  "explore": string
}
Felder
instanceUri

string

Eine Looker-Instanz-URL.
model

string

Name eines Looker-Modells.
explore

string

Name eines Looker-Modell-Explores.

DataSourceParameter

Ein Parameter in der Abfrage einer Datenquelle. Mit dem Parameter kann der Nutzer Werte aus der Tabelle an eine Abfrage übergeben.

JSON-Darstellung 
{

  // Union field identifier can be only one of the following:
  "name": string
  // End of list of possible types for union field identifier.

  // Union field value can be only one of the following:
  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
  // End of list of possible types for union field value.
}
Felder
Union-Feld identifier. Die Parameterkennung. Für identifier ist nur einer der folgenden Werte zulässig:
name

string

Benannter Parameter. Muss eine gültige Kennung für den DataSource sein, der ihn unterstützt. Beispiel: BigQuery-ID.
Union-Feld value. Der Parameterwert. Für value ist nur einer der folgenden Werte zulässig:
namedRangeId

string

ID von NamedRange. Die Größe muss 1 x 1 betragen.
range

object (GridRange)

Ein Bereich, der den Wert des Parameters enthält. Die Größe muss 1 x 1 betragen.

DataSourceRefreshSchedule

Zeitplan für die Aktualisierung der Datenquelle festlegen.

Die Datenquellen in der Tabelle werden innerhalb eines bestimmten Zeitintervalls aktualisiert. Sie können die Startzeit festlegen, indem Sie im Editor von Google Tabellen auf die Schaltfläche „Geplante Aktualisierung“ klicken. Das Intervall ist jedoch auf 4 Stunden festgelegt. Wenn Sie beispielsweise eine Startzeit von 8:00 Uhr angeben, erfolgt die Aktualisierung täglich zwischen 8:00 und 12:00 Uhr.

JSON-Darstellung 
{
  "enabled": boolean,
  "refreshScope": enum (DataSourceRefreshScope),
  "nextRun": {
    object (Interval)
  },

  // Union field schedule_config can be only one of the following:
  "dailySchedule": {
    object (DataSourceRefreshDailySchedule)
  },
  "weeklySchedule": {
    object (DataSourceRefreshWeeklySchedule)
  },
  "monthlySchedule": {
    object (DataSourceRefreshMonthlySchedule)
  }
  // End of list of possible types for union field schedule_config.
}
Felder
enabled

boolean

„True“, wenn der Aktualisierungszeitplan aktiviert ist, andernfalls „false“.
refreshScope

enum (DataSourceRefreshScope)

Der Umfang der Aktualisierung. Muss ALL_DATA_SOURCES lauten.
nextRun

object (Interval)

Nur Ausgabe. Das Zeitintervall der nächsten Ausführung.
Union-Feld schedule_config. Für die Zeitplankonfigurationen schedule_config ist nur einer der folgenden Werte zulässig:
dailySchedule

object (DataSourceRefreshDailySchedule)

Tägliche Aktualisierung
weeklySchedule

object (DataSourceRefreshWeeklySchedule)

Zeitplan für die wöchentliche Aktualisierung.
monthlySchedule

object (DataSourceRefreshMonthlySchedule)

Monatlicher Aktualisierungszeitplan.

DataSourceRefreshScope

Die Aktualisierungsbereiche der Datenquelle.

Enums
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED Standardwert, nicht verwenden.
ALL_DATA_SOURCES Alle Datenquellen und die zugehörigen Datenquellenobjekte in der Tabelle werden aktualisiert.

DataSourceRefreshDailySchedule

Ein Zeitplan für die tägliche Aktualisierung von Daten in einem bestimmten Intervall.

JSON-Darstellung 
{
  "startTime": {
    object (TimeOfDay)
  }
}
Felder
startTime

object (TimeOfDay)

Die Startzeit eines Zeitintervalls, in dem eine Datenquellenaktualisierung geplant ist. Es wird nur der Teil hours verwendet. Die Größe des Zeitintervalls ist standardmäßig auf die Größe im Google Tabellen-Editor festgelegt.

TimeOfDay

Stellt eine Tageszeit dar. Das Datum und die Zeitzone sind entweder nicht relevant oder werden an anderer Stelle angegeben. Eine API kann Schaltsekunden zulassen. Vergleichbare Typen sind google.type.Date und google.protobuf.Timestamp.

JSON-Darstellung 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Felder
hours

integer

Stunden im 24-Stunden-Format. Sollte zwischen 0 und 23 liegen. Eine API kann den Wert "24:00:00" für Szenarien wie Geschäftsschlusszeit zulassen.
minutes

integer

Minuten der Zeitangabe. Muss zwischen 0 und 59 liegen.
seconds

integer

Sekunden der Zeitangabe. Muss normalerweise zwischen 0 und 59 liegen. Eine API kann den Wert 60 zulassen, wenn sie Schaltsekunden zulässt.
nanos

integer

Sekundenbruchteile in Nanosekunden. Muss zwischen 0 und 999.999.999 liegen.

DataSourceRefreshWeeklySchedule

Ein wöchentlicher Zeitplan für die Aktualisierung von Daten an bestimmten Tagen in einem bestimmten Zeitintervall.

JSON-Darstellung 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
Felder
startTime

object (TimeOfDay)

Die Startzeit eines Zeitintervalls, in dem eine Datenquellenaktualisierung geplant ist. Es wird nur hours-Teil verwendet. Die Größe des Zeitintervalls ist standardmäßig auf die Größe im Google Tabellen-Editor festgelegt.
daysOfWeek[]

enum (DayOfWeek)

Wochentage für die Aktualisierung. Es muss mindestens ein Tag angegeben werden.

DayOfWeek

Steht für einen Wochentag.

Enums
DAY_OF_WEEK_UNSPECIFIED Der Wochentag ist nicht angegeben.
MONDAY Montag
TUESDAY Dienstag
WEDNESDAY Mittwoch
THURSDAY Donnerstag
FRIDAY Freitag
SATURDAY Samstag
SUNDAY Sonntag

DataSourceRefreshMonthlySchedule

Ein monatlicher Zeitplan für die Aktualisierung von Daten an bestimmten Tagen des Monats in einem bestimmten Zeitintervall.

JSON-Darstellung 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfMonth": [
    integer
  ]
}
Felder
startTime

object (TimeOfDay)

Der Beginn eines Zeitintervalls, in dem eine Aktualisierung der Datenquelle geplant ist. Es wird nur hours-Teil verwendet. Die Größe des Zeitintervalls ist standardmäßig auf die Größe im Google Tabellen-Editor festgelegt.
daysOfMonth[]

integer

Tage des Monats, an denen die Daten aktualisiert werden sollen. Es werden nur die Werte 1–28 unterstützt, was dem 1. bis zum 28. Tag entspricht. Es muss mindestens ein Tag angegeben werden.

Intervall

Stellt ein Zeitintervall dar, das als Zeitstempelstart (einschließlich) und als Zeitstempelende (ausschließlich) codiert ist.

Der Beginn muss kleiner oder gleich dem Ende sein. Wenn Start und Ende übereinstimmen, ist das Intervall leer (entspricht keiner Zeit). Wenn weder Start noch Ende angegeben sind, entspricht das Intervall jeder beliebigen Zeit.

JSON-Darstellung 
{
  "startTime": string,
  "endTime": string
}
Felder
startTime

string (Timestamp format)

Optional. Inklusiver Start des Intervalls.

Falls angegeben, muss ein Zeitstempel, der zu diesem Intervall passt, mit dem Start übereinstimmen oder nach diesem liegen.
endTime

string (Timestamp format)

Optional. Ausgeschlossenes Ende des Intervalls.

Wenn angegeben, muss ein Zeitstempel, der mit diesem Intervall übereinstimmt, vor dem Ende liegen.

Methoden

batchUpdate

 Wendet mindestens eine Aktualisierung auf die Tabelle an.

create

 Erstellt eine Tabelle und gibt die neu erstellte Tabelle zurück.

get

 Gibt die Tabelle mit der angegebenen ID zurück.

getByDataFilter

 Gibt die Tabelle unter der angegebenen ID zurück.