REST Resource: spreadsheets

Resource: Spreadsheet

Resource yang mewakili spreadsheet.

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

string

ID spreadsheet. Kolom ini bersifat hanya baca.
properties

object (SpreadsheetProperties)

Properti keseluruhan spreadsheet.
sheets[]

object (Sheet)

Sheet yang merupakan bagian dari {i>spreadsheet<i}.
namedRanges[]

object (NamedRange)

Rentang bernama yang ditetapkan dalam spreadsheet.
spreadsheetUrl

string

URL spreadsheet. Kolom ini bersifat hanya baca.
developerMetadata[]

object (DeveloperMetadata)

Metadata developer yang terkait dengan spreadsheet.
dataSources[]

object (DataSource)

Daftar sumber data eksternal yang terhubung dengan spreadsheet.
dataSourceSchedules[]

object (DataSourceRefreshSchedule)

Hanya output. Daftar jadwal muat ulang sumber data.

SpreadsheetProperties

Properti spreadsheet.

Representasi JSON 
{
  "title": string,
  "locale": string,
  "autoRecalc": enum (RecalculationInterval),
  "timeZone": string,
  "defaultFormat": {
    object (CellFormat)
  },
  "iterativeCalculationSettings": {
    object (IterativeCalculationSettings)
  },
  "spreadsheetTheme": {
    object (SpreadsheetTheme)
  },
  "importFunctionsExternalUrlAccessAllowed": boolean
}
Kolom
title

string

Judul spreadsheet.
locale

string

Lokalitas spreadsheet dalam salah satu format berikut:

  • kode bahasa ISO 639-1 seperti en

  • kode bahasa ISO 639-2 seperti fil, jika tidak ada kode 639-1

  • kombinasi kode bahasa dan kode negara ISO, seperti en_US

Catatan: saat memperbarui kolom ini, tidak semua lokal/bahasa didukung.
autoRecalc

enum (RecalculationInterval)

Jumlah waktu tunggu sebelum fungsi yang tidak stabil dihitung ulang.
timeZone

string

Zona waktu spreadsheet, dalam format CLDR seperti America/New_York. Jika zona waktu tidak dikenali, zona waktu tersebut mungkin adalah zona waktu kustom seperti GMT-07:00.
defaultFormat

object (CellFormat)

Format default semua sel dalam spreadsheet. CellData.effectiveFormat tidak akan ditetapkan jika format sel sama dengan format default ini. Kolom ini bersifat hanya baca.
iterativeCalculationSettings

object (IterativeCalculationSettings)

Menentukan apakah dan bagaimana referensi melingkar diselesaikan dengan penghitungan berulang. Tidak adanya kolom ini berarti referensi melingkar menyebabkan error penghitungan.
spreadsheetTheme

object (SpreadsheetTheme)

Tema diterapkan ke spreadsheet.
importFunctionsExternalUrlAccessAllowed

boolean

Apakah akan mengizinkan akses URL eksternal untuk fungsi gambar dan impor. Hanya baca jika benar. Jika salah, Anda dapat menetapkan ke benar. Nilai ini akan diabaikan dan selalu menampilkan true jika admin telah mengaktifkan fitur daftar yang diizinkan.

RecalculationInterval

Enumerasi kemungkinan opsi interval penghitungan ulang.

Enum
RECALCULATION_INTERVAL_UNSPECIFIED Nilai default. Nilai ini tidak boleh digunakan.
ON_CHANGE Fungsi yang tidak stabil diperbarui di setiap perubahan.
MINUTE Fungsi yang tidak stabil diperbarui pada setiap perubahan dan setiap menit.
HOUR Fungsi yang tidak stabil diperbarui pada setiap perubahan dan per jam.

IterativeCalculationSettings

Setelan untuk mengontrol cara dependensi sirkular diselesaikan dengan penghitungan berulang.

Representasi JSON 
{
  "maxIterations": integer,
  "convergenceThreshold": number
}
Kolom
maxIterations

integer

Jika penghitungan berulang diaktifkan, jumlah maksimum penghitungan akan dibulatkan.
convergenceThreshold

number

Jika penghitungan berulang diaktifkan dan hasil berturut-turut berbeda dengan kurang dari nilai minimum ini, pembulatan penghitungan akan berhenti.

SpreadsheetTheme

Mewakili tema spreadsheet

Representasi JSON 
{
  "primaryFontFamily": string,
  "themeColors": [
    {
      object (ThemeColorPair)
    }
  ]
}
Kolom
primaryFontFamily

string

Nama jenis font utama.
themeColors[]

object (ThemeColorPair)

Pasangan warna tema spreadsheet. Untuk memperbarui, Anda harus menyediakan semua pasangan warna tema.

ThemeColorPair

Pasangan yang memetakan jenis warna tema spreadsheet ke warna konkret yang diwakilinya.

Representasi JSON 
{
  "colorType": enum (ThemeColorType),
  "color": {
    object (ColorStyle)
  }
}
Kolom
colorType

enum (ThemeColorType)

Jenis warna tema spreadsheet.
color

object (ColorStyle)

Warna konkret yang sesuai dengan jenis warna tema.

NamedRange

Rentang bernama.

Representasi JSON 
{
  "namedRangeId": string,
  "name": string,
  "range": {
    object (GridRange)
  }
}
Kolom
namedRangeId

string

ID rentang bernama.
name

string

Nama rentang bernama.
range

object (GridRange)

Rentang yang diwakili oleh nilai ini.

DataSource

Informasi tentang sumber data eksternal di spreadsheet.

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

string

ID unik cakupan spreadsheet yang mengidentifikasi sumber data. Contoh: 1080547365.
spec

object (DataSourceSpec)

DataSourceSpec untuk sumber data yang terhubung dengan spreadsheet ini.
calculatedColumns[]

object (DataSourceColumn)

Semua kolom kalkulasi di sumber data.
sheetId

integer

ID Sheet yang terhubung dengan sumber data. Kolom tidak dapat diubah setelah ditetapkan.

Saat membuat sumber data, sheet DATA_SOURCE terkait juga akan dibuat. Jika kolom tidak ditentukan, ID sheet yang dibuat akan dibuat secara acak.

DataSourceSpec

Kolom ini menentukan detail sumber data. Misalnya, untuk BigQuery, ini menentukan informasi tentang sumber BigQuery.

Representasi 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.
}
Kolom
parameters[]

object (DataSourceParameter)

Parameter sumber data, yang digunakan saat membuat kueri sumber data.
Kolom union spec. Spesifikasi sebenarnya per jenis sumber data. spec hanya dapat berupa salah satu dari berikut:
bigQuery

object (BigQueryDataSourceSpec)

BigQueryDataSourceSpec.
looker

object (LookerDataSourceSpec)

Sebuah [LookerDatasourceSpec][].

BigQueryDataSourceSpec

Spesifikasi sumber data BigQuery yang terhubung ke sheet.

Representasi 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.
}
Kolom
projectId

string

ID project Google Cloud yang diaktifkan untuk BigQuery dengan akun penagihan terlampir. Project akan dikenai biaya untuk setiap kueri yang dijalankan terhadap sumber data.
Kolom union spec. Spesifikasi sebenarnya. spec hanya dapat berupa salah satu dari berikut:
querySpec

object (BigQueryQuerySpec)

BigQueryQuerySpec.
tableSpec

object (BigQueryTableSpec)

BigQueryTableSpec.

BigQueryQuerySpec

Menentukan kueri BigQuery kustom.

Representasi JSON 
{
  "rawQuery": string
}
Kolom
rawQuery

string

String kueri mentah.

BigQueryTableSpec

Menentukan definisi tabel BigQuery. Hanya tabel native yang diizinkan.

Representasi JSON 
{
  "tableProjectId": string,
  "tableId": string,
  "datasetId": string
}
Kolom
tableProjectId

string

ID project BigQuery yang memiliki tabel tersebut. Jika tidak ditentukan, projectId akan diasumsikan.
tableId

string

ID tabel BigQuery.
datasetId

string

ID set data BigQuery.

LookerDataSourceSpec

Spesifikasi sumber data Looker.

Representasi JSON 
{
  "instanceUri": string,
  "model": string,
  "explore": string
}
Kolom
instanceUri

string

URL instance Looker.
model

string

Nama model Looker.
explore

string

Nama eksplorasi model Looker.

DataSourceParameter

Parameter dalam kueri sumber data. Parameter ini memungkinkan pengguna meneruskan nilai dari spreadsheet ke kueri.

Representasi 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.
}
Kolom
Kolom union identifier. ID parameter. identifier hanya dapat berupa salah satu dari berikut:
name

string

Parameter bernama. Harus berupa ID yang sah untuk DataSource yang mendukungnya. Misalnya, ID BigQuery.
Kolom union value. Nilai parameter. value hanya dapat berupa salah satu dari berikut:
namedRangeId

string

ID NamedRange. Ukurannya harus 1x1.
range

object (GridRange)

Rentang yang berisi nilai parameter. Ukurannya harus 1x1.

DataSourceRefreshSchedule

Jadwalkan untuk memuat ulang sumber data.

Sumber data dalam spreadsheet diperbarui dalam interval waktu. Anda dapat menentukan waktu mulai dengan mengklik tombol Muat Ulang Terjadwal di editor Spreadsheet, tetapi intervalnya ditetapkan menjadi 4 jam. Misalnya, jika Anda menentukan waktu mulai pukul 08.00 , pembaruan akan berlangsung antara pukul 08.00 dan 12.00 setiap hari.

Representasi 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.
}
Kolom
enabled

boolean

True jika jadwal muat ulang diaktifkan, atau false jika tidak.
refreshScope

enum (DataSourceRefreshScope)

Cakupan pemuatan ulang. Harus berupa ALL_DATA_SOURCES.
nextRun

object (Interval)

Hanya output. Interval waktu proses berikutnya.
Kolom union schedule_config. Konfigurasi jadwal schedule_config hanya dapat berupa salah satu dari yang berikut:
dailySchedule

object (DataSourceRefreshDailySchedule)

Jadwal pembaruan harian.
weeklySchedule

object (DataSourceRefreshWeeklySchedule)

Jadwal pembaruan mingguan.
monthlySchedule

object (DataSourceRefreshMonthlySchedule)

Jadwal pembaruan bulanan.

DataSourceRefreshScope

Cakupan pembaruan sumber data.

Enum
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED Nilai default, jangan digunakan.
ALL_DATA_SOURCES Memuat ulang semua sumber data dan objek sumber datanya yang terkait di spreadsheet.

DataSourceRefreshDailySchedule

Jadwal pembaruan data setiap hari dalam interval waktu tertentu.

Representasi JSON 
{
  "startTime": {
    object (TimeOfDay)
  }
}
Kolom
startTime

object (TimeOfDay)

Waktu mulai interval waktu saat pembaruan sumber data dijadwalkan. Hanya bagian hours yang digunakan. Ukuran interval waktu ditetapkan secara default di editor Spreadsheet.

TimeOfDay

Merepresentasikan waktu. Tanggal dan zona waktu tidak signifikan atau ditentukan di tempat lain. API dapat memilih untuk mengizinkan detik kabisat. Jenis terkait adalah google.type.Date dan google.protobuf.Timestamp.

Representasi JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Kolom
hours

integer

Jam dalam format 24 jam. Harus dari 0 hingga 23. API dapat memilih untuk mengizinkan nilai "24:00:00" untuk skenario seperti waktu tutup bisnis.
minutes

integer

Menit dalam jam. Harus antara 0 hingga 59.
seconds

integer

Detik menit dari waktu. Biasanya harus dari 0 hingga 59. API dapat mengizinkan nilai 60 jika memungkinkan detik kabisat.
nanos

integer

Pecahan detik dalam nanodetik. Harus dari 0 hingga 999.999.999.

DataSourceRefreshWeeklySchedule

Jadwal mingguan untuk data yang diperbarui pada hari tertentu dalam interval waktu tertentu.

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

object (TimeOfDay)

Waktu mulai interval waktu saat pembaruan sumber data dijadwalkan. Hanya hours bagian yang digunakan. Ukuran interval waktu ditetapkan secara default ke ukuran yang ada di editor Spreadsheet.
daysOfWeek[]

enum (DayOfWeek)

Hari pembaruan. Setidaknya satu hari harus ditentukan.

DayOfWeek

Mewakili hari dalam seminggu.

Enum
DAY_OF_WEEK_UNSPECIFIED Hari dalam seminggu tidak ditentukan.
MONDAY Senin
TUESDAY Selasa
WEDNESDAY Rabu
THURSDAY Kamis
FRIDAY Jumat
SATURDAY Sabtu
SUNDAY Minggu

DataSourceRefreshMonthlySchedule

Jadwal bulanan yang diperbarui untuk data pada hari tertentu dalam sebulan dalam interval waktu tertentu.

Representasi JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfMonth": [
    integer
  ]
}
Kolom
startTime

object (TimeOfDay)

Waktu mulai interval waktu saat pembaruan sumber data dijadwalkan. Hanya hours bagian yang digunakan. Ukuran interval waktu ditetapkan secara default ke ukuran yang ada di editor Spreadsheet.
daysOfMonth[]

integer

Hari dalam bulan yang akan diperbarui. Hanya 1-28 yang didukung, pemetaan untuk tanggal 1 hingga 28. Setidaknya satu hari harus ditentukan.

Interval

Mewakili interval waktu, yang dienkode sebagai Awal stempel waktu (inklusif) dan akhir Stempel waktu (eksklusif).

Awalnya harus lebih kecil dari atau sama dengan akhir. Jika awal sama dengan akhir, intervalnya kosong (tidak cocok dengan waktu). Jika awal dan akhir tidak ditentukan, interval akan cocok dengan waktu apa pun.

Representasi JSON 
{
  "startTime": string,
  "endTime": string
}
Kolom
startTime

string (Timestamp format)

Opsional. Awal interval inklusif.

Jika ditentukan, Stempel Waktu yang cocok dengan interval ini harus sama dengan atau setelah awal.
endTime

string (Timestamp format)

Opsional. Akhir interval eksklusif.

Jika ditentukan, Stempel waktu yang cocok dengan interval ini harus sebelum akhir.

Metode

batchUpdate

 Menerapkan satu atau beberapa update pada spreadsheet.

create

 Membuat spreadsheet, yang menampilkan spreadsheet yang baru dibuat.

get

 Menampilkan spreadsheet pada ID yang diberikan.

getByDataFilter

 Menampilkan spreadsheet dengan ID yang diberikan.