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)
    }
  ],
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "commentsViewMode": enum (CommentsViewMode)
}
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ódeł danych.
comments[]

object (CommentThread)

Wątki komentarzy powiązane z arkuszem kalkulacyjnym.

commentsViewMode

enum (CommentsViewMode)

Tylko dane wyjściowe. Tryb widoku komentarzy zastosowany do arkusza kalkulacyjnego.

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

Język 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 w formacie 639-1;

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

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

enum (RecalculationInterval)

Czas oczekiwania przed ponownym obliczeniem funkcji niestabilnych.
timeZone

string

Strefa czasowa arkusza kalkulacyjnego w formacie CLDR, np. America/New_York. Jeśli strefa czasowa nie jest rozpoznawana, może to być strefa niestandardowa, 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 formatowi domyślnemu. To pole jest tylko do odczytu.
iterativeCalculationSettings

object (IterativeCalculationSettings)

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

object (SpreadsheetTheme)

Motyw zastosowany w arkuszu kalkulacyjnym.
importFunctionsExternalUrlAccessAllowed

boolean

Określa, czy zezwalać na dostęp do zewnętrznych adresów URL w przypadku funkcji obrazu i importu. Odczytuj tylko wtedy, gdy warunek jest prawdziwy. Jeśli ma wartość „false”, możesz ustawić ją na „true”. Ta wartość zostanie pominięta i zawsze będzie zwracać wartość „prawda”, jeśli administrator włączył funkcję listy dozwolonych.

RecalculationInterval

Wyliczenie możliwych opcji interwału ponownego obliczania.

Wartości w polu enum
RECALCULATION_INTERVAL_UNSPECIFIED Wartość domyślna. Nie można użyć tej wartości.
ON_CHANGE Funkcje zmienne są aktualizowane po każdej zmianie.
MINUTE Funkcje zmienne są aktualizowane po każdej zmianie i co minutę.
HOUR Funkcje zmienne są aktualizowane po każdej zmianie 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 obliczenia iteracyjne są włączone, jest to maksymalna liczba rund obliczeniowych do wykonania.
convergenceThreshold

number

Gdy obliczenia iteracyjne są włączone, a kolejne wyniki różnią się od siebie o wartość mniejszą niż ten próg, obliczenia są zaokrąglane.

SpreadsheetTheme

Reprezentuje motyw arkusza kalkulacyjnego.

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

string

Nazwa głównej rodziny czcionek.
themeColors[]

object (ThemeColorPair)

Pary kolorów motywu arkusza kalkulacyjnego. Aby zaktualizować motyw, musisz podać wszystkie pary kolorów motywu.

ThemeColorPair

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

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

enum (ThemeColorType)

Typ koloru motywu arkusza kalkulacyjnego.
color

object (ColorStyle)

Konkretny kolor odpowiadający typowi koloru motywu.

NamedRange

Zakres nazwany.

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

string

Identyfikator zakresu nazwanego.
name

string

Nazwa nazwanego zakresu.
range

object (GridRange)

Zakres, który reprezentuje.

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 w zakresie 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 Sheet połączonego ze źródłem danych. Po ustawieniu tego pola nie można go zmienić.

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

DataSourceSpec

Określa szczegóły źródła danych. W przypadku BigQuery określa na przykład informacje o źródle BigQuery.

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

  "bigQuery": {
    object (BigQueryDataSourceSpec)
  },
  "looker": {
    object (LookerDataSourceSpec)
  }
}
Pola
parameters[]

object (DataSourceParameter)

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

object (BigQueryDataSourceSpec)

A BigQueryDataSourceSpec
looker

object (LookerDataSourceSpec)

[LookerDatasourceSpec][].

BigQueryDataSourceSpec

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

Zapis JSON 
{
  "projectId": string,

  "querySpec": {
    object (BigQueryQuerySpec)
  },
  "tableSpec": {
    object (BigQueryTableSpec)
  }
}
Pola
projectId

string

Identyfikator projektu Google Cloud z włączoną usługą BigQuery i dołączonym kontem rozliczeniowym. Za każde zapytanie wykonane względem źródła danych projekt jest obciążany opłatą.
Pole zbiorcze spec. Rzeczywista specyfikacja. spec może mieć tylko jedną z tych wartości:
querySpec

object (BigQueryQuerySpec)

A BigQueryQuerySpec
tableSpec

object (BigQueryTableSpec)

A BigQueryTableSpec

BigQueryQuerySpec

Określa niestandardowe zapytanie BigQuery.

Zapis JSON 
{
  "rawQuery": string
}
Pola
rawQuery

string

Ciąg zapytania w formie nieprzetworzonej.

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 określisz tu żadnej wartości, 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 modelu Lookera.

DataSourceParameter

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

Zapis JSON 
{

  "name": string

  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
}
Pola
Pole zbiorcze identifier. Identyfikator parametru. identifier może mieć tylko jedną z tych wartości:
name

string

Nazwany parametr. Musi to być prawidłowy identyfikator DataSource, który go obsługuje. Na przykład identyfikator BigQuery.
Pole zbiorcze value. Wartość parametru. value może mieć tylko jedną z tych wartości:
namedRangeId

string

Identyfikator NamedRange. Musi mieć rozmiar 1x1.
range

object (GridRange)

Zakres zawierający wartość parametru. Musi mieć rozmiar 1x1.

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. Czas rozpoczęcia możesz określić, klikając przycisk Zaplanowane odświeżanie w edytorze Arkuszy, ale interwał jest stały i wynosi 4 godziny. Jeśli np. określisz godzinę rozpoczęcia 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)
  },

  "dailySchedule": {
    object (DataSourceRefreshDailySchedule)
  },
  "weeklySchedule": {
    object (DataSourceRefreshWeeklySchedule)
  },
  "monthlySchedule": {
    object (DataSourceRefreshMonthlySchedule)
  }
}
Pola
enabled

boolean

Wartość true, jeśli harmonogram odświeżania jest włączony. W przeciwnym razie wartość 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 zbiorcze schedule_config. Konfiguracje harmonogramu schedule_config mogą mieć tylko jedną z tych wartości:
dailySchedule

object (DataSourceRefreshDailySchedule)

Harmonogram odświeżania codziennego.
weeklySchedule

object (DataSourceRefreshWeeklySchedule)

Harmonogram odświeżania co tydzień.
monthlySchedule

object (DataSourceRefreshMonthlySchedule)

Harmonogram odświeżania co miesiąc.

DataSourceRefreshScope

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

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

DataSourceRefreshDailySchedule

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

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

object (TimeOfDay)

Czas rozpoczęcia przedziału czasu, w którym zaplanowano odświeżanie źródła danych. Używana jest tylko część hours. Rozmiar przedziału czasowego jest domyślnie taki sam jak w edytorze Arkuszy.

TimeOfDay

Reprezentuje porę dnia. Data i strefa czasowa nie mają znaczenia lub są określone w innym miejscu. Interfejs API może zezwalać 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 w formacie 24-godzinnym. Wartość musi być równa lub większa niż 0 i zwykle nie może być większa niż 23. Interfejs API może zezwalać na wartość „24:00:00” w przypadku takich scenariuszy jak godzina zamknięcia firmy.
minutes

integer

Minuty w godzinie. Wartość musi być równa lub większa niż 0 i równa lub mniejsza niż 59.
seconds

integer

Sekundy w minucie. Wartość musi być równa lub większa niż 0 i zwykle nie może być większa niż 59. Interfejs API może zezwalać na wartość 60, jeśli dopuszcza sekundy przestępne.
nanos

integer

Ułamki sekund w nanosekundach. Wartość musi być równa lub większa niż 0 i mniejsza lub równa 999 999 999.

DataSourceRefreshWeeklySchedule

Harmonogram tygodniowy 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 zaplanowano odświeżanie źródła danych. Używana jest tylko część hours. Rozmiar przedziału czasowego jest domyślnie taki sam jak w edytorze Arkuszy.
daysOfWeek[]

enum (DayOfWeek)

Dni tygodnia, w których należy odświeżyć dane. Musisz określić co najmniej 1 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

Harmonogram miesięczny 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 zaplanowano odświeżanie źródła danych. Używana jest tylko część hours. Rozmiar przedziału czasowego jest domyślnie taki sam jak w edytorze Arkuszy.
daysOfMonth[]

integer

Dni miesiąca, w których ma nastąpić odświeżenie. Obsługiwane są tylko wartości od 1 do 28, które odpowiadają dniom od 1 do 28. 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).

Wartość początkowa musi być mniejsza lub równa wartości końcowej. Gdy czas rozpoczęcia jest równy czasowi zakończenia, przedział czasu jest pusty (nie pasuje do żadnego czasu). Jeśli nie podasz ani początku, ani końca, przedział będzie pasować do dowolnego czasu.

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

string (Timestamp format)

Opcjonalne. Początek przedziału (włącznie).

Jeśli została określona, sygnatura czasowa pasująca do tego przedziału musi być taka sama jak data rozpoczęcia lub późniejsza.
endTime

string (Timestamp format)

Opcjonalnie. Koniec przedziału (wyłącznie).

Jeśli jest określona, sygnatura czasowa pasująca do tego przedziału musi być wcześniejsza niż czas zakończenia.

CommentThread

Reprezentuje pojedynczy wątek komentarzy w arkuszu kalkulacyjnym.

Zapis JSON 
{
  "commentId": string,
  "anchorId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),

  "plainTextQuote": string
}
Pola
commentId

string

Unikalny identyfikator wątku komentarzy.
anchorId

string

Identyfikator CommentAnchor w arkuszu, z którym powiązany jest ten wątek.
headPost

object (Post)

Pierwszy post w wątku.
replies[]

object (Post)

Odpowiedzi na posta głównego.
status

enum (Status)

Czy wątek jest otwarty czy rozwiązany.
Pole zbiorcze quote. Cytowany tekst z dokumentu w momencie utworzenia komentarza. quote może mieć tylko jedną z tych wartości:
plainTextQuote

string

Cytowany tekst z arkusza kalkulacyjnego w momencie utworzenia komentarza, sformatowany jako zwykły tekst.

Opublikuj

Reprezentuje pojedynczy post w wątku komentarzy.

Zapis JSON 
{
  "postId": string,
  "content": string,
  "contentHtml": string,
  "author": {
    object (PostAuthor)
  },
  "createTime": string,
  "updateTime": string,
  "deleted": boolean,
  "fromImportedSpreadsheet": boolean,
  "fromCopiedSpreadsheet": boolean,
  "assigneeEmail": string,
  "commentAction": enum (CommentActionType)
}
Pola
postId

string

Tylko dane wyjściowe. Unikalny identyfikator posta.
content

string

Treść posta.

Pole nie może być puste, jeśli commentAction nie ma wartości RESOLVE lub REOPEN.

Ten tekst będzie traktowany podobnie jak komentarze utworzone w edytorze Arkuszy. Będzie działać podobnie w przypadku formatowania, powiadomień itp.

Nie może przekraczać 2048 jednostek kodu UTF-8.
contentHtml

string

Tylko dane wyjściowe. Treść posta w formacie HTML.
author

object (PostAuthor)

Tylko dane wyjściowe. Użytkownik, który utworzył posta.
createTime

string (Timestamp format)

Tylko dane wyjściowe. Czas utworzenia posta.
updateTime

string (Timestamp format)

Tylko dane wyjściowe. Czas ostatniej aktualizacji posta.
deleted

boolean

Tylko dane wyjściowe. Określa, czy post został usunięty. Jeśli pola true, content i author będą puste.
fromImportedSpreadsheet

boolean

Tylko dane wyjściowe. Określa, czy post pochodzi z zaimportowanego arkusza kalkulacyjnego. Dzwoniący nie mogą bezpośrednio ustawiać tego pola.
fromCopiedSpreadsheet

boolean

Tylko dane wyjściowe. Określa, czy post pochodzi ze skopiowanego arkusza kalkulacyjnego. Dzwoniący nie mogą bezpośrednio ustawiać tego pola.
assigneeEmail

string

Opcjonalnie. Adres e-mail użytkownika, który jest nowo przypisywany do wątku w ramach tego posta.

Zwraca błąd 400 (Nieprawidłowe żądanie), jeśli:

  • Wątek nadrzędny to CommentThread, którego headPost nie ma przypisanego użytkownika.

  • Wartość commentAction jest określona jako RESOLVE lub REOPEN.

  • assigneeEmail przekracza 2048 jednostek kodu UTF-8.
commentAction

enum (CommentActionType)

Działanie podjęte w ramach tworzenia posta.

PostAuthor

Reprezentuje użytkownika, który jest autorem posta z komentarzem.

Zapis JSON 
{
  "displayName": string,
  "me": boolean,
  "anonymous": boolean,
  "user": string
}
Pola
displayName

string

Wyświetlana nazwa użytkownika. Może nie występować, jeśli autor jest anonimowy.
me

boolean

Określa, czy użytkownik jest uwierzytelnionym użytkownikiem wysyłającym żądanie.
anonymous

boolean

Informacja, czy użytkownik jest anonimowy.
user

string

Nazwa zasobu użytkownika będącego autorem posta, której można też używać do identyfikowania użytkownika w interfejsie Google People API. Format: users/{user}. Nie zostanie wypełnione, jeśli pole anonimowe ma wartość true lub jeśli post pochodzi z zaimportowanego arkusza kalkulacyjnego.

CommentActionType

Działanie podjęte w odpowiedzi na wątek komentarzy.

Wartości w polu enum
COMMENT_ACTION_TYPE_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
NO_COMMENT_ACTION_CHANGE W tym poście nie ma żadnych zmian dotyczących działania.
RESOLVE Ten post rozwiązuje wątek.
REOPEN Ten post ponownie otworzy wątek.

Stan

Opcje stanu wątku komentarzy.

Wartości w polu enum
STATUS_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
OPEN Wątek komentarzy jest otwarty.
RESOLVED Wątek komentarzy zostanie zakończony.

CommentsViewMode

Tryb wyświetlania komentarzy zastosowany w arkuszu kalkulacyjnym, który wskazuje, czy komentarze są uwzględnione. Umożliwia odczytanie arkusza kalkulacyjnego z komentarzami i kotwicami komentarzy lub bez nich.

Wartości w polu enum
COMMENTS_VIEW_MODE_UNSPECIFIED Tryb wyświetlania komentarzy nie jest określony. Zastosowano wartość COMMENTS_VIEW_MODE_OMITTED.
COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS Tryb CommentsViewMode zastosowany do zwróconego arkusza kalkulacyjnego zależy od bieżącego poziomu dostępu użytkownika. Jeśli użytkownik ma tylko uprawnienia do wyświetlania, stosowana jest wartość COMMENTS_VIEW_MODE_OMITTED. W przeciwnym razie zastosujemy ustawienie COMMENTS_VIEW_MODE_INCLUDED.
COMMENTS_VIEW_MODE_OMITTED W zwróconym arkuszu kalkulacyjnym brakuje komentarzy.
COMMENTS_VIEW_MODE_INCLUDED

Zwrócony arkusz kalkulacyjny zawiera komentarze.

Żądania pobrania arkusza kalkulacyjnego w tym trybie zwrócą błąd 403, jeśli użytkownik nie ma uprawnień do wyświetlania komentarzy.

Metody

batchUpdate

 Stosuje w arkuszu kalkulacyjnym co najmniej 1 aktualizację.

create

 Tworzy arkusz kalkulacyjny i zwraca nowo utworzony arkusz.

get

 Zwraca arkusz kalkulacyjny o podanym identyfikatorze.

getByDataFilter

 Zwraca arkusz kalkulacyjny o podanym identyfikatorze.