REST Resource: spreadsheets

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, które są 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.

SpreadsheetProperties

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)
  },
  "importFunctionsExternalUrlAccessAllowed": boolean
}
Pola
title

string

Tytuł arkusza kalkulacyjnego.
locale

string

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

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

  • kod języka 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 są obsługiwane.
autoRecalc

enum (RecalculationInterval)

Czas oczekiwania przed ponownym obliczeniem 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 format komórki jest równy temu domyślnemu. To pole jest tylko do odczytu.
iterativeCalculationSettings

object (IterativeCalculationSettings)

Określa, czy i jak odwołania cykliczne są rozwiązywane przy użyciu obliczeń iteracyjnych. Brak tego pola oznacza, że odwołania cykliczne powodują błędy obliczeń.
spreadsheetTheme

object (SpreadsheetTheme)

Motyw zastosowany do arkusza kalkulacyjnego.
importFunctionsExternalUrlAccessAllowed

boolean

Określa, czy zezwolić funkcjom obrazów i importowania na dostęp do zewnętrznych adresów URL. Tylko do odczytu, gdy jest to prawda. Jeśli ustawisz wartość Fałsz, możesz ustawić wartość true (prawda). Ta wartość będzie pomijana i zawsze będzie zwracać wartość „prawda”, jeśli administrator włączył funkcję dodawania do listy dozwolonych.

RecalculationInterval

Lista możliwych opcji interwału ponownego obliczania.

Wartości w polu enum
RECALCULATION_INTERVAL_UNSPECIFIED Wartość domyślna. Nie należy używać tej wartości.
ON_CHANGE Funkcje zmienne są aktualizowane przy każdej zmianie.
MINUTE Funkcje zmienne są aktualizowane przy każdej zmianie i co minutę.
HOUR Funkcje zmienne są aktualizowane przy każdej zmianie i co godzinę.

IterativeCalculationSettings

Ustawienia sterujące sposobem rozwiązywania zależności cyklicznych za pomocą obliczeń iteracyjnych.

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

integer

Gdy włączone są obliczenia iteracyjne, maksymalna liczba rund obliczeń do wykonania.
convergenceThreshold

number

Gdy włączone są obliczenia iteracyjne, a kolejne wyniki różnią się o mniej niż ta wartość progowa, zaokrąglanie obliczeń zostanie zatrzymane.

SpreadsheetTheme

Reprezentuje motyw arkusza kalkulacyjnego

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

string

Nazwa podstawowej rodziny czcionek.
themeColors[]

object (ThemeColorPair)

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

ThemeColorPair

Para mapująca typ koloru motywu arkusza kalkulacyjnego na kolor betonowy, który reprezentuje.

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

enum (ThemeColorType)

Typ koloru motywu arkusza kalkulacyjnego.
color

object (ColorStyle)

Kolor odpowiadający danemu typowi koloru motywu.

NamedRange

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 reprezentowany przez tę wartość.

DataSource

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, który identyfikuje źródło danych. Przykład: 1080547365.
spec

object (DataSourceSpec)

Pole 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 tworzona jest też powiązana karta DATA_SOURCE. Jeśli to pole nie zostanie określone, identyfikator utworzonej karty zostanie wygenerowany losowo.

DataSourceSpec

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

Zapis JSON 
{
  "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.
}
Pola
parameters[]

object (DataSourceParameter)

Parametry źródła danych używane podczas wysyłania zapytań do źródła danych.
Pole unii spec. Rzeczywista specyfikacja dla danego typu źródła danych. spec może mieć tylko jedną z tych wartości:
bigQuery

object (BigQueryDataSourceSpec)

BigQueryDataSourceSpec.
looker

object (LookerDataSourceSpec)

[LookerDatasourceSpec][].

BigQueryDataSourceSpec

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 Google Cloud z włączoną usługą BigQuery, z dołączonym kontem rozliczeniowym. Za każde zapytanie wykonane w źródle danych naliczana jest opłata.
Pole sumy spec. Rzeczywista specyfikacja. spec może mieć tylko jedną z tych wartości:
querySpec

object (BigQueryQuerySpec)

BigQueryQuerySpec.
tableSpec

object (BigQueryTableSpec)

BigQueryTableSpec.

BigQueryQuerySpec

Określa niestandardowe zapytanie BigQuery.

Zapis JSON 
{
  "rawQuery": string
}
Pola
rawQuery

string

Nieprzetworzony ciąg zapytania.

BigQueryTableSpec

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 podasz żadnej opcji, zostanie użyta wartość domyślna projectId.
tableId

string

Identyfikator tabeli BigQuery.
datasetId

string

Identyfikator zbioru danych BigQuery.

LookerDataSourceSpec

Specyfikacja źródła danych Looker.

Zapis JSON 
{
  "instanceUri": string,
  "model": string,
  "explore": string
}
Pola
instanceUri

string

Adres URL instancji Lookera.
model

string

Nazwa modelu Lookera.
explore

string

Nazwa wglądu w model Lookera.

DataSourceParameter

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

Zapis JSON 
{

  // 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.
}
Pola
Pole unii identifier. Identyfikator parametru. identifier może być tylko jednym z tych elementów:
name

string

Nazwany parametr. Musi być prawidłowym identyfikatorem elementu 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. Jego rozmiar musi wynosić 1 x 1.
range

object (GridRange)

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

DataSourceRefreshSchedule

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

Źródła danych w arkuszu kalkulacyjnym są odświeżane w określonym przedziale czasu. Możesz określić godzinę rozpoczęcia, klikając przycisk Zaplanowane odświeżenie w edytorze Arkuszy, ale jest on ustalony na 4 godziny. Jeśli np. określisz godzinę rozpoczęcia na 8:00, odświeżanie będzie się odbywać 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ść true, jeśli harmonogram odświeżania jest włączony, a w przeciwnym razie – false.
refreshScope

enum (DataSourceRefreshScope)

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

object (Interval)

Tylko dane wyjściowe. Przedział czasu następnego uruchomienia.
Pole unii schedule_config. schedule_config może mieć tylko jedną z tych konfiguracji harmonogramu:
dailySchedule

object (DataSourceRefreshDailySchedule)

Harmonogram codziennego odświeżania.
weeklySchedule

object (DataSourceRefreshWeeklySchedule)

Harmonogram odświeżania co tydzień.
monthlySchedule

object (DataSourceRefreshMonthlySchedule)

Harmonogram odświeżania miesięcznego.

DataSourceRefreshScope

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

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

DataSourceRefreshDailySchedule

harmonogram odświeżania danych codziennie w określonym przedziale czasu;

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

object (TimeOfDay)

Godzina rozpoczęcia przedziału czasu, w którym zaplanowano odświeżenie źródła danych. Wykorzystana jest tylko część hours. Domyślny rozmiar przedziału czasu jest ustawiany na wartość domyślną w edytorze Arkuszy.

TimeOfDay

Oznacza porę dnia. Data i strefa czasowa są nieistotne lub zostały określone w innym miejscu. Interfejs API może zezwalać na sekundy przesunięte. Powiązane typy to 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 wartość „24:00:00” w przypadku scenariuszy takich jak godziny zamknięcia firmy.
minutes

integer

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

integer

sekundy, Wartość musi mieścić się w zakresie od 0 do 59. Interfejs API może akceptować wartość 60, jeśli zezwala na użycie sekund przestępnych.
nanos

integer

Ułamki sekundy w nanosekundach. Musi mieścić się w przedziale od 0 do 999 999 999.

DataSourceRefreshWeeklySchedule

Tygodniowy 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)

Czas rozpoczęcia przedziału czasowego, w którym zaplanowano odświeżanie źródła danych. Wykorzystywana jest tylko część hours. Domyślny rozmiar przedziału czasowego jest taki sam jak w edytorze Arkuszy.
daysOfWeek[]

enum (DayOfWeek)

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

DzieńTygodnia

Reprezentuje dzień tygodnia.

Wartości w polu enum
DAY_OF_WEEK_UNSPECIFIED Dzień tygodnia jest nieokreślony.
MONDAY Poniedziałek
TUESDAY Tuesday (wtorek)
WEDNESDAY Wednesday (środa)
THURSDAY Thursday (czwartek)
FRIDAY Friday (piątek)
SATURDAY Saturday (sobota)
SUNDAY niedziela

DataSourceRefreshMonthlySchedule

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

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

object (TimeOfDay)

Godzina rozpoczęcia przedziału czasu, w którym zaplanowano odświeżenie źródła danych. Wykorzystana jest tylko część hours. Rozmiar przedziału czasowego jest domyślnie ustawiany zgodnie z ustawieniami w edytorze Arkuszy.
daysOfMonth[]

integer

Dni miesiąca, w których ma być przeprowadzane odświeżanie. Obsługiwane są tylko wartości od 1 do 28, czyli od 1. do 28. dnia. Musisz określić co najmniej 1 dzień.

Interwał

Reprezentuje przedział czasu zakodowany jako sygnatura czasowa rozpoczęcia (włącznie) i sygnatura czasowa zakończenia (wyłącznie).

Początek musi być mniejszy lub równy końcowi. Gdy początek jest równy końcowi, przedział jest pusty (nie odpowiada żadnemu czasowi). Jeśli nie określisz ani początku, ani końca, interwał będzie pasował do dowolnego czasu.

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

string (Timestamp format)

Opcjonalnie: Początek przedziału (włącznie).

Jeśli podasz sygnaturę czasową pasującą do tego interwału, będzie ona taka sama lub po jego rozpoczęciu.
endTime

string (Timestamp format)

Opcjonalnie: Wyłączny koniec interwału.

Jeśli określisz sygnaturę czasową pasującą do tego interwału, musi ona przypadać przed jego końcem.

Metody

batchUpdate

 Powoduje zastosowanie do arkusza kalkulacyjnego co najmniej jednej aktualizacji.

create

 Tworzy arkusz kalkulacyjny i zwraca nowo utworzony arkusz kalkulacyjny.

get

 Zwraca arkusz kalkulacyjny o podanym identyfikatorze.

getByDataFilter

 Zwraca arkusz kalkulacyjny o podanym identyfikatorze.