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 będące częścią arkusza kalkulacyjnego.

namedRanges[]

object (NamedRange)

Zakresy nadane zdefiniowane w arkuszu kalkulacyjnym.

spreadsheetUrl

string

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

Język arkusza kalkulacyjnego w jednym z tych formatów:

  • kod języka w formacie 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: przy aktualizacji tego pola nie wszystkie języki/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 nie rozpoznajemy strefy czasowej, 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 komórki ma taki sam format domyślny. To pole jest tylko do odczytu.

iterativeCalculationSettings

object (IterativeCalculationSettings)

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

spreadsheetTheme

object (SpreadsheetTheme)

Motyw zastosowany do arkusza kalkulacyjnego.

Okres przeliczania

Lista możliwych interwałów przeliczania.

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

Ustawienia obliczeń iteracyjnych

Ustawienia kontrolujące sposób zależności zależności cyklicznych za pomocą obliczeń iteracyjnych.

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

integer

Gdy obliczenia iteracyjne są włączone, maksymalna liczba rund obliczeniowych, które mają być wykonane.

convergenceThreshold

number

Gdy obliczenia iteracyjne są włączone, a wyniki kolejnych wyników różnią się od wartości mniejszej niż ta wartość progowa, zaokrąglania są przerywane.

Motyw arkusza kalkulacyjnego

Odzwierciedla motyw motywu arkusza kalkulacyjnego

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

string

Nazwa głównej rodziny czcionek.

themeColors[]

object (ThemeColorPair)

Kolory 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 bezpretensjonalny.

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

enum (ThemeColorType)

Typ koloru motywu arkusza kalkulacyjnego.

color

object (ColorStyle)

Beton odpowiadający kolorowi 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, który identyfikuje ź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 zostanie też utworzony powiązany arkusz DATA_SOURCE. Jeśli nie określisz wartości pola, identyfikator utworzonego arkusza zostanie wygenerowany losowo.

Specyfikacja DataSource

Określa szczegóły źródła danych. Na przykład w BigQuery podaje 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 przy wysyłaniu zapytań do tego źródła danych.

Pole sumy spec. Rzeczywista specyfikacja dla danego typu źródła danych. spec może mieć tylko jedną z tych wartości:
bigQuery

object (BigQueryDataSourceSpec)

BigQueryDataSourceSpec

Specyfikacja Źródło 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 Google Cloud obsługującego BigQuery z dołączonym kontem rozliczeniowym. Będzie naliczana opłata 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 BigQueryTable

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 tu żadnej wartości, zostanie domyślnie użyta wartość projectId.

tableId

string

Identyfikator tabeli BigQuery.

datasetId

string

Identyfikator zbioru danych BigQuery.

Parametr DataSource

Parametr w zapytaniu źródła danych. Ten parametr umożliwia 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 mieć tylko jedną z tych wartości:
name

string

Parametr nazwany. Musi być prawidłowym identyfikatorem DataSource, który je obsługuje. Przykład: identyfikator BigQuery.

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

string

Identyfikator: NamedRange. Jego rozmiar musi wynosić 1 x 1.

range

object (GridRange)

Zakres zawierający wartość parametru. Jego 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 przedziale czasu. Możesz ją ustawić w Edytorze Arkuszy Google, klikając przycisk Zaplanowane odświeżenie, ale odstęp między nimi jest ustawiony na 4 godziny. Jeśli na przykład określisz godzinę rozpoczęcia na 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ść „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ć ALL_DATA_SOURCES.

nextRun

object (Interval)

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

Pole sumy schedule_config. Konfiguracje harmonogramu schedule_config mogą być tylko jedną z tych opcji:
dailySchedule

object (DataSourceRefreshDailySchedule)

Harmonogram codziennego odświeżania.

weeklySchedule

object (DataSourceRefreshWeeklySchedule)

Harmonogram odświeżania tygodniowego.

monthlySchedule

object (DataSourceRefreshMonthlySchedule)

Miesięczny harmonogram odświeżania.

Zakres dat 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 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 odświeżania DataSource

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 jest zaplanowane odświeżanie źródła danych. Wykorzystywana jest tylko część hours. W edytorze Arkuszy rozmiar przedziału czasu jest domyślnie ustawiony.

Pora dnia

Wskazuje porę dnia. Data i strefa czasowa nie są znaczące lub zostały określone w innym miejscu. Interfejs API może zezwolić na sekundy przestępne. 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 dnia w formacie 24-godzinnym. Wartość powinna wynosić od 0 do 23. Interfejs API może zezwolić na wartość „24:00:00” w takich sytuacjach jak zamknięcie firmy.

minutes

integer

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

seconds

integer

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

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ślonych dniach 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 jest zaplanowane odświeżanie źródła danych. Wykorzystywana jest tylko część hours. W edytorze Arkuszy rozmiar przedziału czasu jest domyślnie ustawiony.

daysOfWeek[]

enum (DayOfWeek)

Dni tygodnia, w których chcesz odświeżyć dane. Należy określić co najmniej jeden dzień.

DzieńTygodnia

Wskazuje dzień tygodnia.

Wartości w polu enum
DAY_OF_WEEK_UNSPECIFIED Nie podano dnia tygodnia.
MONDAY poniedziałek
TUESDAY Wtorek
WEDNESDAY Środa
THURSDAY Thursday (czwartek)
FRIDAY piątek
SATURDAY Saturday (sobota)
SUNDAY niedziela

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

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

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

object (TimeOfDay)

Godzina rozpoczęcia przedziału czasu, w którym jest zaplanowane odświeżanie źródła danych. Wykorzystywana jest tylko część hours. W edytorze Arkuszy rozmiar przedziału czasu jest domyślnie ustawiony.

daysOfMonth[]

integer

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

Przedział

Odzwierciedla przedział czasu zakodowany jako początek sygnatury czasowej (włącznie) i zakończenie sygnatury czasowej (wyłącznie).

Początek nie może być mniejszy niż koniec. Jeśli początek oznacza koniec, przedział czasu jest pusty (nie dopasowuje czasu). Jeśli początek i koniec nie są określone, przedział czasu pasuje do dowolnego momentu.

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

string (Timestamp format)

Opcjonalnie. Początek przedziału czasu.

Jeśli podasz sygnaturę czasową, która będzie odpowiadać temu interwałowi, musi być taka sama jak data rozpoczęcia lub po niej.

endTime

string (Timestamp format)

Opcjonalnie. Koniec okresu interwału.

Jeśli podasz wartość sygnatury czasowej, która będzie odpowiadać interwałowi, musi on być poprzedzający jego koniec.

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.