REST Resource: spreadsheets

Ressource: Tabelle

Ressource, die eine Tabellenkalkulation 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)

Gesamteigenschaften einer Tabellenkalkulation.

sheets[]

object (Sheet)

Die Tabellenblätter, die Teil einer Tabellenkalkulation sind.

namedRanges[]

object (NamedRange)

Die benannten Bereiche, die in einer Tabelle definiert sind.

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.

SpreadsheetProperties

Eigenschaften einer Tabellenkalkulation.

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

Das Gebietsschema der Tabelle in einem der folgenden Formate:

  • ein ISO 639-1-Sprachcode wie en

  • ein 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: Beim Aktualisieren dieses Feldes werden nicht alle Sprachen/Sprachen unterstützt.

autoRecalc

enum (RecalculationInterval)

Die Wartezeit, bis flüchtige Funktionen neu berechnet werden.

timeZone

string

Die Zeitzone der Tabelle im CLDR-Format, z. B. America/New_York. Wenn die Zeitzone nicht erkannt wird, ist dies möglicherweise eine benutzerdefinierte Zeitzone wie GMT-07:00.

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 Zirkelbezüge mit iterativer Berechnung aufgelöst werden. Das Fehlen dieses Feldes bedeutet, dass Zirkelbezüge zu Berechnungsfehlern führen.

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 zugelassen wird. Nur lesen, wenn „true“ festgelegt ist. Wenn „false“, können Sie auf „true“ setzen.

RecalculationInterval

Eine Aufzählung der möglichen Neuberechnungsintervalle.

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 minütlich aktualisiert.
HOUR Veränderliche Funktionen werden bei jeder Änderung und stündlich aktualisiert.

IterativeCalculationSettings

Einstellungen zum Steuern, wie zirkuläre Abhängigkeiten mit iterativer Berechnung aufgelöst werden.

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

integer

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

convergenceThreshold

number

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

SpreadsheetTheme

Steht für das 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 Design-Farbpaare angeben.

ThemeColorPair

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

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

enum (ThemeColorType)

Der Typ der Farbe des Tabellendesigns.

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 Wert 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 verbunden ist.

calculatedColumns[]

object (DataSourceColumn)

Alle berechneten Spalten in der Datenquelle.

sheetId

integer

Die ID des Sheet, der mit der Datenquelle verbunden ist. Sobald das Feld festgelegt wurde, kann es nicht mehr geändert werden.

Beim Erstellen einer Datenquelle wird auch ein verknüpftes DATA_SOURCE-Tabellenblatt erstellt. Wenn das Feld nicht angegeben ist, wird die ID des erstellten Tabellenblatts nach dem Zufallsprinzip generiert.

DataSourceSpec

Damit werden die Details der Datenquelle angegeben. Bei BigQuery werden dadurch 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.

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-fähigen Google Cloud-Projekts mit einem verknüpften Rechnungskonto. Für alle Abfragen, die für die Datenquelle ausgeführt werden, wird das Projekt 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. Nur native Tabellen sind zulässig.

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

string

Die ID des BigQuery-Projekts, zu dem die Tabelle gehört. Wenn keine Angabe erfolgt, wird projectId angenommen.

tableId

string

Die BigQuery-Tabellen-ID.

datasetId

string

Die BigQuery-Dataset-ID.

DataSourceParameter

Ein Parameter in der Abfrage einer Datenquelle. Mit dem Parameter können 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 Parameterwert. Für value ist nur einer der folgenden Werte zulässig:
namedRangeId

string

ID von NamedRange. Die Größe muss 1 × 1 sein.

range

object (GridRange)

Bereich, der den Wert des Parameters enthält. Die Größe muss 1 × 1 sein.

DataSourceRefreshSchedule

Zeitplan für die Aktualisierung der Datenquelle.

Datenquellen in der Tabelle werden innerhalb eines bestimmten Zeitintervalls aktualisiert. Sie können den Beginn festlegen, indem Sie im Google Tabellen-Editor auf die Schaltfläche Geplante Aktualisierung klicken. Das Intervall beträgt jedoch vier Stunden. Wenn Sie beispielsweise als Startzeit 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, 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. Die Zeitplankonfigurationen schedule_config können nur eine der folgenden sein:
dailySchedule

object (DataSourceRefreshDailySchedule)

Täglicher Aktualisierungsplan.

weeklySchedule

object (DataSourceRefreshWeeklySchedule)

Wöchentlicher Aktualisierungsplan.

monthlySchedule

object (DataSourceRefreshMonthlySchedule)

Monatlicher Aktualisierungsplan.

DataSourceRefreshScope

Aktualisierungsbereiche der Datenquelle.

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.

DataSourceRefreshDailySchedule

Ein Zeitplan für die tägliche Aktualisierung der Daten in einem bestimmten Zeitintervall.

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

object (TimeOfDay)

Der Beginn eines Zeitintervalls, in dem eine Aktualisierung der Datenquelle geplant ist. Es wird nur hours Teil verwendet. Die Standardgröße des Zeitintervalls entspricht der im Google Tabellen-Editor.

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 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. Es wird nur hours Teil verwendet. Die Standardgröße des Zeitintervalls entspricht der im Google Tabellen-Editor.

daysOfWeek[]

enum (DayOfWeek)

Zu aktualisierende Wochentage. 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 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. Es wird nur hours Teil verwendet. Die Standardgröße des Zeitintervalls entspricht der im Google Tabellen-Editor.

daysOfMonth[]

integer

Tage des Monats, die aktualisiert werden sollen Es werden nur 1–28 unterstützt, wobei die Zuordnung dem 1. bis 28. Tag erfolgt. Es muss mindestens ein Tag angegeben werden.

Intervall

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

Der Start muss kleiner oder gleich dem Ende sein. Wenn der Start dem Ende entspricht, ist das Intervall leer (keine Zeitangabe). Wenn Start und Ende nicht angegeben sind, entspricht das Intervall einer beliebigen Zeit.

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

string (Timestamp format)

Optional. Inklusiver Beginn des Intervalls.

Wenn angegeben, muss ein Zeitstempel, der mit diesem Intervall übereinstimmt, dem Beginn entsprechen oder nach dem Beginn liegen.

endTime

string (Timestamp format)

Optional. Exklusives Ende des Intervalls.

Wenn angegeben, muss ein Zeitstempel, der mit diesem Intervall übereinstimmt, 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 das Arbeitsblatt unter der angegebenen ID zurück

getByDataFilter

Gibt das Arbeitsblatt unter der angegebenen ID zurück