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, die Teil einer Tabelle sind.

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 mit der Tabelle verbundenen externen Datenquellen.

dataSourceSchedules[]

object (DataSourceRefreshSchedule)

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

Tabelleneigenschaften

Eigenschaften einer Tabelle.

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

string

Der Titel der Tabelle.

locale

string

Die Sprache der Tabelle in einem der folgenden Formate:

  • einen ISO 639-1-Sprachcode, z. B. en

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

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

Hinweis: Bei der Aktualisierung dieses Feldes werden nicht alle Sprachen/Sprachen unterstützt.

autoRecalc

enum (RecalculationInterval)

Die Wartezeit, bevor veränderliche 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)

Bestimmt, ob und wie kreisförmige Verweise durch iterative Berechnung aufgelöst werden. Das Fehlen dieses Felds bedeutet, dass Zirkelbezüge zu Berechnungsfehlern führen können.

spreadsheetTheme

object (SpreadsheetTheme)

Design auf die Tabelle angewendet.

Berechnungsintervall

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

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

Einstellungen für iterative Berechnung

Einstellungen, um zu steuern, wie zirkuläre Abhängigkeiten durch iterative Berechnung aufgelöst werden.

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

integer

Wenn die iterative Berechnung aktiviert ist, die maximale Anzahl der auszuführenden Berechnungsrunden.

convergenceThreshold

number

Wenn die iterative Berechnung aktiviert ist und aufeinanderfolgende Ergebnisse von diesem Grenzwert abweichen, werden die Abrechnungsrunden beendet.

Tabellendesign

Stellt das Tabellendesign dar

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

string

Name der primären Schriftfamilie.

themeColors[]

object (ThemeColorPair)

Farbdesigns für Tabellendesign. Zum Aktualisieren müssen alle Design-Farbpaare angegeben werden.

DesignFarbpaar

Ein Paar, das den Farbtyp der Tabelle und der entsprechenden Betonfarbe zuordnet.

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

enum (ThemeColorType)

Der Typ der Tabellendesignfarbe.

color

object (ColorStyle)

Die Betonfarbe, die dem Farbtyp des Designs entspricht.

BenannterBereich

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 repräsentierte Bereich.

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 Tabellen-ID, die die Datenquelle identifiziert. Beispiel: 1080547365.

spec

object (DataSourceSpec)

Die DataSourceSpec für die mit dieser Tabelle verbundene Datenquelle.

calculatedColumns[]

object (DataSourceColumn)

Alle berechneten Spalten in der Datenquelle.

sheetId

integer

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

Beim Erstellen einer Datenquelle wird auch ein zugehöriges DATA_SOURCE-Tabellenblatt erstellt. Wenn das Feld nicht angegeben ist, wird die ID des erstellten Tabellenblatts zufällig generiert.

DataSpec-Spezifikation

Damit werden die Details der Datenquelle angegeben. Bei BigQuery werden damit beispielsweise Informationen zur BigQuery-Quelle angegeben.

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

  // Union field spec can be only one of the following:
  "bigQuery": {
    object (BigQueryDataSourceSpec)
  }
  // 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.

BigQuery-Datenquellenspezifikation

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-fähigen Google Cloud-Projekts mit angehängtem Rechnungskonto. Für Abfragen, die für die Datenquelle ausgeführt werden, wird das Projekt in Rechnung gestellt.

Union-Feld spec. Die tatsächliche Spezifikation. Für spec ist nur einer der folgenden Werte zulässig:
querySpec

object (BigQueryQuerySpec)

Ein BigQueryQuerySpec.

tableSpec

object (BigQueryTableSpec)

Ein BigQueryTableSpec.

BigQuery-Abfragespezifikation

Gibt eine benutzerdefinierte BigQuery-Abfrage an.

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

string

Der unformatierte Abfragestring.

BigQuery-Tabellenspezifikation

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 Sie nichts angeben, wird die projectId angenommen.

tableId

string

Die BigQuery-Tabellen-ID.

datasetId

string

Die BigQuery-Dataset-ID.

DataSourceParameter

Ein Parameter in der Abfrage einer Datenquelle. Mithilfe des Parameters kann der Nutzer Werte aus der Tabelle in 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 Parameter-ID. Für identifier ist nur einer der folgenden Werte zulässig:
name

string

Benannter Parameter Muss eine gültige Kennung für die DataSource sein, die sie unterstützt. Beispiel: BigQuery-Kennung

Union-Feld value. Der Wert des Parameters. Für value ist nur einer der folgenden Werte zulässig:
namedRangeId

string

ID einer NamedRange. Seine Größe muss 1 x 1 sein.

range

object (GridRange)

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

Datenquellenaktualisierung

Zeitplan für die Aktualisierung der Datenquelle festlegen.

Datenquellen in der Tabelle werden innerhalb eines bestimmten Zeitraums aktualisiert. Sie können die Startzeit angeben, indem Sie im Tabellen-Editor auf die Schaltfläche „Geplante Aktualisierung“ klicken. Das Intervall ist jedoch nach vier Stunden festgelegt. Wenn Sie beispielsweise eine Startzeit von 8:00 Uhr festlegen, erfolgt die Aktualisierung täglich zwischen 8:00 Uhr 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, oder „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. Zeitplankonfigurationen schedule_config können nur eine der folgenden sein:
dailySchedule

object (DataSourceRefreshDailySchedule)

Täglicher Aktualisierungszeitplan.

weeklySchedule

object (DataSourceRefreshWeeklySchedule)

Wöchentlicher Aktualisierungszeitplan.

monthlySchedule

object (DataSourceRefreshMonthlySchedule)

Monatlicher Zeitplan für die Aktualisierung.

DataRefreshRefreshScope

Die Bereiche für die Aktualisierung von Datenquellen.

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

DatenquelleAktualisierenTäglichTäglich

Ein Zeitplan für Daten, die jeden Tag in einem bestimmten Zeitintervall aktualisiert werden.

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

object (TimeOfDay)

Der Beginn eines Zeitintervalls, in dem eine Aktualisierung der Datenquelle geplant ist. Nur hours Teil wird verwendet. Die Größe des Zeitintervalls wird standardmäßig im Editor von Google Tabellen 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.

Wöchentliche Aktualisierung/wöchentlicher Zeitplan

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

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

object (TimeOfDay)

Der Beginn eines Zeitintervalls, in dem eine Aktualisierung der Datenquelle geplant ist. Nur hours Teil wird verwendet. Die Größe des Zeitintervalls wird standardmäßig im Editor von Google Tabellen festgelegt.

daysOfWeek[]

enum (DayOfWeek)

Wochentage, die aktualisiert werden sollen 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

Monatliche Aktualisierung der Datenquelle

Monatlicher Zeitplan für die Datenaktualisierung 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. Nur hours Teil wird verwendet. Die Größe des Zeitintervalls wird standardmäßig im Editor von Google Tabellen festgelegt.

daysOfMonth[]

integer

Tage des Monats, an denen die Aktualisierung ausgeführt werden soll. Es werden nur 1–28 unterstützt. Die Zuordnung erfolgt vom 1. zum 28. Tag. Es muss mindestens ein Tag angegeben werden.

Intervall

Ein Zeitintervall, das als Zeitstempelbeginn (einschließlich) und als Zeitstempelende (exklusiv) codiert ist.

Der Anfang muss kleiner oder gleich dem Ende sein. Wenn der Start dem Ende entspricht, ist das Intervall leer, d. h. kein Zeitpunkt. Wenn weder Start noch Ende angegeben sind, entspricht das Intervall jeder Zeit.

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

string (Timestamp format)

Optional. Inklusiver Beginn des Intervalls.

Bei Angabe eines Zeitstempels, der diesem Intervall entspricht, muss er identisch sein oder nach dem Start liegen.

endTime

string (Timestamp format)

Optional. Exklusives Ende des Intervalls.

Wenn angegeben, muss ein Zeitstempel für dieses Intervall vor dem Ende liegen.

Methoden

batchUpdate

Wendet eine oder mehrere Aktualisierungen auf die Tabelle an.

create

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

get

Gibt die Tabelle unter der angegebenen ID zurück

getByDataFilter

Gibt die Tabelle unter der angegebenen ID zurück