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 następujących formatów:

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

  • kod języka zgodny ze standardem ISO 639-2, np. fil (jeśli nie ma kodu 639-1);

  • kombinację kodu języka w standardzie 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żesz wybrać własną, np. GMT-07:00.
defaultFormat

object (CellFormat)

Domyślny format wszystkich komórek w arkuszu kalkulacyjnym. Pole CellData.effectiveFormat nie zostanie ustawione, jeśli format komórki jest taki sam jak ten domyślny. To pole jest tylko do odczytu.
iterativeCalculationSettings

object (IterativeCalculationSettings)

Określa, czy i w jaki sposób odwołania cykliczne są przetwarzane za pomocą obliczeń iteracyjnych. Brak tego pola oznacza, że odwołania cykliczne powodują błędy w obliczeniach.
spreadsheetTheme

object (SpreadsheetTheme)

Motyw został zastosowany do arkusza kalkulacyjnego.
importFunctionsExternalUrlAccessAllowed

boolean

Określa, czy zezwolić na dostęp do zewnętrznych adresów URL w przypadku funkcji obrazów i importowania. Tylko do odczytu, jeśli ma wartość prawda. Jeśli ma wartość Fałsz, możesz podać wartość Prawda.

RecalculationInterval

Lista możliwych opcji interwału przeliczenia.

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

IterativeCalculationSettings

Ustawienia określające sposób 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 powtórzeń do wykonania.
convergenceThreshold

number

Gdy włączone są obliczenia iteracyjne, a kolejne wyniki różnią się o mniej niż wartość progowa, cykle obliczeń są zatrzymywane.

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 zaktualizować, musisz podać wszystkie pary kolorów motywu.

ThemeColorPair

Para przypisująca typ koloru motywu arkusza kalkulacyjnego do reprezentowanego przez niego koloru konkretnego koloru.

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

enum (ThemeColorType)

Typ koloru motywu arkusza kalkulacyjnego.
color

object (ColorStyle)

Kolor betonu odpowiadający rodzajowi 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)

Reprezentowany zakres.

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)

Wartość DataSourceSpec źródła danych połączonego z tym arkuszem kalkulacyjnym.
calculatedColumns[]

object (DataSourceColumn)

Wszystkie obliczone kolumny w źródle danych.
sheetId

integer

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

Podczas tworzenia źródła danych tworzony jest również powiązany arkusz DATA_SOURCE. Jeśli pole nie zostanie określone, identyfikator utworzonego arkusza zostanie wygenerowany losowo.

DataSourceSpec

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

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

object (DataSourceParameter)

Parametry źródła danych używane podczas wysyłania zapytań dotyczących źródła danych.
Pole sumy spec. Rzeczywista specyfikacja według typu źródła danych. spec może być tylko jedną z tych wartości:
bigQuery

object (BigQueryDataSourceSpec)

BigQueryDataSourceSpec.

BigQueryDataSourceSpec

Specyfikacja źródła danych BigQuery, które jest połączone 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łączonym BigQuery i powiązanego konta rozliczeniowego. W przypadku zapytań wykonanych do źródła danych naliczana jest opłata za projekt.
Pole sumy spec. faktyczną specyfikację; spec może być 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 wartości, zostanie domyślnie przyjęta wartość projectId.
tableId

string

Identyfikator tabeli BigQuery.
datasetId

string

Identyfikator zbioru danych BigQuery.

DataSourceParameter

Parametr w zapytaniu źródła danych. Umożliwia on użytkownikom 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 sumy identifier. Identyfikator parametru. identifier może być tylko jedną z tych wartości:
name

string

Parametr nazwany. Musi być prawdziwym identyfikatorem DataSource, który go obsługuje. Może to być na przykład identyfikator BigQuery.
Pole sumy value. Wartość parametru. value może być tylko jedną z tych wartości:
namedRangeId

string

Identyfikator elementu NamedRange. Wymagany rozmiar to 1 x 1.
range

object (GridRange)

Zakres zawierający wartość parametru. Wymagany rozmiar to 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ć czas rozpoczęcia, klikając przycisk Zaplanowane odświeżenie w edytorze Arkuszy, ale odstęp jest ustawiony na 4 godziny. Jeśli na przykład jako godzinę rozpoczęcia ustawisz 8:00 , odświeżanie będzie nawiązywane każdego dnia 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ść prawda, jeśli harmonogram odświeżania jest włączony, lub wartość fałsz w przeciwnym razie.
refreshScope

enum (DataSourceRefreshScope)

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

object (Interval)

Tylko dane wyjściowe. Odstęp czasu następnego uruchomienia.
Pole sumy schedule_config. Konfiguracja harmonogramu schedule_config może być tylko jedną z tych konfiguracji:
dailySchedule

object (DataSourceRefreshDailySchedule)

Dzienny harmonogram odświeżania.
weeklySchedule

object (DataSourceRefreshWeeklySchedule)

Tygodniowy harmonogram odświeżania.
monthlySchedule

object (DataSourceRefreshMonthlySchedule)

Miesięczny harmonogram odświeżania.

DataSourceRefreshScope

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

Wartości w polu enum
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED Wartość domyślna, nie 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.

DataSourceRefreshDailySchedule

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

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

object (TimeOfDay)

Czas rozpoczęcia przedziału czasu, w którym ma być zaplanowane odświeżenie źródła danych. Używana jest tylko hours część. Domyślnie rozmiar przedziału czasu jest taki sam jak w edytorze Arkuszy.

TimeOfDay

Reprezentuje porę dnia. Data i strefa czasowa są nieistotne lub zostały określone w innym miejscu. Interfejs API może zezwolić na sekundy przestępne. Powiązane typy: google.type.Date i google.protobuf.Timestamp.

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

integer

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

integer

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

integer

Sekundy minut czasu. Wartość musi mieścić się w przedziale od 0 do 59. Interfejs API może zezwolić na wartość 60, jeśli zezwala na sekundy przestępne.
nanos

integer

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

DataSourceRefreshWeeklySchedule

Tygodniowy harmonogram odświeżania danych w określonych dniach w danym przedziale czasu.

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

object (TimeOfDay)

Czas rozpoczęcia przedziału czasu, w którym ma być zaplanowane odświeżenie źródła danych. Używana jest tylko hours część. Domyślnie rozmiar przedziału czasu jest taki sam jak w edytorze Arkuszy.
daysOfWeek[]

enum (DayOfWeek)

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

DayOfWeek

Reprezentuje 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 czwartek
FRIDAY Piątek
SATURDAY Saturday (sobota)
SUNDAY niedziela

DataSourceRefreshMonthlySchedule

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

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

object (TimeOfDay)

Czas rozpoczęcia przedziału czasu, w którym ma być zaplanowane odświeżenie źródła danych. Używana jest tylko hours część. Domyślnie rozmiar przedziału czasu jest taki sam jak w edytorze Arkuszy.
daysOfMonth[]

integer

Dni miesiąca, w których ma się odświeżać. Obsługiwane są tylko wartości 1–28, mapowanie na zakres od 1 do 28 dnia. Musisz określić co najmniej 1 dzień.

Odstęp

Reprezentuje przedział czasu zakodowany jako początek sygnatury czasowej (włącznie) i koniec sygnatury czasowej (bez uwzględnienia).

Początek nie może być dłuższy niż koniec. Gdy początek jest równy końcowi, interwał jest pusty (nie pasuje do czasu). Jeśli początek i koniec nie są określone, interwał pasuje do dowolnego momentu.

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

string (Timestamp format)

Opcjonalnie. Początek interwału włączający.

Jeśli zostanie określony, sygnatura czasowa pasująca do tego interwału musi być taka sama lub późniejsza.
endTime

string (Timestamp format)

Opcjonalnie. Wyłączny koniec interwału.

Jeśli zostanie określona, sygnatura czasowa pasująca do tego interwału musi przypadać przed końcem.

Metody

batchUpdate

 Stosuje co najmniej jedną aktualizację w arkuszu kalkulacyjnym.

create

 Tworzy arkusz kalkulacyjny i zwraca nowo utworzony arkusz kalkulacyjny.

get

 Zwraca arkusz kalkulacyjny o podanym identyfikatorze.

getByDataFilter

 Zwraca arkusz kalkulacyjny o podanym identyfikatorze.