REST Resource: spreadsheets

Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.

Zasób: arkusz kalkulacyjny

Zasób reprezentujący arkusz kalkulacyjny.

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

string

Identyfikator arkusza kalkulacyjnego. To pole jest tylko do odczytu.

properties

object (SpreadsheetProperties)

Ogólne właściwości arkusza kalkulacyjnego.

sheets[]

object (Sheet)

Arkusze będące częścią arkusza kalkulacyjnego.

namedRanges[]

object (NamedRange)

Zakresy nazwane zdefiniowane w arkuszu kalkulacyjnym.

spreadsheetUrl

string

Adres URL arkusza kalkulacyjnego. To pole jest tylko do odczytu.

developerMetadata[]

object (DeveloperMetadata)

Metadane dewelopera powiązane z arkuszem kalkulacyjnym.

dataSources[]

object (DataSource)

Lista zewnętrznych źródeł danych połączonych z arkuszem kalkulacyjnym.

dataSourceSchedules[]

object (DataSourceRefreshSchedule)

Tylko dane wyjściowe. Lista harmonogramów odświeżania źródła danych.

Właściwości arkusza kalkulacyjnego

Właściwości arkusza kalkulacyjnego.

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

string

Tytuł arkusza kalkulacyjnego.

locale

string

Ustawienia regionalne arkusza kalkulacyjnego w jednym z tych formatów:

  • kod języka w formacie ISO 639-1, np. en

  • kod języka w formacie ISO 639-2, np. fil, jeśli nie ma kodu 639-1.

  • kombinacja kodu języka ISO i kodu kraju, np. en_US

Uwaga: podczas aktualizowania tego pola nie wszystkie języki i języki są obsługiwane.

autoRecalc

enum (RecalculationInterval)

Czas oczekiwania na ponowne obliczenie funkcji zmiennych.

timeZone

string

Strefa czasowa arkusza kalkulacyjnego w formacie CLDR, np. America/New_York. Jeśli strefa czasowa nie zostanie rozpoznana, może to być niestandardowa strefa czasowa, np. GMT-07:00.

defaultFormat

object (CellFormat)

Domyślny format wszystkich komórek w arkuszu kalkulacyjnym. CellData.effectiveFormat nie zostanie ustawiony, jeśli komórka ma taki sam format domyślny. To pole jest tylko do odczytu.

iterativeCalculationSettings

object (IterativeCalculationSettings)

Określa, czy i w jaki sposób są obliczane odwołania cykliczne za pomocą obliczeń iteracyjnych. Brak pola oznacza, że odwołania okrągłe powodują błędy obliczeniowe.

spreadsheetTheme

object (SpreadsheetTheme)

Motyw zastosowany do arkusza kalkulacyjnego.

Przedział obliczeniowy

Lista możliwych interwałów przeliczenia.

Wartości w polu enum
RECALCULATION_INTERVAL_UNSPECIFIED Wartość domyślna. Tej wartości nie można używać.
ON_CHANGE Funkcje zmiennych są aktualizowane po każdej zmianie.
MINUTE Funkcje zmiennych są aktualizowane po każdej zmianie i co minutę.
HOUR Funkcje zmiennych są aktualizowane po każdej zmianie i co godzinę.

Ustawienia obliczeń iteracyjnych

Ustawienia umożliwiające określanie sposobu rozwiązywania zależności cyklicznych za pomocą obliczeń iteracyjnych.

Zapis JSON
{
  "maxIterations": integer,
  "convergenceThreshold": number
}
Pola
maxIterations

integer

Gdy włączone jest obliczenia iteracyjne, maksymalna liczba powtórzeń podczas obliczeń.

convergenceThreshold

number

Gdy obliczenia iteracyjne są włączone, a wyniki po kolei różnią się od tej wartości progowej, cykle obliczania są zatrzymane.

Motyw arkusza kalkulacyjnego

Reprezentuje motyw arkusza kalkulacyjnego

Zapis JSON
{
  "primaryFontFamily": string,
  "themeColors": [
    {
      object (ThemeColorPair)
    }
  ]
}
Pola
primaryFontFamily

string

Nazwa głównej rodziny czcionek.

themeColors[]

object (ThemeColorPair)

Pary kolorystyczne motywu arkusza kalkulacyjnego. Aby przeprowadzić aktualizację, musisz podać wszystkie pary kolorów motywu.

Para kolorów motywu

Para określająca typ koloru motywu arkusza kalkulacyjnego na kolor, który reprezentuje beton.

Zapis JSON
{
  "colorType": enum (ThemeColorType),
  "color": {
    object (ColorStyle)
  }
}
Pola
colorType

enum (ThemeColorType)

Typ koloru motywu arkusza kalkulacyjnego.

color

object (ColorStyle)

Betonowy kolor odpowiadający typowi koloru motywu.

NazwanyZakres

Zakres nazwany.

Zapis JSON
{
  "namedRangeId": string,
  "name": string,
  "range": {
    object (GridRange)
  }
}
Pola
namedRangeId

string

Identyfikator zakresu nazwanego.

name

string

Nazwa zakresu nazwanego.

range

object (GridRange)

Zakres, który reprezentuje.

Źródło danych

Informacje o zewnętrznym źródle danych w arkuszu kalkulacyjnym.

Zapis JSON
{
  "dataSourceId": string,
  "spec": {
    object (DataSourceSpec)
  },
  "calculatedColumns": [
    {
      object (DataSourceColumn)
    }
  ],
  "sheetId": integer
}
Pola
dataSourceId

string

Unikalny identyfikator ograniczony do arkusza kalkulacyjnego identyfikujący źródło danych. Przykład: 1080547365.

spec

object (DataSourceSpec)

DataSourceSpec źródła danych połączonego z tym arkuszem kalkulacyjnym.

calculatedColumns[]

object (DataSourceColumn)

Wszystkie obliczone kolumny w źródle danych.

sheetId

integer

Identyfikator elementu Sheet połączonego ze źródłem danych. Po ustawieniu pola nie można go zmienić.

Podczas tworzenia źródła danych tworzony jest powiązany arkusz DATA_SOURCE. Jeśli nie określisz wartości pola, identyfikator utworzonego arkusza zostanie wygenerowany losowo.

Specyfikacja źródła danych

Określa to szczegóły źródła danych. Na przykład w BigQuery określa informacje o źródle BigQuery.

Zapis JSON
{
  "parameters": [
    {
      object (DataSourceParameter)
    }
  ],
  "bigQuery": {
    object (BigQueryDataSourceSpec)
  }
}
Pola
parameters[]

object (DataSourceParameter)

Parametry źródła danych używane podczas wysyłania zapytań do źródła danych.

bigQuery

object (BigQueryDataSourceSpec)

BigQueryDataSourceSpec

Specyfikacja Źródła danych BigQuery

Specyfikacja źródła danych BigQuery połączonego z arkuszem.

Zapis JSON
{
  "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.
}
Pola
projectId

string

Identyfikator projektu GCP obsługującego BigQuery z dołączonym kontem rozliczeniowym. Opłata zostanie naliczona za każde zapytanie wykonane na źródle danych.

Pole sumy: spec. Rzeczywista specyfikacja. spec może mieć tylko jedną z tych wartości:
querySpec

object (BigQueryQuerySpec)

BigQueryQuerySpec

tableSpec

object (BigQueryTableSpec)

BigQueryTableSpec

Specyfikacja BigQuery

Określa niestandardowe zapytanie BigQuery.

Zapis JSON
{
  "rawQuery": string
}
Pola
rawQuery

string

Nieprzetworzony ciąg zapytania.

Specyfikacja BigQuery Tables

Określa definicję tabeli BigQuery. Dozwolone są tylko tabele natywne.

Zapis JSON
{
  "tableProjectId": string,
  "tableId": string,
  "datasetId": string
}
Pola
tableProjectId

string

Identyfikator projektu BigQuery, do którego należy tabela. Jeśli nie zostanie podany, przyjmuje się wartość projectId.

tableId

string

Identyfikator tabeli BigQuery.

datasetId

string

Identyfikator zbioru danych BigQuery.

Parametr DataSource

Parametr w zapytaniu źródła danych. Ten parametr pozwala użytkownikowi przekazać wartości z arkusza kalkulacyjnego do zapytania.

Zapis JSON
{
  "name": string,

  // 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.
}
Pola
name

string

Parametr nazwany. Musi być prawidłowym identyfikatorem zasobu DataSource, który go obsługuje. Na przykład Identyfikator BigQuery.

Pole sumy: value. Wartość parametru. value może mieć tylko jedną z tych wartości:
namedRangeId

string

Identyfikator elementu NamedRange. Jej rozmiar musi wynosić 1 x 1.

range

object (GridRange)

Zakres zawierający wartość parametru. Jej rozmiar musi wynosić 1 x 1.

Harmonogram odświeżania źródła danych

Zaplanuj odświeżenie źródła danych.

Źródła danych w arkuszu kalkulacyjnym są odświeżane w odstępach czasu. Aby ustawić godzinę rozpoczęcia, kliknij przycisk Zaplanowane odświeżenie w edytorze Arkuszy, ale interwał jest ustawiony na 4 godziny. Jeśli na przykład określisz godzinę rozpoczęcia 8:00, odświeżanie będzie odbywać się codziennie między 8:00 a 12:00.

Zapis JSON
{
  "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.
}
Pola
enabled

boolean

Wartość to „prawda”, jeśli harmonogram odświeżania jest włączony, lub „fałsz”, jeśli nie.

refreshScope

enum (DataSourceRefreshScope)

Zakres odświeżania. Musi to być wartość ALL_DATA_SOURCES.

nextRun

object (Interval)

Tylko dane wyjściowe. Przedział czasu następnego uruchomienia.

Pole sumy: schedule_config. Konfiguracje harmonogramu schedule_config mogą mieć tylko jedną z tych wartości:
dailySchedule

object (DataSourceRefreshDailySchedule)

Dzienny harmonogram odświeżania.

weeklySchedule

object (DataSourceRefreshWeeklySchedule)

Cotygodniowy harmonogram odświeżania.

monthlySchedule

object (DataSourceRefreshMonthlySchedule)

Harmonogram odświeżania miesięcznego.

Zakres odświeżania źródła danych

Zakresy odświeżania źródła danych.

Wartości w polu enum
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED Wartość domyślna. Nie należy jej używać.
ALL_DATA_SOURCES Odświeża wszystkie źródła danych i powiązane z nimi obiekty źródeł danych w arkuszu kalkulacyjnym.

Harmonogram codziennego odświeżania źródeł

Harmonogram odświeżania danych codziennie w danym przedziale czasu.

Zapis JSON
{
  "startTime": {
    object (TimeOfDay)
  }
}
Pola
startTime

object (TimeOfDay)

Godzina rozpoczęcia przedziału czasu, w którym zaplanowane jest odświeżenie źródła danych. Użyta jest tylko część hours. Domyślny odstęp czasu jest taki sam w edytorze Arkuszy.

pora dnia

Określa godzinę. Data i strefa czasowa nie są istotne lub są podane w innym miejscu. Interfejs API może zezwolić na dodatkowe sekundy. Powiązane typy: google.type.Date i google.protobuf.Timestamp.

Zapis JSON
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Pola
hours

integer

Godziny w formacie 24-godzinnym. Wartość powinna mieścić się w zakresie od 0 do 23. Interfejs API może zezwalać na używanie wartości „24:00:00” w sytuacjach takich jak czas zamknięcia firmy.

minutes

integer

Minuty dnia. Wartość musi mieścić się w przedziale od 0 do 59.

seconds

integer

Sekund w minutach. Wartość musi mieścić się w zakresie od 0 do 59. Interfejs API może zezwalać na wartość 60, jeśli zezwala na sekundy dodatkowe.

nanos

integer

Ułamki sekund w nanosekundach. Wartość musi mieścić się w zakresie od 0 do 999 999 999.

Harmonogram odświeżania źródła danych

Cotygodniowy harmonogram odświeżania danych w określone dni w danym przedziale czasu.

Zapis JSON
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
Pola
startTime

object (TimeOfDay)

Godzina rozpoczęcia przedziału czasu, w którym zaplanowane jest odświeżenie źródła danych. Użyta jest tylko część hours. Domyślny odstęp czasu jest taki sam w edytorze Arkuszy.

daysOfWeek[]

enum (DayOfWeek)

Dni tygodnia do odświeżenia. Musisz określić co najmniej 1 dzień.

DzieńTygodnia

Wskazuje dzień tygodnia.

Wartości w polu enum
DAY_OF_WEEK_UNSPECIFIED Dzień tygodnia nie jest określony.
MONDAY poniedziałek
TUESDAY Wtorek
WEDNESDAY środa
THURSDAY Thursday (czwartek)
FRIDAY Piątek
SATURDAY Saturday (sobota)
SUNDAY niedziela

Harmonogram miesięczny odświeżania danych

Miesięczny harmonogram odświeżania danych w określone dni miesiąca w danym przedziale czasu.

Zapis JSON
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfMonth": [
    integer
  ]
}
Pola
startTime

object (TimeOfDay)

Godzina rozpoczęcia przedziału czasu, w którym zaplanowane jest odświeżenie źródła danych. Użyta jest tylko część hours. Domyślny odstęp czasu jest taki sam w edytorze Arkuszy.

daysOfMonth[]

integer

Dni miesiąca do odświeżenia. Obsługiwane jest tylko 1–28 mapowań z 1 na 28 dnia. Należy określić co najmniej jeden dzień.

Przedział

Reprezentuje przedział czasu zakodowany jako początek i godzina sygnatury czasowej (włącznie) oraz zakończenie (sygnatura czasowa).

Początek nie może być dłuższy niż koniec. Jeśli początek jest końcem, interwał jest pusty (nie pasuje do czasu). Jeśli czas rozpoczęcia i zakończenie nie zostaną określone, interwał czasu będzie pasował w każdej chwili.

Zapis JSON
{
  "startTime": string,
  "endTime": string
}
Pola
startTime

string (Timestamp format)

Opcjonalnie. Początek przedziału czasu.

Jeśli zostanie określona, sygnatura czasowa pasująca do tego interwału musi być taka sama lub po rozpoczęciu.

endTime

string (Timestamp format)

Opcjonalnie. Wyłączny koniec przedziału czasu.

Jeśli podasz wartość, sygnatura czasowa pasująca do tego interwału będzie musiała przypadać przed końcem.

Metody

batchUpdate

Stosuje co najmniej jedną aktualizację arkusza kalkulacyjnego.

create

Tworzy arkusz kalkulacyjny, zwracając nowo utworzony.

get

Zwraca arkusz kalkulacyjny o podanym identyfikatorze.

getByDataFilter

Zwraca arkusz kalkulacyjny o podanym identyfikatorze.